Class Cors

java.lang.Object

com.soklet.Cors

@ThreadSafe
public final class Cors
extends Object

Encapsulates non-preflight CORS HTTP request data.

Data for preflight requests is represented by CorsPreflight.

Instances can be acquired via these factory methods:

• withOrigin(HttpMethod, String) (uses Origin header value)
• fromHeaders(HttpMethod, Map) (parses raw headers)

See https://www.soklet.com/docs/cors for detailed documentation.

Author:

Mark Allen

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object object)
static Optional<Cors>	fromHeaders(HttpMethod httpMethod, Map<String, Set<String>> headers)	Extracts a CORS non-preflight request representation from the given HTTP request data.
HttpMethod	getHttpMethod()	The HTTP method for this request.
String	getOrigin()	The HTTP Origin header value for this request.
int	hashCode()
String	toString()
static Cors	withOrigin(HttpMethod httpMethod, String origin)	Acquires a CORS non-preflight request representation for the given HTTP request data.

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Method Details

withOrigin

@Nonnull
public static Cors withOrigin(@Nonnull
 HttpMethod httpMethod,
 @Nonnull
 String origin)

Acquires a CORS non-preflight request representation for the given HTTP request data.

Parameters:

httpMethod - the request's HTTP method

origin - HTTP Origin request header value

Returns:

a Cors instance

fromHeaders

@Nonnull
public static Optional<Cors> fromHeaders(@Nonnull
 HttpMethod httpMethod,
 @Nonnull
 Map<String, Set<String>> headers)

Extracts a CORS non-preflight request representation from the given HTTP request data.

Parameters:

httpMethod - the request's HTTP method

headers - the request headers

Returns:

the CORS non-preflight data for this request, or Optional.empty() if insufficent data is present

toString

@Nonnull
public String toString()

Overrides:

toString in class Object

equals

public boolean equals(@Nullable
 Object object)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getHttpMethod

@Nullable
public HttpMethod getHttpMethod()

The HTTP method for this request.

Returns:

the HTTP method

getOrigin

@Nonnull
public String getOrigin()

The HTTP Origin header value for this request.

Returns:

the header value