Class

com.twitter.finagle.http.filter.Cors

Policy

Related Doc: package Cors

Permalink

case class Policy(allowsOrigin: (String) ⇒ Option[String], allowsMethods: (String) ⇒ Option[Seq[String]], allowsHeaders: (Seq[String]) ⇒ Option[Seq[String]], exposedHeaders: Seq[String] = Nil, supportsCredentials: Boolean = false, maxAge: Option[Duration] = None) extends Product with Serializable

A Cross-Origin Resource Sharing policy.

A Policy determines how CORS response headers are set in response to a request with CORS headers:

allowsOrigin is a function that takes the value specified in the Origin request header and optionally returns the value of Access-Control-Allow-Origin.

allowsMethods is a function that takes the value of the Access-Control-Request-Method preflight request header and optionally returns a list of methods to be set in the Access-Control-Allow-Methods response header.

allowsHeaders is a function that takes the values set in the Access-Control-Request-Headers preflight request header and returns the header names to be set in the Access-Control-Allow- Headers response header.

exposedHeaders is the list of header names to be set in the Access-Control-Expose-Headers response header (in response to non-preflight requests).

If supportsCredentials is true and allowsOrigin does not return '*', the Access-Control- Allow-Credentials response header will be set to 'true'.

If maxAge is defined, its value (in seconds) will be set in the Access-Control-Max-Age response header.

Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Policy
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Policy(allowsOrigin: (String) ⇒ Option[String], allowsMethods: (String) ⇒ Option[Seq[String]], allowsHeaders: (Seq[String]) ⇒ Option[Seq[String]], exposedHeaders: Seq[String] = Nil, supportsCredentials: Boolean = false, maxAge: Option[Duration] = None)

    Permalink

Value Members

  1. final def !=(arg0: Any): Boolean

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  4. val allowsHeaders: (Seq[String]) ⇒ Option[Seq[String]]

    Permalink
  5. val allowsMethods: (String) ⇒ Option[Seq[String]]

    Permalink
  6. val allowsOrigin: (String) ⇒ Option[String]

    Permalink
  7. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  8. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  9. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  10. val exposedHeaders: Seq[String]

    Permalink
  11. def finalize(): Unit

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

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

    Permalink
    Definition Classes
    Any
  14. val maxAge: Option[Duration]

    Permalink
  15. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  16. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  17. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  18. val supportsCredentials: Boolean

    Permalink
  19. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  20. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped