org.mashupbots.socko.rest

RestRegistry

case class RestRegistry(operations: Seq[RestOperation], swaggerApiDocs: SwaggerApiDocs, config: RestConfig) extends Product with Serializable

Collection org.mashupbots.socko.rest.RestOperations that will be used to process incoming requests.

operations

REST operations that will be used for processing requests

swaggerApiDocs

Swagger API documentation

config

REST configuration

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

Instance Constructors

  1. new RestRegistry(operations: Seq[RestOperation], swaggerApiDocs: SwaggerApiDocs, config: RestConfig)

    operations

    REST operations that will be used for processing requests

    swaggerApiDocs

    Swagger API documentation

    config

    REST configuration

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. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  5. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  6. val config: RestConfig

    REST configuration

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

    Definition Classes
    AnyRef
  8. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  9. def findOperation(endPoint: EndPoint): Option[RestOperation]

    Finds the operation that matches the specified end point.

    Finds the operation that matches the specified end point.

    If more than one operation matches, the one with the most number of static path segments will be used. If there is not a distinct operation with the most number of status path segments, None will be returned because an exact match cannot be found.

    endPoint

    Endpoint to match

    returns

    Matching org.mashupbots.socko.rest.RestOperation or None if not found

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

    Definition Classes
    AnyRef → Any
  11. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  12. def isSwaggerApiDocRequest(endPoint: EndPoint): Boolean

    Flag to indicate if the path requests swagger API document response.

    Flag to indicate if the path requests swagger API document response.

    For example, /api/api-docs.json and /api/api-docs.json/pets will return true but /api/pets will return false.

    endPoint

    Endpoint to check

    returns

    True if this endpoint requires api documentation to be returned

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

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

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

    Definition Classes
    AnyRef
  16. val operations: Seq[RestOperation]

    REST operations that will be used for processing requests

  17. val swaggerApiDocs: SwaggerApiDocs

    Swagger API documentation

  18. val swaggerRootApiDocsUrl: String

    Root path that will trigger the response of swagger API documentation.

    Root path that will trigger the response of swagger API documentation. For example, /api/api-docs.json.

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

    Definition Classes
    AnyRef
  20. final def wait(): Unit

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped