< Back

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.
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
Ok
PaginationConfiguration
Redirect
RequestEvidence
RequestFields
RequestIncludes
RequestPagination
ResourceFields
ResourceName
ResponsePagination
RestContext
RestError
RestResponse
SchemaUtils
SingleElementFinderGraphQLRelation
Types

org.coursera.naptime

Errors

Companion trait Errors

object Errors extends Errors

Linear Supertypes

Errors, AnyRef, Any

Ordering

Alphabetic
By Inheritance

Inherited

Errors
Errors
AnyRef
Any

Hide All
Show All

Visibility

Public
All

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
def BadGateway(errorCode: String = null, msg: String = null, details: Option[JsValue] = None, cause: Option[Throwable] = None): NaptimeActionException
Error out with a bad gateway error (502) response.
Error out with a bad gateway error (502) response.
Note: Only use this within a Rest Action, and not a general action.

Definition Classes
Errors
def BadRequest(errorCode: String = null, msg: String = null, details: Option[JsValue] = None, cause: Option[Throwable] = None): NaptimeActionException
Error out with a BadRequest (400) response.
Error out with a BadRequest (400) response.
Note: Only use this within a Rest Action, and not a general action.

Definition Classes
Errors
def BadRequestT[T](errorCode: String = null, msg: String = null, details: Option[T] = None, cause: Option[Throwable] = None)(implicit format: OFormat[T]): NaptimeActionException
Error out with a BadRequest (400) response.
Error out with a BadRequest (400) response. Detail will be converted to a json object.
Note: Only use this within a Rest Action, and not a general action.

Definition Classes
Errors
def Conflict(errorCode: String = null, msg: String = null, details: Option[JsValue] = None, cause: Option[Throwable] = None): NaptimeActionException
Error out with a conflict (409) response.
Error out with a conflict (409) response.
Note: Only use this within a Rest Action, and not a general action.

Definition Classes
Errors
def Forbidden(errorCode: String = null, msg: String = null, details: Option[JsValue] = None, cause: Option[Throwable] = None): NaptimeActionException
Error out with an Forbidden (403) response.
Error out with an Forbidden (403) response.
Note: Only use this within a Rest Action, and not a general action.

Definition Classes
Errors
def GatewayTimeout(errorCode: String = null, msg: String = null, details: Option[JsValue] = None, cause: Option[Throwable] = None): NaptimeActionException
Error out with a gateway timeout (504) response.
Error out with a gateway timeout (504) response.
Note: Only use this within a Rest Action, and not a general action.

Definition Classes
Errors
def Gone(errorCode: String = null, msg: String = null, details: Option[JsValue] = None, cause: Option[Throwable] = None): NaptimeActionException
Error out with an Gone (410) response.
Error out with an Gone (410) response.
Note: Only use this within a Rest Action, and not a general action.

Definition Classes
Errors
def InternalServerError(errorCode: String = null, msg: String = null, details: Option[JsValue] = None, cause: Option[Throwable] = None): NaptimeActionException
Error out with an internal server error (500) response.
Error out with an internal server error (500) response.
Note: Only use this within a Rest Action, and not a general action.

Definition Classes
Errors
def NotFound[MissingType](id: Int)(implicit typeTag: scala.reflect.api.JavaUniverse.TypeTag[MissingType]): NaptimeActionException

Definition Classes
Errors
def NotFound(errorCode: String = null, msg: String = null, details: Option[JsValue] = None, cause: Option[Throwable] = None): NaptimeActionException
Error out with an Not Found (404) response.
Error out with an Not Found (404) response.
Note: Only use this within a Rest Action, and not a general action.

Definition Classes
Errors
def NotFoundT[T](errorCode: String = null, msg: String = null, details: Option[T] = None, cause: Option[Throwable] = None)(implicit format: OFormat[T]): NaptimeActionException
Error out with an Not Found (404) response.
Error out with an Not Found (404) response. Detail will be converted to a json object.
Note: Only use this within a Rest Action, and not a general action.

Definition Classes
Errors
def PreconditionFailed(errorCode: String = null, msg: String = null, details: Option[JsValue] = None, cause: Option[Throwable] = None): NaptimeActionException
Error out with a precondition failed (412) response.
Error out with a precondition failed (412) response.
Note: Only use this within a Rest Action, and not a general action.

Definition Classes
Errors
def ServiceUnavailable(errorCode: String = null, msg: String = null, details: Option[JsValue] = None, cause: Option[Throwable] = None): NaptimeActionException
Error out with a service unavailable (503) response.
Error out with a service unavailable (503) response.
Note: Only use this within a Rest Action, and not a general action.

Definition Classes
Errors
def Unauthorized(errorCode: String = null, msg: String = null, details: Option[JsValue] = None, cause: Option[Throwable] = None): NaptimeActionException
Error out with an Unauthorized (401) response.
Error out with an Unauthorized (401) response.
Note: Only use this within a Rest Action, and not a general action.

Definition Classes
Errors
def UnauthorizedT[T](errorCode: String = null, msg: String = null, details: Option[T] = None, cause: Option[Throwable] = None)(implicit format: OFormat[T]): NaptimeActionException
Error out with an Unauthorized (401) response.
Error out with an Unauthorized (401) response. Detail will be converted to a json object.
Note: Only use this within a Rest Action, and not a general action.

Definition Classes
Errors
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 equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def error(httpCode: Int, errorCode: String = null, msg: String = null, details: Option[JsValue] = None, cause: Option[Throwable] = None): NaptimeActionException
Generate your own HTTP 4XX or 5XX response, specifying your own HTTP code.
Generate your own HTTP 4XX or 5XX response, specifying your own HTTP code.

Definition Classes
Errors
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 hashCode(): Int

Definition Classes
AnyRef → Any
Annotations
@native()
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()
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
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( ... )

Inherited from Errors

Inherited from AnyRef

Inherited from Any

Ungrouped