All Classes and Interfaces
Class
Description
Processes a request and adds content security policy header.
This class is necessary because ConnectionPoolDataSourceProxy's targetDS field is protected.
Accumulates inputs asynchronously into an output value.
An action acts as decorator for the action method call.
A simple action with no configuration.
An interface for creating Java actions from Java methods.
Provides a flow that is handled by an actor.
This action adds a CSRF token to the request and response if not already there.
A WS client backed by AsyncHttpClient implementation.
AsyncHttpClient WS implementation components.
The Play module to provide Java bindings for WS to an AsyncHTTPClient implementation.
A Play WS request backed by AsyncHTTPClient implementation.
A Play WS response backed by an AsyncHttpClient response.
Java Components for the Allowed Hosts filter.
Annotation utilities.
A Play application.
The application component.
Application lifecycle register.
Loads an application.
The context for loading an application.
Provides information about a Play Application running inside a Play server.
A ClassLoader for serving assets.
Java components for Assets.
The Cache API.
A binding.
A binding key.
A binding target that is provided by another key - essentially an alias.
A binding target.
A body parser parses the HTTP request body content.
Guess the body content by checking the Content-Type header.
A body parser that first buffers
Parse the body as a byte string.
A body parser that completes the underlying one.
If the request has a body, guess the body content by checking the Content-Type header.
A body parser that delegates to a Scala body parser, and uses the supplied function to
transform its result to a Java body.
A body parser that exposes a file part handler as an abstract method and delegates the
implementation to the underlying Scala multipartParser.
Don't parse the body.
Parse the body as form url encoded if the Content-Type is application/x-www-form-urlencoded.
Parse the body as Json if the Content-Type is text/json or application/json.
Abstract body parser that enforces a maximum length.
Parse the body as multipart form-data without checking the Content-Type.
Specify the body parser to use for an Action method.
Store the body content in a RawBuffer.
Parse the body as text if the Content-Type is text/plain.
Parse the body as Json without checking the Content-Type.
Parse the body as text without checking the Content-Type.
Parse the body as Xml without checking the Content-Type.
Parse the body as Xml if the Content-Type is application/xml.
Java BodyParser components.
Utilities for creating body parsers.
Interface used by the build to call a DocumentationHandler.
Interface used by the Play build plugin to communicate with an embedded Play server.
Helper to provide the Play built in components.
This helper class provides all the built-in component dependencies by trading them for a single
dependency - the application loader context.
Mark an action to be cached on server side.
Cache another action.
Caffeine Cache Java Components for compile time injection.
Deprecated.
Deprecated as of 2.8.0.
A configuration parser for the
Caffeine builder.Defines a 'call', describing an HTTP request.
ExecutionContexts that preserve the current thread's context ClassLoader by passing it through
ClassLoaderExecutionContext.Execution context for managing the ClassLoader scope.
A RFC6265 compliant cookie decoder to be used
client side.
A RFC6265 compliant cookie encoder to be used
client side, so only name=value pairs are sent.
Provides an easy way to use a Comet formatted output with Pekko Streams.
Provides configuration components.
Similar to java.util.concurrent.Callable with a Connection as argument.
Connection pool API for managing data sources.
A base for Java connection pool components.
Similar to java.lang.Runnable with a Connection as argument.
Defines a set of built-in validation constraints.
Defines a email constraint for a string field.
Defines several
@Email annotations on the same element.Validator for
@Email fields.Defines a maximum value for a numeric field.
Defines several
@Max annotations on the same element.Defines a maximum length for a string field.
Defines several
@MaxLength annotations on the same element.Validator for
@MaxLength fields.Validator for
@Max fields.Defines a minimum value for a numeric field.
Defines several
@Min annotations on the same element.Defines a minimum length for a string field.
Defines several
@MinLength annotations on the same element.Validator for
@MinLength fields.Validator for
@Min fields.Defines a pattern constraint for a string field.
Defines several
@Pattern annotations on the same element.Validator for
@Pattern fields.Defines a field as required.
Defines several
@Required annotations on the same element.Validator for
@Required fields.Defines several
@Validate annotations on the same element.Defines a custom validator.
Defines several
@ValidatePayloadWith annotations on the same element.Validator for
@ValidatePayloadWith fields.Defines a custom validator.
Defines several
@ValidateWith annotations on the same element.Defines several
@ValidateWithPayload annotations on the same element.Validator for
@ValidateWith fields.Super-type for validators.
Super-type for validators with a payload.
A binding target that is provided by a class.
Imported from apache.commons.lang3 3.6
This helper class provides all the built-in component dependencies by trading them for a single
dependency - the application loader context.
Superclass for a Java-based controller.
An interface defining an HTTP cookie.
Authenticates a cookie by returning a message authentication code (MAC).
Java Components for the CORS Filter.
This annotation runs the play.filters.csp.CSPAction on a controller method.
This action is used to add a CSP header to the response through injection.
The Java CSP components.
Components for reporting CSP violations.
The Java CSRF components.
This interface handles the CSRF error.
Cryptographic utilities for generating and validating CSRF tokens.
Provides a custom execution context from an Pekko dispatcher.
Database API for managing data sources and connections.
Creation helpers for manually instantiating databases.
DB API for managing application databases.
Java DB components.
Injection module with default DB components.
Inject provider for named databases.
A default implementation of the action creator.
Default implementation of a Play Application.
Adapts a Scala AsyncCacheApi to a Java AsyncCacheApi.
Default delegating implementation of the connection pool API.
Creates validator instances with injections available.
The default
Cookie implementation.This class delegates to the Scala CookieSigner.
Cryptographic utilities for generating and validating CSRF tokens.
Default delegating implementation of the database API.
Default delegating implementation of the DB API.
The default implementation of the Futures trait.
Default implementation of the http error handler.
Helper class which has a varargs constructor taking the filters.
Default implementation of the JPA API.
Default JPA configuration.
An implementation of SyncCacheApi that wraps AsyncCacheApi
A ClassLoader that only uses resources from its parent
Dev server
A dynamic form.
Simple data structure used by
DynamicForm.EhCache Java Components for compile time injection.
The environment for the application.
Given a `RequestHeader`, an `EssentialAction` consumes the request body (a `ByteString`) and
returns a `Result`.
This class provides an easy way to use Server Sent Events (SSE) as a chunked encoding, using an
Pekko Source.
Utility class to build events.
An evolution.
Utilities for working with evolutions.
Reads evolutions.
Copied from apache.commons.lang3 3.7
Defines a set of functional programming style helpers.
Represents a value of one of two possible types (a disjoint union)
A Function with 3 arguments.
A Function with 4 arguments.
Exception thrown when an operation times out.
A pair - a tuple of the types
A and B.A tuple of A,B,C
A tuple of A,B,C,D
A tuple of A,B,C,D,E
Java File Mime Types components.
Contains TemporaryFile and TemporaryFileCreator operations.
Delegates to the Scala implementation.
A temporary file creator that delegates to a Scala TemporaryFileCreator.
A temporary file creator that uses the Scala play.api.libs.Files.SingletonTemporaryFileCreator
class behind the scenes.
A temporary file created by a TemporaryFileCreator.
This creates temporary files when Play needs to keep overflow data on the filesystem.
Helper to manage HTML form description, submission and validation.
Defines a form element's display name.
A form field.
Defines several default formatters.
Annotation formatter, triggered by the
@DateTime annotation.Annotation formatter, triggered by the
@NonEmpty annotation.Formatter for
java.util.Date values.Defines the format for a
Date field.Defines the format for a
String field that cannot be empty.Formatters helper.
Super-type for annotation-based formatters.
Super-type for custom simple formatters.
Helper to create HTML forms.
Java Components for FormFactory.
Utilities for creating
CompletionStage operations.An ApplicationLoader that uses Guice to bootstrap the application.
A builder for creating Guice-backed Play Injectors.
Default empty builder for creating Guice-backed Injectors.
The GZIP filter Java components.
A request and a handler to handle it.
Helper functions to run tests.
HikariCP Java components (for compile-time injection).
An HttpErrorHandler that uses either HTML or JSON in the response depending on the client's
preference.
Defines HTTP standard objects.
HTTP Cookie
The cookie SameSite attribute
HTTP Cookies set
HTTP Flash.
Defines all standard HTTP headers.
Standard HTTP Verbs
Common HTTP MIME types
Multipart form data body.
Info about a file part
A file part.
Handle the request body a raw bytes data.
An HTTP request.
The request body.
The builder for building a request.
An HTTP request.
HTTP Session.
Defines all standard HTTP status codes.
Http Configuration Java Components.
An HTTP entity
A chunked entity, backed by a source of chunks.
A streamed entity, backed by a source.
A strict entity, where all the data for it is in memory.
Component for handling HTTP errors in Play.
Request attributes used by the error handler.
The HTTP Error handler Java Components.
Used as request attribute which gets attached to the request that gets passed to an error
handler.
Deprecated.
Deprecated as of 2.9.0.
Deprecated.
Deprecated as of 2.9.0.
Provides filters to the HttpRequestHandler.
A compile time default filters components.
An HTTP request handler
Java I18n components.
Support for creating injected child actors.
An injector, capable of providing components.
The IP filter components for compile time dependency injection.
Helpers for creating JavaScript reverse routers
JCache components
JPA API.
Java JPA Components.
JPA configuration.
Injection module with default JPA components.
Helper functions to handle JsonNode values.
An alternative default HTTP error handler which will render errors as JSON messages instead of
HTML pages.
The JSONP Content renders a JavaScript call of a JSON object.
Example of use, provided the following route definition:
Example of use, provided the following route definition:
A Lang supported by the application.
Manages languages in Play
High level API for logging operations.
Typical logger interface
Runs through underlying logger configuration.
ConstraintValidatorFactory to be used with compile-time Dependency Injection.
The components necessary to handle a Java handler.
A WebSocket message.
A binary WebSocket message
A close WebSocket message
A ping WebSocket message
A pong WebSocket message
A text WebSocket message
A Messages will produce messages using a specific language.
The messages API.
This class implements the Messages interface.
Imported from apache.commons.lang3 3.6
Application mode, either `DEV`, `TEST`, or `PROD`.
A Play dependency injection module.
An implementation of the [[jakarta.inject.Named]] annotation.
A ClassLoader with a toString() that prints name/urls.
Java component to mix in when no default filters should be mixed in to
BuiltInComponents.A client for performing OpenID authentication.
OpenID Java components.
Binder for path parameters.
Implementations to work with URL paths.
Helper to access the application defined Pekko Actor system.
Pekko and Pekko Streams components.
Support for binding actors with Guice.
Pekko streams utilities.
Pekko Typed components.
Helper for `PlayException`.
Adds any attachment to a Play exception.
Adds source attachment to a Play exception.
Adds a rich HTML description to a Play exception.
An `HttpErrorHandler` that delegates to one of several `HttpErrorHandlers` depending on the
client's media type preference.
A binding target that is provided by a provider class.
A binding target that is provided by a provider instance.
A qualifier annotation.
A qualifier annotation instance.
A qualifier annotation instance.
Binder for query string parameters.
Java API for Range results.
The Redirect to HTTPS filter components for compile time dependency injection.
A server that can be reloaded or stopped.
Define functions to be used with
RoutingDsl.A function that receives a
Http.Request, no parameters, and return a result type.A function that receives a
Http.Request, a single parameter, and return a result type.A function that receives a
Http.Request, two parameters, and return a result type.A function that receives a
Http.Request, three parameters, and return a result type.This is used to "tag" the functions which requires a request to execute.
This action requires a CSRF check.
Provides utility functions to work with resources.
A simple HTTP response header, used for standard responses.
Any action result.
Common results.
The Java Router API
Request attributes used by the router.
A DSL for building a router.
Java Components for RoutingDsl.
RoutingDsl components from the built in components.
The represents an object which "hooks into" play run, and is used to apply startup/cleanup
actions around a play application.
Class that contains useful java <-> scala conversion helpers.
Defines several security helpers.
Wraps the annotated action in an
Security.AuthenticatedAction.Wraps another action, allowing only authenticated HTTP requests.
Handles authentication.
The security headers Java components.
A Play server.
Configures and builds an embedded server.
Specifies the protocols supported by the server.
A RFC6265 compliant cookie decoder to be used
server side.
A RFC6265 compliant cookie encoder to be used
server side, so some fields are sent (Version is typically ignored).
A simple evolutions reader that uses a map to store evolutions
Provides access to the calling line of code.
To configure the SSLEngine used by Play as a server, extend this class.
A status with no body
A synchronous API to access a Cache.
Adapts a Scala SyncCacheApi to a Java SyncCacheApi
Components related to temporary file handle.
A test browser (Using Selenium WebDriver) with the FluentLenium API
(https://github.com/Fluentlenium/FluentLenium).
A test web server.
Time utilities.
Thanks to Quartz project, https://quartz.dev.java.net
An enumeration defines of isolation level that determines the degree to which one transaction
must be isolated from resource or data modifications made by other operations.
An entry that binds a typed key and a value.
A TypedKey is a key that can be used to get and set values in a
TypedMap or any object
with typed keys.A TypedMap is an immutable map containing typed values.
A UsefulException is something useful to display in the User browser.
The OpenID user info
A form validation error.
Deprecated.
Deprecated since 2.7.0.
Java Components for Validator.
A WebSocket handler.
Utility class for creating WebSockets.
Decorates an
Action or a Controller with another Action.Provides an application for JUnit tests.
Provides a server and browser to JUnit tests.
Provides a server to JUnit tests.
JSON, XML and Multipart Form Data Readables used for Play-WS bodies.
JSON, XML and Multipart Form Data Writables used for Play-WS bodies.
This is the WS Client interface for Java.
Java WSClient components.
This is the main interface to building a WS request in Java.
This is the WS response from the server.
XML utilities.
Includes the SAX prefixes from 'com.sun.org.apache.xerces.internal.impl.Constants' since they
will likely be internal in JDK9
XPath for parsing