org.mashupbots.socko.rest

RestRegistration

abstract class RestRegistration extends AnyRef

Binds a org.mashupbots.socko.rest.RestRequest, org.mashupbots.socko.rest.RestResponse and a processor actor to an end point.

This is implemented as an abstract class rather than a trait so that it is easier to override methods and values.

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

Instance Constructors

  1. new RestRegistration()

Abstract Value Members

  1. abstract def method: Method.Value

    HTTP method associated with this operation

  2. abstract def path: String

    Path template of this operation.

    Path template of this operation.

    Path is relative to the root path specified for the REST handler. For example, if the REST handler path is /api and this path is /my_operation, then the full path to this operation is /api/my_operation.

    The path may contain segments that are variable. For example, in /pet/{id}, id is a variable and can be bound to a parameter in the org.mashupbots.socko.rest.RestRequest.

  3. abstract def processorActor(actorSystem: ActorSystem, request: RestRequest): ActorRef

    Locates the actor that will process a request and returns a response.

    Locates the actor that will process a request and returns a response.

    actorSystem

    Actor system in which new actors maybe created

    request

    Rest Request to process

    returns

    ActorRef of actor to which request will be sent for processing

  4. abstract def requestParams: Seq[RequestParam]

    Request parameter bindings.

    Request parameter bindings.

    You can specify org.mashupbots.socko.rest.PathParam, org.mashupbots.socko.rest.QueryParam, org.mashupbots.socko.rest.HeaderParam and/or org.mashupbots.socko.rest.BodyParam.

Concrete Value Members

  1. final def !=(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any

  3. final def ##(): Int

    Definition Classes
    AnyRef → Any

  4. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  5. final def ==(arg0: Any): Boolean

    Definition Classes
    Any

  6. final def asInstanceOf[T0]: T0

    Definition Classes
    Any

  7. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  8. val customDeserialization: Boolean

    Flag to denote if the org.mashupbots.socko.events.SockoEvent is to be made accessible from org.mashupbots.socko.rest.RestRequestEvents so that the REST processing actor can access the raw request data for custom deserialization.

    Flag to denote if the org.mashupbots.socko.events.SockoEvent is to be made accessible from org.mashupbots.socko.rest.RestRequestEvents so that the REST processing actor can access the raw request data for custom deserialization.

    Defaults to false.

  9. val customSerialization: Boolean

    Flag to denote if the org.mashupbots.socko.events.SockoEvent is to be made accessible from org.mashupbots.socko.rest.RestRequestEvents so that the REST processing actor can write data directory to the client.

    Flag to denote if the org.mashupbots.socko.events.SockoEvent is to be made accessible from org.mashupbots.socko.rest.RestRequestEvents so that the REST processing actor can write data directory to the client. Defaults to false.

  10. val deprecated: Boolean

    Flag to denote if this operation is deprecated.

    Flag to denote if this operation is deprecated.

    Programmers are discouraged from using this operation because it is dangerous, or because a better alternative exists. The default is false.

  11. val description: String

    Short description.

    Short description. Less than 60 characters is recommended.

    Default is blank.

  12. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  13. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any

  14. val errors: Seq[Error]

    Details of possible errors

  15. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  16. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any

  17. def hashCode(): Int

    Definition Classes
    AnyRef → Any

  18. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

  19. val name: String

    Name of this operation.

    Name of this operation.

    If empty, the default is the name of the declaration class without Declaration. For example, the default name for UpdatePetDeclaration is UpdatePet.

  20. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  21. val notes: String

    Long description.

    Long description.

    Default is blank.

  22. final def notify(): Unit

    Definition Classes
    AnyRef

  23. final def notifyAll(): Unit

    Definition Classes
    AnyRef

  24. val request: Option[scala.reflect.api.JavaUniverse.Type]

    The type of the org.mashupbots.socko.rest.RestRequest.

    The type of the org.mashupbots.socko.rest.RestRequest.

    If None, the default is the same name as the declaration class with Declaration replaced with Request. For example, the default for GetPetDeclaration is GetPetRequest.

  25. val response: Option[scala.reflect.api.JavaUniverse.Type]

    The type of the org.mashupbots.socko.rest.RestResponse.

    The type of the org.mashupbots.socko.rest.RestResponse.

    If None, the default is the same name as the declaration class with Declaration replaced with Response. For example, the default for GetPetDeclaration is GetPetResponse.

  26. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef

  27. def toString(): String

    Definition Classes
    AnyRef → Any

  28. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  29. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  30. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped