p

controllers

package controllers

Ordering
  1. Alphabetic
Visibility
  1. Public
  2. All

Type Members

  1. case class AssetEncoding(acceptEncoding: String, extension: String) extends Product with Serializable
  2. class Assets extends AssetsBuilder
    Annotations
    @Singleton()
  3. class AssetsBuilder extends ControllerHelpers
  4. trait AssetsComponents extends AnyRef
  5. case class AssetsConfiguration(path: String = "/public", urlPrefix: String = "/assets", defaultCharSet: String = "utf-8", enableCaching: Boolean = true, enableCacheControl: Boolean = false, configuredCacheControl: Map[String, Option[String]] = Map.empty, defaultCacheControl: String = "public, max-age=3600", aggressiveCacheControl: String = "public, max-age=31536000, immutable", digestAlgorithm: String = "md5", checkForMinified: Boolean = true, textContentTypes: Set[String] = Set("application/json", "application/javascript"), encodings: Seq[AssetEncoding] = Seq( AssetEncoding.Brotli, AssetEncoding.Gzip, AssetEncoding.Xz, AssetEncoding.Bzip2 )) extends Product with Serializable
  6. case class AssetsConfigurationProvider(env: Environment, conf: Configuration) extends Provider[AssetsConfiguration] with Product with Serializable
  7. trait AssetsFinder extends AnyRef

    Can be used to find assets according to configured base path and URL base.

  8. class AssetsFinderProvider extends Provider[AssetsFinder]
  9. trait AssetsMetadata extends AnyRef

    INTERNAL API: Retains metadata for assets that can be readily cached.

  10. class AssetsMetadataProvider extends Provider[DefaultAssetsMetadata]

    A provider for AssetsMetadata that sets up necessary static state for reverse routing.

    A provider for AssetsMetadata that sets up necessary static state for reverse routing. The PathBindable for assets does additional "magic" using statics so routes like routes.Assets.versioned("foo.js") will find the minified and digested version of that asset.

    It is also possible to avoid this provider and simply inject AssetsFinder. Then you can call AssetsFinder.path to get the final path of an asset according to the path and url prefix in configuration.

    Annotations
    @Singleton()
  11. class AssetsModule extends Module
  12. class Default extends ControllerHelpers

    Default actions ready to use as is from your routes file.

    Default actions ready to use as is from your routes file.

    Example:

    GET   /google          controllers.Default.redirect(to = "http://www.google.com")
    GET   /favicon.ico     controllers.Default.notFound
    GET   /admin           controllers.Default.todo
    GET   /xxx             controllers.Default.error
  13. class DefaultAssetsMetadata extends AssetsMetadata

    Default implementation of AssetsMetadata.

    Default implementation of AssetsMetadata.

    If your application uses reverse routing with assets or the Assets static object, you should use the AssetsMetadataProvider to set up needed statics.

    Annotations
    @Singleton()
  14. class ExternalAssets extends ControllerHelpers

    Controller that serves static resources from an external folder.

    Controller that serves static resources from an external folder. It useful in development mode if you want to serve static assets that shouldn't be part of the build process.

    Note that this controller IS NOT intended to be used in production mode and can lead to security issues. Therefore it is automatically disabled in production mode.

    All assets are served with max-age=3600 cache directive.

    You can use this controller in any application, just by declaring the appropriate route. For example:

    GET     /assets/*file               controllers.ExternalAssets.at(path="/home/peter/myplayapp/external", file)
    GET     /assets/*file               controllers.ExternalAssets.at(path="C:\external", file)
    GET     /assets/*file               controllers.ExternalAssets.at(path="relativeToYourApp", file)

Value Members

  1. object AssetEncoding extends Serializable
  2. object Assets

    Controller that serves static resources.

    Controller that serves static resources.

    Resources are searched in the classpath.

    It handles Last-Modified and ETag header automatically. If a gzipped version of a resource is found (Same resource name with the .gz suffix), it is served instead. If a digest file is available for a given asset then its contents are read and used to supply a digest value. This value will be used for serving up ETag values and for the purposes of reverse routing. For example given "a.js", if there is an "a.js.md5" file available then the latter contents will be used to determine the Etag value. The reverse router also uses the digest in order to translate any file to the form <digest>-<asset> for example "a.js" may be also found at "d41d8cd98f00b204e9800998ecf8427e-a.js". If there is no digest file found then digest values for ETags are formed by forming a sha1 digest of the last-modified time.

    The default digest algorithm to search for is "md5". You can override this quite easily. For example if the SHA-1 algorithm is preferred:

    "play.assets.digest.algorithm" = "sha1"

    You can set a custom Cache directive for a particular resource if needed. For example in your application.conf file:

    "play.assets.cache./public/images/logo.png" = "max-age=3600"

    You can use this controller in any application, just by declaring the appropriate route. For example:

    GET     /assets/*file               controllers.Assets.at(path="/public", file)
  3. object AssetsConfiguration extends Serializable
  4. object Execution extends TrampolineContextProvider

Ungrouped