JavaCompatibleHttpRequestHandler

play.api.http.JavaCompatibleHttpRequestHandler
class JavaCompatibleHttpRequestHandler(webCommands: WebCommands, optDevContext: Option[DevContext], router: Provider[Router], errorHandler: HttpErrorHandler, configuration: HttpConfiguration, filters: Seq[EssentialFilter], handlerComponents: JavaHandlerComponents) extends DefaultHttpRequestHandler

A Java compatible HTTP request handler.

If a router routes to Java actions, it will return instances of play.core.j.JavaHandler. This takes an instance of play.core.j.JavaHandlerComponents to supply the necessary infrastructure to invoke a Java action, and returns a new play.api.mvc.Handler that the core of Play knows how to handle.

If your application routes to Java actions, then you must use this request handler as the base class as is or as the base class for your custom HttpRequestHandler.

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any

Members list

Value members

Constructors

@Inject
def this(webCommands: WebCommands, optDevContext: OptionalDevContext, router: Provider[Router], errorHandler: HttpErrorHandler, configuration: HttpConfiguration, filters: HttpFilters, handlerComponents: JavaHandlerComponents)

Deprecated constructors

def this(webCommands: WebCommands, optDevContext: Option[DevContext], router: Router, errorHandler: HttpErrorHandler, configuration: HttpConfiguration, filters: Seq[EssentialFilter], handlerComponents: JavaHandlerComponents)

Attributes

Deprecated
true
def this(webCommands: WebCommands, optDevContext: OptionalDevContext, router: Router, errorHandler: HttpErrorHandler, configuration: HttpConfiguration, filters: HttpFilters, handlerComponents: JavaHandlerComponents)

Attributes

Deprecated
true

Concrete methods

override 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.

Value parameters

request

The request

Attributes

Returns

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

Definition Classes

Inherited methods

Adapt this to a Java HttpRequestHandler

Adapt this to a Java HttpRequestHandler

Attributes

Inherited from:
HttpRequestHandler

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.

Value parameters

request

The request to handle

Attributes

Returns

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

Definition Classes
Inherited from:
DefaultHttpRequestHandler