Type Members

1.  type ActionRestActionCategory = ActionRestActionCategory.type

   Allows arbitrary context-specific actions.

2.  type AuthGenerator[BodyType, AuthType] = (BodyType) ⇒ HeaderAccessControl[AuthType]
3.  sealed trait BasicRestActionCategory extends RestActionCategory

   Marker type for the framework-defined APIs.

4.  type CreateRestActionCategory = CreateRestActionCategory.type
5.  class DefinedBodyTypeRestActionBuilder[RACType, AuthType, BodyType, ResourceKeyType, ResourceType, ResponseType] extends RestActionBuilderTerminators[RACType, AuthType, BodyType, ResourceKeyType, ResourceType, ResponseType]

   See RestActionBuilder.

   See RestActionBuilder.

   This builder can hold body-dependent authorization definitions. In order to do this, the builder must forbid changes to body type, and does so by omitting body-related builder methods.

6.  type DeleteRestActionCategory = DeleteRestActionCategory.type
7.  type FinderRestActionCategory = FinderRestActionCategory.type

   Allows search and other finder-type methods.

8.  type GetAllRestActionCategory = GetAllRestActionCategory.type
9.  type GetRestActionCategory = GetRestActionCategory.type
10.  type MultiGetRestActionCategory = MultiGetRestActionCategory.type
11.  trait NaptimeActionSerializer[T] extends AnyRef

    Actions have far fewer restrictions on the response type than other actions.

    Actions have far fewer restrictions on the response type than other actions. We thus define a looser serializer API (as compared to NaptimeSerializer.

12.  trait NaptimeSerializer[T] extends AnyRef

    Abstracts over the Play-JSON API and the Courier underlying record template support for serialization, allowing us to convert Play-JSON into Pegasus DataMaps.

13.  type PatchRestActionCategory = PatchRestActionCategory.type
14.  trait PlayJsonRestActionCategoryEngine extends AnyRef

    Define the mappings between category engines.

    Define the mappings between category engines.

    TODO: consider moving these to be defined in the same trait that defines the resource. (e.g. the org.coursera.naptime.resources.CollectionResource.) By moving the engines to the trait, this would allow for different resources to have different engines available. That said, this must all be sealed to disallow further 'customization'.

15.  trait RestAction[RACType, AuthType, BodyType, KeyType, ResourceType, ResponseType] extends RouteAction with StrictLogging

    A RestAction is a layer on top of Play! with additional type information

    A RestAction is a layer on top of Play! with additional type information

    This type information is used to help enforce conventions, DRY things out, and support some additional features.

    Type parameters: RACType - The rest action type. This is typically a subclass of RestActionCategory AuthType - The authentication return type. BodyType - The HTTP request body is parsed to this type for use in the handler. KeyType - The key type of the model being processed. ResourceType - This is the resource type this action is supposed to handle. ResponseType - This is the response type this action is supposed to return (e.g. Seq of ResourceType)

    TODO(saeta): Enforce RACType extends from RestActionCategory.

16.  class RestActionBodyBuilder[RACType, AuthType, BodyType, ResourceKeyType, ResourceType, ResponseType] extends AnyRef

    Helper class to control the creation of the rest action using either an asynchronous or a synchronous function.

    Helper class to control the creation of the rest action using either an asynchronous or a synchronous function. Use either the apply function or the async function to create a RestAction which can then handle requests.

17.  class RestActionBuilder[RACType, AuthType, BodyType, ResourceKeyType, ResourceType, ResponseType] extends RestActionBuilderTerminators[RACType, AuthType, BodyType, ResourceKeyType, ResourceType, ResponseType]

    A builder that helps build Rest Actions.

18.  sealed trait RestActionCategory extends AnyRef

    Defines the allowed types of API endpoints.

    Defines the allowed types of API endpoints.

    This should not be extended outside the framework, and is thus sealed.

19.  trait RestActionCategoryEngine[Category, Key, Resource, Response] extends AnyRef

    Maps a high-level REST response to a low-level HTTP response.

    Maps a high-level REST response to a low-level HTTP response.

    Annotations

    @implicitNotFound( ... )

20.  trait RestActionCategoryEngine2[Category, Key, Resource, Response] extends RestActionCategoryEngine[Category, Key, Resource, Response]
21.  trait RestActionCategoryEngine2Impls extends AnyRef

    2nd generation engines with Pegasus DataMaps at the core.

    2nd generation engines with Pegasus DataMaps at the core. To use, import them at the top of your file.

22.  type UpdateRestActionCategory = UpdateRestActionCategory.type