Packages

c

play.api.http

JavaCompatibleHttpRequestHandler

class JavaCompatibleHttpRequestHandler 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.

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

Instance Constructors

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

    (Since version 2.7.0) Use the main JavaCompatibleHttpRequestHandler constructor

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 asJava: JavaHttpRequestHandlerDelegate

    Adapt this to a Java HttpRequestHandler

    Adapt this to a Java HttpRequestHandler

    Definition Classes
    HttpRequestHandler
  6. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  9. def filterAction(next: EssentialAction): EssentialAction

    Apply filters to the given action.

    Apply filters to the given action.

    Attributes
    protected
    Definition Classes
    DefaultHttpRequestHandler
  10. def filterHandler(request: RequestHeader, handler: Handler): Handler

    Update the given handler so that when the handler is run any filters will also be run.

    Update the given handler so that when the handler is run any filters will also be run. The default behavior is to wrap all play.api.mvc.EssentialActions by calling filterAction, but to leave other kinds of handlers unchanged.

    Attributes
    protected
    Definition Classes
    DefaultHttpRequestHandler
  11. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  12. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  13. 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
  14. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  15. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  16. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  17. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  18. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  19. 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

    Definition Classes
    JavaCompatibleHttpRequestHandlerDefaultHttpRequestHandler
  20. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  21. def toString(): String
    Definition Classes
    AnyRef → Any
  22. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  23. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  24. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Deprecated Value Members

  1. def filterHandler(next: (RequestHeader) => Handler): (RequestHeader) => Handler

    Apply any filters to the given handler.

    Apply any filters to the given handler.

    Attributes
    protected
    Definition Classes
    DefaultHttpRequestHandler
    Annotations
    @deprecated
    Deprecated

    (Since version 2.6.0) Use filterHandler(RequestHeader, Handler) instead

Inherited from HttpRequestHandler

Inherited from AnyRef

Inherited from Any

Ungrouped