scruffy

Type Members

1. class Applicative extends AnyRef

   

2. trait CacheSupport extends AnyRef

   

3. abstract class CacheType extends AnyRef

   

   Public - may be cached in public shared caches.

   Public - may be cached in public shared caches. Private - may only be cached in private cache. No-Cache - may not be cached. No-Store - may be cached but not archived.

4. class DefaultHttpHandler extends Logging with HttpHandler

   

5. class DynamicParameterUnknownException extends RuntimeException

   

6. class EntityWriter extends Logging

   

   Writes out a response to a byte array taking into account the content type.

7. type ErrorHandler = PartialFunction[Throwable, Response]

   

8. trait Filter extends AnyRef

   

9. case class FilterHolder(path: String, filter: Filter) extends Product with Serializable

   

10. class GroupExtractor extends AnyRef

    

11. case class HttpEndpoint(method: HttpMethod, url: String, pipeline: Pipeline) extends Product with Serializable

    

12. trait HttpEndpointProvider extends ResponseBuilder with ResponseConversions with DefaultProcessors

    

    A trait that provides the entry point to the DSL.

    A trait that provides the entry point to the DSL.

    Classes / objects that contain the endpoints for your application should extend this trait and call the get/post/delete/etc methods, providing the path to match on and the function chain.

13. trait HttpHandler extends AnyRef

    

14. trait Inferrable[T] extends AnyRef

    

15. trait Logging extends AnyRef

    

16. trait Mountpoint extends Logging

    

    An Mountpoint is a holder for the structures generated by the DSL.

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

    Your EndpointProviders will register with an instance of a mountpoint, for which there are implementations for different servers. For example ScruffyUndertowHttpHandler is a mountpoint that is used as a http handler for Undertow.

17. class PathFilter extends Filter

    

18. case class Pipeline(p: (Request) ⇒ Future[Response], filters: List[Filter]) extends Product with Serializable

    

19. case class PropertyKey[+T](value: String) extends Product with Serializable

    

20. case class Request(uri: Uri, method: HttpMethod, entity: Array[Byte], ipAddress: String, headers: List[Header], properties: Map[PropertyKey[Any], Any], session: Option[Session] = None, principal: Option[Principal] = None, response: Response = Response.ok, marshallers: Iterable[Marshaller] = Nil, id: String = ...) extends Product with Serializable

    

21. trait RequestIdGenerator extends AnyRef

    

22. case class Response(status: Int, entity: Any = Array.emptyByteArray, cookies: List[Cookie] = Nil, headers: List[Header] = Nil, properties: Map[PropertyKey[Any], Any] = Map.empty) extends Product with Serializable

    

23. trait ResponseBuilder extends AnyRef

    

24. trait ResponseConversions extends ResponseBuilder

    

25. trait ScruffyListener extends AnyRef

    

    A listener can register for callbacks at various times in the scruffy lifecycle, for example on startup, shutdown, and when endpoints are registered.

26. case class ScruffyOnNettyConf(_port: Int = 8080, _compression: Boolean = true, _maxContentLength: Int = 4048576, _keepAlive: Boolean = true, _bossThreads: Int = 1, _workerThreads: Int = ..., _socketBacklog: Int = 512, _dateHeader: Boolean = true, _security: Option[() ⇒ SSLEngine] = None, _requestLogging: Boolean = true, _marshallers: Seq[Marshaller] = ..., _notFound: (Request) ⇒ Response = req => Response.notFound) extends Product with Serializable

    

27. case class WebsocketEndpoint(url: String) extends Product with Serializable

    

28. trait WebsocketEndpointProvider extends AnyRef