Packages

package root

Definition Classes: root

package org

Definition Classes: root

package coursera

Definition Classes: org

package naptime

Definition Classes: coursera

package access

Definition Classes: naptime

package actions

Definition Classes: naptime

package ari

This ari defines the key abstractions for automatic resource inclusion as well as GraphQL.

The system is split up into 3 distinct layers:

+---------------------------------------------------------------------+
|                       Presentation Layer                            |
|           GraphQL            |            Naptime HTTP              |
+------------------------------+--------------------------------------+
|                                                                     |
|                      Inclusion Engine                               |
|                                                                     |
+---------------------------------------------------------------------+
|                        Data fetching                                |
|         Local execution      |           remote execution           |
+=====================================================================+
|                                                                     |
|                   Unmodified Naptime APIs                           |
|                                                                     |
+---------------------------------------------------------------------+

A request enters the system via the presentation layer (typically parsed from the network). The presentation layer constructs a org.coursera.naptime.ari.Request and passes that to engine. The engine performs a number of validations against the schema, and then makes a number of requests to to the Data Fetching layer to assemble all of the (available) data required to construct a response. This is passed back to the presentation layer, which constructs a response to be sent out on the wire.

The API between the presentation layer and the inclusion engine is the org.coursera.naptime.ari.EngineApi

The API between the inclusion engine and the data fetching layer is defined by org.coursera.naptime.ari.FetcherApi.

BEWARE: This code is currently in a high state of flux. Do not depend upon it unless you are prepared for breakages!

Definition Classes: naptime

package exceptions

Definition Classes: naptime

package path

Definition Classes: naptime

package resources

Definition Classes: naptime

package router2

Definition Classes: naptime

package schema

Definition Classes: naptime

DangerousAccessToUnderlyingRequest

ETag

Errors

FacetField

FacetFieldValue

FieldsFunction

FinderGraphQLRelation

GetGraphQLRelation

GraphQLRelation

MultiGetGraphQLRelation

NaptimeActionException

NaptimeModule

PaginationConfiguration

Redirect

RequestEvidence

RequestFields

RequestIncludes

RequestPagination

ResourceFields

ResourceName

ResponsePagination

RestContext

RestError

RestResponse

SchemaUtils

SingleElementFinderGraphQLRelation

Types

org.coursera.naptime

ResourceName

Companion object ResourceName

case class ResourceName(topLevelName: String, version: Int, resourcePath: Seq[String] = List.empty) extends Product with Serializable

The structured name + version + path of a resource.

topLevelName: The first top level name.
version: The version of the top level resource.
resourcePath: The names of path selectors.

Linear Supertypes

Serializable, Serializable, Product, Equals, AnyRef, Any

Ordering

Alphabetic
By Inheritance

Inherited

ResourceName
Serializable
Serializable
Product
Equals
AnyRef
Any

Hide All
Show All

Visibility

Public
All

Instance Constructors

new ResourceName(topLevelName: String, version: Int, resourcePath: Seq[String] = List.empty)
topLevelName
The first top level name.
version
The version of the top level resource.
resourcePath
The names of path selectors.

Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@native() @throws( ... )
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
Annotations
@native()
def identifier: String
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
Annotations
@native()
final def notifyAll(): Unit

Definition Classes
AnyRef
Annotations
@native()
val resourcePath: Seq[String]
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
val topLevelName: String
val version: Int
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@native() @throws( ... )

Packages

ResourceName

Companion object ResourceName

case class ResourceName(topLevelName: String, version: Int, resourcePath: Seq[String] = List.empty) extends Product with Serializable

Instance Constructors

Value Members

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped

Packages

ResourceName 

Companion object ResourceName

case class ResourceName(topLevelName: String, version: Int, resourcePath: Seq[String] = List.empty) extends Product with Serializable

Instance Constructors

Value Members

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped

ResourceName