CORSFilter

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

It can be configured to...

filter paths by a whitelist of path prefixes
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)
enable/disable serving requests with origins not in whitelist as non-CORS requests (by default they are forbidden)

Source: CORSFilter.scala
See also: CORS specification
CORSActionBuilder
AbstractCORSPolicy
CORSConfig

Linear Supertypes

AbstractCORSPolicy, Filter, EssentialFilter, AnyRef, Any

Instance Constructors

new CORSFilter(corsConfig: CORSConfig, errorHandler: HttpErrorHandler, pathPrefixes: List[String])(mat: Materializer)
new CORSFilter(corsConfig: CORSConfig = CORSConfig(), errorHandler: HttpErrorHandler = DefaultHttpErrorHandler, pathPrefixes: Seq[String] = Seq("/"))(implicit mat: Materializer)

corsConfig
configuration of the CORS policy
pathPrefixes
whitelist of path prefixes to restrict the filter

Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def apply(f: (RequestHeader) ⇒ Future[Result])(request: RequestHeader): Future[Result]

Apply the filter, given the request header and a function to call the next operation.
Apply the filter, given the request header and a function to call the next operation.
f
A function to call the next opertion. Call this to continue normally with the current request. You do not need to call this function if you want to generate a result in a different way.

Definition Classes
CORSFilter → Filter
def apply(next: EssentialAction): EssentialAction

Definition Classes
Filter → EssentialFilter
final def asInstanceOf[T0]: T0

Definition Classes
Any
def asJava: EssentialFilter

Definition Classes
EssentialFilter
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
val corsConfig: CORSConfig

configuration of the CORS policy
configuration of the CORS policy

Attributes
protected
Definition Classes
CORSFilter → AbstractCORSPolicy
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
val errorHandler: HttpErrorHandler

Attributes
protected
Definition Classes
CORSFilter → AbstractCORSPolicy
def filterRequest(next: (RequestHeader) ⇒ Future[Result], request: RequestHeader): Future[Result]

Attributes
protected
Definition Classes
AbstractCORSPolicy
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
AnyRef → Any
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
val logger: api.Logger

Attributes
protected
Definition Classes
CORSFilter → AbstractCORSPolicy
implicit val mat: Materializer

Definition Classes
CORSFilter → Filter
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )

Related Docs: object CORSFilter | package cors

class CORSFilter extends Filter with AbstractCORSPolicy

Instance Constructors

new CORSFilter(corsConfig: CORSConfig, errorHandler: HttpErrorHandler, pathPrefixes: List[String])(mat: Materializer)

new CORSFilter(corsConfig: CORSConfig = CORSConfig(), errorHandler: HttpErrorHandler = DefaultHttpErrorHandler, pathPrefixes: Seq[String] = Seq("/"))(implicit mat: Materializer)

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

def apply(f: (RequestHeader) ⇒ Future[Result])(request: RequestHeader): Future[Result]

def apply(next: EssentialAction): EssentialAction

final def asInstanceOf[T0]: T0

def asJava: EssentialFilter

def clone(): AnyRef

val corsConfig: CORSConfig

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

val errorHandler: HttpErrorHandler

def filterRequest(next: (RequestHeader) ⇒ Future[Result], request: RequestHeader): Future[Result]

def finalize(): Unit

final def getClass(): Class[_]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

val logger: api.Logger

implicit val mat: Materializer

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

final def synchronized[T0](arg0: ⇒ T0): T0

def toString(): String

final def wait(): Unit

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

final def wait(arg0: Long): Unit

Inherited from AbstractCORSPolicy

Inherited from Filter

Inherited from EssentialFilter

Inherited from AnyRef

Inherited from Any

Ungrouped