Class CorsPreflight

java.lang.Object

com.soklet.CorsPreflight

@ThreadSafe
public final class CorsPreflight
extends Object

Encapsulates CORS preflight-related HTTP request data.

Instances can be acquired via these factory methods:

• with(String, HttpMethod) (uses Origin and Access-Control-Request-Method header values)
• with(String, HttpMethod, Set) (uses Origin, Access-Control-Request-Method, and Access-Control-Request-Headers header values)
• fromHeaders(Map) (parses raw headers)

Data for non-preflight CORS requests is represented by Cors.

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<CorsPreflight>	fromHeaders(Map<String, Set<String>> headers)	Extracts a CORS preflight request representation from the given HTTP request data.
Set<String>	getAccessControlRequestHeaders()	Returns the set of values for the HTTP Access-Control-Request-Headers request header.
HttpMethod	getAccessControlRequestMethod()	The HTTP Access-Control-Request-Method request header value.
String	getOrigin()	Returns the HTTP Origin request header value.
int	hashCode()
String	toString()
static CorsPreflight	with(String origin, HttpMethod accessControlRequestMethod)	Acquires a CORS preflight request representation for the given HTTP request data.
static CorsPreflight	with(String origin, HttpMethod accessControlRequestMethod, Set<String> accessControlRequestHeaders)	Acquires a CORS preflight request representation for the given HTTP request data.

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Method Details

with

@Nonnull
public static CorsPreflight with(@Nonnull
 String origin,
 @Nonnull
 HttpMethod accessControlRequestMethod)

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

CORS preflight requests always have method OPTIONS and specify their target method via the Access-Control-Request-Method header value.

Parameters:

origin - HTTP Origin request header value

accessControlRequestMethod - HTTP Access-Control-Request-Method request header value

Returns:

a CorsPreflight instance

with

@Nonnull
public static CorsPreflight with(@Nonnull
 String origin,
 @Nonnull
 HttpMethod accessControlRequestMethod,
 @Nullable
 Set<String> accessControlRequestHeaders)

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

CORS preflight requests always have method OPTIONS and specify their target method via the Access-Control-Request-Method request value.

Parameters:

origin - HTTP Origin request header value

accessControlRequestMethod - HTTP Access-Control-Request-Method request header value

accessControlRequestHeaders - the optional set of HTTP Access-Control-Request-Headers request header values

Returns:

a CorsPreflight instance

fromHeaders

@Nonnull
public static Optional<CorsPreflight> fromHeaders(@Nonnull
 Map<String, Set<String>> headers)

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

Note that only HTTP OPTIONS requests qualify to be CORS preflight requests.

Parameters:

headers - the request headers

Returns:

the CORS preflight data for this request, or Optional.empty() if insufficient 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

getOrigin

@Nonnull
public String getOrigin()

Returns the HTTP Origin request header value.

Returns:

the header value

getAccessControlRequestMethod

@Nonnull
public HttpMethod getAccessControlRequestMethod()

The HTTP Access-Control-Request-Method request header value.

Returns:

the header value

getAccessControlRequestHeaders

@Nonnull
public Set<String> getAccessControlRequestHeaders()

Returns the set of values for the HTTP Access-Control-Request-Headers request header.

Returns:

the set of header values, or the empty set if not present