com.sksamuel.scruffy

EndpointContainer

Related Doc: package scruffy

trait EndpointContainer extends Logging

An EndpointContainer is a holder for the structures generated by the DSL. That is, a container will contain a collection of endpoints, filters, and listeners.

Your EndpointProviders will register with an instance of an endpoint container, which is typically a server instance, such as ScruffyOnNetty (runs on Netty), ScruffyOnGrizzly (runs on Grizzly) or a ScruffyServlet (runs inside a servlet container).

Linear Supertypes
Logging, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. EndpointContainer
  2. Logging
  3. AnyRef
  4. 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. final def asInstanceOf[T0]: T0

    Definition Classes
    Any

  5. def clone(): AnyRef

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

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

    Definition Classes
    AnyRef

  7. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any

  8. def filter(filter: Filter, path: String = "/*"): Unit

    Add a processor that acts as a filter.

    Add a processor that acts as a filter. A filter is a processsor that will be executed for all matching requests before any processors from the endpoint that handles the request.

    This filter will be applied to any endpoints that are mounted after the registration of this filter.

    Any filters added here are executed before any endpoint specific filters.

    filter

    the processor to add

    path

    the path to match requests against, defaults to all paths

  9. def finalize(): Unit

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

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

    Definition Classes
    AnyRef → Any

  11. def hashCode(): Int

    Definition Classes
    AnyRef → Any

  12. def httpEndpoints: List[HttpEndpoint]

    Attributes
    protected

  13. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

  14. def listener(listener: ScruffyListener): Unit

    Registers a ScruffyListener with this endpoint container.

    Registers a ScruffyListener with this endpoint container. Multiple listeners can be added.

  15. val listeners: ListBuffer[ScruffyListener]

  16. val logger: Logger

    Attributes
    protected
    Definition Classes
    Logging

  17. def mount(provider: WebsocketEndpointProvider): Unit

    Mount all the websocket endpoints specified in this endpoint provider.

    Mount all the websocket endpoints specified in this endpoint provider. Multiple providers can be registered and the order of registration does not matter.

    provider

    the WebsocketEndpointProvider that contains the websocket endpoints to register.

  18. def mount(provider: HttpEndpointProvider): Unit

    Mount all the http endpoints specified in this endpoint provider.

    Mount all the http endpoints specified in this endpoint provider. Multiple providers can be registered and the order of registration does not matter.

    provider

    the HttpEndpointProvider that contains the http endpoints to register.

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

    Definition Classes
    AnyRef

  20. final def notify(): Unit

    Definition Classes
    AnyRef

  21. final def notifyAll(): Unit

    Definition Classes
    AnyRef

  22. val serverFilters: ListBuffer[Filter]

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

  28. val websocketEndpoints: ListBuffer[WebsocketEndpoint]

Inherited from Logging

Inherited from AnyRef

Inherited from Any

Ungrouped