Packages

object CORSActionBuilder

A play.api.mvc.ActionBuilder that implements Cross-Origin Resource Sharing (CORS)

It can be configured to...

  • allow only requests with origins from a whitelist (by default all origins are allowed)
  • allow only HTTP methods from a whitelist for preflight requests (by default all methods are allowed)
  • allow only HTTP headers from a whitelist for preflight requests (by default all headers are allowed)
  • set custom HTTP headers to be exposed in the response (by default no headers are exposed)
  • disable/enable support for credentials (by default credentials support is enabled)
  • set how long (in seconds) the results of a preflight request can be cached in a preflight result cache (by default 3600 seconds, 1 hour)
Source
CORSActionBuilder.scala
Example:

  1. CORSActionBuilder(configuration) { Ok } // an action that uses the application configuration

CORSActionBuilder(configuration, "my-conf-path") { Ok } // an action that uses a subtree of the application configuration

val corsConfig: CORSConfig = ...
CORSActionBuilder(conf) { Ok } // an action that uses a locally defined configuration
See also

play.filters.cors.CORSFilter

CORS specification

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. CORSActionBuilder
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

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. def apply(config: CORSConfig, errorHandler: HttpErrorHandler, parserConfig: ParserConfiguration, tempFileCreator: TemporaryFileCreator)(implicit materializer: Materializer, ec: ExecutionContext): CORSActionBuilder

    Construct an action builder that uses locally defined configuration.

    Construct an action builder that uses locally defined configuration.

    config

    The local configuration to use in place of the global configuration.

    See also

    play.filters.cors.CORSConfig

  5. def apply(config: Configuration, errorHandler: HttpErrorHandler = DefaultHttpErrorHandler, configPath: String = "play.filters.cors", parserConfig: ParserConfiguration = ParserConfiguration(), tempFileCreator: TemporaryFileCreator = SingletonTemporaryFileCreator)(implicit materializer: Materializer, ec: ExecutionContext): CORSActionBuilder

    Construct an action builder that uses a subtree of the application configuration.

    Construct an action builder that uses a subtree of the application configuration.

    config

    The configuration to load the config from

    configPath

    The path to the subtree of the application configuration.

  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
  8. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  9. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  10. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  11. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  12. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  13. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  15. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  16. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  17. def toString(): String
    Definition Classes
    AnyRef → Any
  18. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  19. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  20. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

Inherited from AnyRef

Inherited from Any

Ungrouped