Class CorsPreflight

java.lang.Object

com.soklet.core.CorsPreflight

@ThreadSafe
public class CorsPreflight
extends Object

Encapsulates CORS preflight-related HTTP request data.

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

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

Author:

Mark Allen

Constructor Summary

Constructors

Constructor	Description
CorsPreflight(String origin, HttpMethod accessControlRequestMethod)	Constructs a CORS preflight request representation for the given HTTP request data.
CorsPreflight(String origin, HttpMethod accessControlRequestMethod, Set<String> accessControlRequestHeaders)	Constructs a CORS preflight request representation for the given HTTP request data.

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Details

CorsPreflight

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

Constructs 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

CorsPreflight

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

Constructs 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

Method Details

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 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

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