org.mashupbots.socko.rest

RestRegistry

object RestRegistry extends Logger with Serializable

Factory to instance a registry

Linear Supertypes
Serializable, Serializable, Logger, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. RestRegistry
  2. Serializable
  3. Serializable
  4. Logger
  5. AnyRef
  6. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Value Members

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

    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any
  4. def apply(classLoader: ClassLoader, pkg: Seq[String], config: RestConfig): RestRegistry

    Instance a new registry using the classes under the specified package names and discoverable by the specified class loader

    Instance a new registry using the classes under the specified package names and discoverable by the specified class loader

    classLoader

    Class loader use to discover the classes in the specified package

    pkg

    List of package names under which your annotated REST request and response classes are defined

  5. def apply(classLoader: ClassLoader, pkg: String, config: RestConfig): RestRegistry

    Instance a new registry using the classes under the specified package name and discoverable by the specified class loader

    Instance a new registry using the classes under the specified package name and discoverable by the specified class loader

    classLoader

    Class loader use to discover the classes in the specified package

    pkg

    Name of package where your annotated REST request and response classes are defined

  6. def apply(pkg: String, config: RestConfig): RestRegistry

    Instance registry using the classes under the specified package name and the class loader of this class

    Instance registry using the classes under the specified package name and the class loader of this class

    pkg

    Name of package where your annotated REST request and response classes are defined

  7. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  8. def buildRestOperation(rm: Mirror, clz: Class[_], classes: Seq[Class[_]], config: RestConfig): Option[RestOperation]

    Builds a org.mashupbots.socko.rest.RestOperation for a specific class clz.

    Builds a org.mashupbots.socko.rest.RestOperation for a specific class clz.

    If clz is a child of org.mashupbots.socko.rest.RestRegistration, and it has a corresponding org.mashupbots.socko.rest.RestRequest and org.mashupbots.socko.rest.RestResponse, then a org.mashupbots.socko.rest.RestOperation is instanced and returned.

    If not, then None is returned.

    rm

    Runtime mirror

    clz

    class to check

    classes

    Collection of classes found in the package to load

    config

    REST configuration

    returns

    An instance of the annotation class or None if annotation not found

  9. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  10. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  11. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any
  12. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  13. def findRestRegistration(rm: scala.reflect.api.JavaUniverse.RuntimeMirror, clz: Class[_], config: RestConfig): Option[RestRegistration]

    Finds a REST operation annotation in a org.mashupbots.socko.rest.RestRequest class.

    Finds a REST operation annotation in a org.mashupbots.socko.rest.RestRequest class.

    rm

    Runtime mirror

    clz

    class to check

    config

    REST configuration

    returns

    An instance of the annotation class or None if annotation not found

  14. def findRestRequest(registration: Option[RestRegistration], rm: scala.reflect.api.JavaUniverse.RuntimeMirror, clz: Class[_], classes: Seq[Class[_]]): Option[scala.reflect.api.JavaUniverse.Type]

    Finds a corresponding request class given the registration

    Finds a corresponding request class given the registration

    If registration requestClass field is empty, the assumed request class is the same class path and name as the registration class; but with registration suffix replaced with Request.

    If not empty, the specified request type will be used

    registration

    REST operation registration details

    rm

    Mirror

    clz

    registration class

    classes

    Sequence of classes in which to search for the request class

    returns

    the request type or None if not found

  15. def findRestResponse(registration: Option[RestRegistration], rm: scala.reflect.api.JavaUniverse.RuntimeMirror, clz: Class[_], classes: Seq[Class[_]]): Option[scala.reflect.api.JavaUniverse.Type]

    Finds a corresponding response class given the registration

    Finds a corresponding response class given the registration

    If registration responseClass field is empty, the assumed response class is the same class path and name as the registration class; but with registration suffix replaced with Response.

    If registration responseClass field is not empty, the specified response type will be used

    If customSerialization is declared, the standard NoSerializationRestResponse will be returned. This is just a placeholder and will not be used because the processing actor will handle serialization.

    registration

    REST operation registration details

    rm

    Mirror

    clz

    registration class

    classes

    Sequence of classes in which to search for the request class

    returns

    the response type or None if not found

  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. lazy val log: Logger

    Logger name is inferred from the class name.

    Logger name is inferred from the class name.

    Definition Classes
    Logger
  20. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  21. final def notify(): Unit

    Definition Classes
    AnyRef
  22. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  23. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  24. def toString(): String

    Definition Classes
    AnyRef → Any
  25. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  26. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  27. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from Serializable

Inherited from Serializable

Inherited from Logger

Inherited from AnyRef

Inherited from Any

Ungrouped