c

play.api.http

DefaultHttpRequestHandler

class DefaultHttpRequestHandler extends HttpRequestHandler

A base implementation of the HttpRequestHandler that handles Scala actions. If you use Java actions in your application, you should override JavaCompatibleHttpRequestHandler; otherwise you can override this for your custom handler.

Technically, this is not the default request handler that Play uses, rather, the JavaCompatibleHttpRequestHandler is the default one, in order to provide support for Java actions.

Source
HttpRequestHandler.scala
Linear Supertypes
HttpRequestHandler, AnyRef, Any
Known Subclasses
JavaCompatibleHttpRequestHandler
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. DefaultHttpRequestHandler
  2. HttpRequestHandler
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new DefaultHttpRequestHandler(webCommands: WebCommands, optDevContext: OptionalDevContext, router: Provider[Router], errorHandler: HttpErrorHandler, configuration: HttpConfiguration, filters: HttpFilters)
    Annotations
    @Inject()
  2. new DefaultHttpRequestHandler(webCommands: WebCommands, optDevContext: Option[DevContext], router: Provider[Router], errorHandler: HttpErrorHandler, configuration: HttpConfiguration, filters: Seq[EssentialFilter])
  3. new DefaultHttpRequestHandler(webCommands: WebCommands, optDevContext: OptionalDevContext, router: Router, errorHandler: HttpErrorHandler, configuration: HttpConfiguration, filters: HttpFilters)
    Annotations
    @deprecated
    Deprecated

    (Since version 2.9.0) Use the main DefaultHttpRequestHandler constructor

  4. new DefaultHttpRequestHandler(webCommands: WebCommands, optDevContext: Option[DevContext], router: Router, errorHandler: HttpErrorHandler, configuration: HttpConfiguration, filters: Seq[EssentialFilter])
    Annotations
    @deprecated
    Deprecated

    (Since version 2.9.0) Use the main DefaultHttpRequestHandler constructor

Value Members

  1. def asJava: JavaHttpRequestHandlerDelegate

    Adapt this to a Java HttpRequestHandler

    Adapt this to a Java HttpRequestHandler

    Definition Classes
    HttpRequestHandler
  2. def handlerForRequest(request: 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
    → HttpRequestHandler
  3. 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