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 authenticator
  • package authorizer
  • package combiner
  • HeaderAccessControl
  • StructuredAccessControl
  • 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

package access

Ordering
  1. Alphabetic
Visibility
  1. Public
  2. All

Type Members

  1. trait HeaderAccessControl[A] extends AnyRef

    Control access to an API based on the RequestHeader.

    Control access to an API based on the RequestHeader.

    See StructuredAccessControl for a way to implement access control based on separated authentication and authorization.

    Note that access control based on the request body is not supported right now. Consider construction your HeaderAccessControl (using body parameters as necessary) and invoking runAndCheck in your API body.

  2. case class StructuredAccessControl[A](authenticator: Authenticator[A], authorizer: Authorizer[A]) extends HeaderAccessControl[A] with Product with Serializable

    Implementation of HeaderAccessControl with more structure, separating the authentication and authorization phases of access control to promote reusability.

Value Members

  1. object HeaderAccessControl extends AnyOf with And with EitherOf with SuccessfulOf
  2. object StructuredAccessControl extends Serializable

Ungrouped