play.filters.cors

CORSFilter

Related Docs: class CORSFilter | package cors

object CORSFilter extends Filter with AbstractCORSPolicy

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

It can be configured to...

Source
CORSFilter.scala
Example:

  1. The configuration is as follows:

    cors {
    path.prefixes = ["/myresource", ...]  # If left undefined, all paths are filtered
    allowed {
        origins = ["http://...", ...]  # If left undefined, all origins are allowed
        http {
            methods = ["PATCH", ...]  # If left undefined, all methods are allowed
            headers = ["Custom-Header", ...]  # If left undefined, all headers are allowed
        }
    }
    exposed.headers = [...]  # empty by default
    supports.credentials = true  # true by default
    preflight.maxage = 3600  # 3600 by default
}
See also

CORS specification

CORSActionBuilder

Linear Supertypes
AbstractCORSPolicy, Filter, EssentialFilter, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. CORSFilter
  2. AbstractCORSPolicy
  3. Filter
  4. EssentialFilter
  5. AnyRef
  6. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

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(f: (RequestHeader) ⇒ Future[Result])(request: RequestHeader): Future[Result]

    Definition Classes
    CORSFilter → Filter

  5. def apply(next: EssentialAction): EssentialAction

    Definition Classes
    Filter → EssentialFilter

  6. final def asInstanceOf[T0]: T0

    Definition Classes
    Any

  7. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  8. def corsConfig: CORSConfig

    Attributes
    protected
    Definition Classes
    CORSFilter → AbstractCORSPolicy

  9. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  10. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any

  11. def filterRequest(f: () ⇒ Future[Result], request: RequestHeader): Future[Result]

    Attributes
    protected
    Definition Classes
    AbstractCORSPolicy

  12. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  13. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any

  14. def hashCode(): Int

    Definition Classes
    AnyRef → Any

  15. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

  16. val logger: api.Logger

    Attributes
    protected
    Definition Classes
    CORSFilter → AbstractCORSPolicy

  17. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  18. final def notify(): Unit

    Definition Classes
    AnyRef

  19. final def notifyAll(): Unit

    Definition Classes
    AnyRef

  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( ... )

  23. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  24. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from AbstractCORSPolicy

Inherited from Filter

Inherited from EssentialFilter

Inherited from AnyRef

Inherited from Any

Ungrouped