org.coursera.naptime

actions

package actions

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. actions
  2. AnyRef
  3. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Type Members

  1. type ActionRestActionCategory = ActionRestActionCategory.type

    Allows arbitrary context-specific actions.

  2. sealed trait BasicRestActionCategory extends RestActionCategory

    Marker type for the framework-defined APIs.

  3. type CreateRestActionCategory = CreateRestActionCategory.type

  4. type DeleteRestActionCategory = DeleteRestActionCategory.type

  5. type FinderRestActionCategory = FinderRestActionCategory.type

    Allows search and other finder-type methods.

  6. type GetAllRestActionCategory = GetAllRestActionCategory.type

  7. type GetRestActionCategory = GetRestActionCategory.type

  8. type MultiGetRestActionCategory = MultiGetRestActionCategory.type

  9. 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.

  10. type PatchRestActionCategory = PatchRestActionCategory.type

  11. trait RestAction[RACType, AuthType, BodyType, KeyType, ResourceType, ResponseType] extends EssentialAction with RequestTaggingHandler

    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.

  12. 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.

  13. class RestActionBuilder[RACType, AuthType, BodyType, ResourceKeyType, ResourceType, ResponseType] extends AnyRef

    A builder that helps build Rest Actions.

  14. 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.

  15. 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( ... )

  16. type UpdateRestActionCategory = UpdateRestActionCategory.type

Value Members

  1. object ActionRestActionCategory extends RestActionCategory with Product with Serializable

  2. object CreateRestActionCategory extends BasicRestActionCategory with Product with Serializable

  3. object DeleteRestActionCategory extends BasicRestActionCategory with Product with Serializable

  4. object FinderRestActionCategory extends RestActionCategory with Product with Serializable

  5. object GetAllRestActionCategory extends BasicRestActionCategory with Product with Serializable

  6. object GetRestActionCategory extends BasicRestActionCategory with Product with Serializable

  7. object MultiGetRestActionCategory extends BasicRestActionCategory with Product with Serializable

  8. object NaptimeSerializer

  9. object PatchRestActionCategory extends BasicRestActionCategory with Product with Serializable

  10. object RestActionCategoryEngine

    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'.

  11. object RestActionCategoryEngine2

    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.

  12. object UpdateRestActionCategory extends BasicRestActionCategory with Product with Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped