play.api.http

DefaultHttpRequestHandler

Related Doc: package http

class DefaultHttpRequestHandler extends HttpRequestHandler

A default implementation of the HttpRequestHandler.

This can be conveniently overridden to plug in global interception or custom routing logic into Play's existing request handling infrastructure.

Technically, this is not the default request handler that Play uses, rather, the GlobalSettingsHttpRequestHandler is the default one, in order to ensure that existing legacy implementations of global request interception still work. In future, this will become the default request handler.

The default implementations of method interception methods on play.api.GlobalSettings match the implementations of this, so when not providing any custom logic, whether this is used or the global settings http request handler is used is irrelevant.

Source
HttpRequestHandler.scala
Linear Supertypes
HttpRequestHandler, AnyRef, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. DefaultHttpRequestHandler
  2. HttpRequestHandler
  3. AnyRef
  4. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new DefaultHttpRequestHandler(router: Router, errorHandler: HttpErrorHandler, configuration: HttpConfiguration, filters: HttpFilters)

    Annotations
    @Inject()
  2. new DefaultHttpRequestHandler(router: Router, errorHandler: HttpErrorHandler, configuration: HttpConfiguration, filters: EssentialFilter*)

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 filterAction(next: EssentialAction): EssentialAction

    Apply filters to the given action.

    Apply filters to the given action.

    Attributes
    protected
  9. def filterHandler(next: (RequestHeader) ⇒ Handler): (RequestHeader) ⇒ Handler

    Apply any filters to the given handler.

    Apply any filters to the given handler.

    Attributes
    protected
  10. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  11. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  12. def handlerForRequest(request: RequestHeader): (RequestHeader, Handler)

    Get a handler for the given request.

    Get a handler for the given request.

    In addition to retrieving a handler for the request, the request itself may be modified - typically it will be tagged with routing information. It is also acceptable to simply return the request as is. Play will switch to using the returned request from this point in in its request handling.

    The reason why the API allows returning a modified request, rather than just wrapping the Handler in a new Handler that modifies the request, is so that Play can pass this request to other handlers, such as error handlers, or filters, and they will get the tagged/modified request.

    request

    The request to handle

    returns

    The possibly modified/tagged request, and a handler to handle it

    Definition Classes
    DefaultHttpRequestHandlerHttpRequestHandler
  13. def hashCode(): Int

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

    Definition Classes
    Any
  15. final def ne(arg0: AnyRef): Boolean

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

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

    Definition Classes
    AnyRef
  18. def routeRequest(request: RequestHeader): Option[Handler]

    Called when an HTTP request has been received.

    Called when an HTTP request has been received.

    The default is to use the application router to find the appropriate action.

    This method can be overridden if you want to provide some custom routing strategies, for example, using different routers based on various request parameters.

    request

    The request

    returns

    A handler to handle the request, if one can be found

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

    Definition Classes
    AnyRef
  20. def toString(): String

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

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from HttpRequestHandler

Inherited from AnyRef

Inherited from Any

Ungrouped