Class CorsPreflightResponse

java.lang.Object

com.soklet.CorsPreflightResponse

@ThreadSafe
public final class CorsPreflightResponse
extends Object

Response headers to send over the wire for CORS preflight requests.

Instances can be acquired via the withAccessControlAllowOrigin(String) builder factory method.

See https://www.soklet.com/docs/cors#writing-cors-responses for detailed documentation.

Author:

Mark Allen

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	CorsPreflightResponse.Builder	Builder used to construct instances of CorsPreflightResponse via withAccessControlAllowOrigin(String).
static final class	CorsPreflightResponse.Copier	Builder used to copy instances of CorsPreflightResponse via copy().

Method Summary

Modifier and Type	Method	Description
CorsPreflightResponse.Copier	copy()	Vends a mutable copier seeded with this instance's data, suitable for building new instances.
boolean	equals(Object object)
Optional<Boolean>	getAccessControlAllowCredentials()	Value for the Access-Control-Allow-Credentials response header.
Set<String>	getAccessControlAllowHeaders()	Set of values for the Access-Control-Allow-Headers response header.
Set<HttpMethod>	getAccessControlAllowMethods()	Set of values for the Access-Control-Allow-Methods response header.
String	getAccessControlAllowOrigin()	Value for the Access-Control-Allow-Origin response header.
Optional<Duration>	getAccessControlMaxAge()	Value for the Access-Control-Max-Age response header.
int	hashCode()
String	toString()
static CorsPreflightResponse.Builder	withAccessControlAllowOrigin(String accessControlAllowOrigin)	Acquires a builder for CorsPreflightResponse instances.

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Method Details

withAccessControlAllowOrigin

@Nonnull
public static CorsPreflightResponse.Builder withAccessControlAllowOrigin(@Nonnull
 String accessControlAllowOrigin)

Acquires a builder for CorsPreflightResponse instances.

Parameters:

accessControlAllowOrigin - the required Access-Control-Allow-Origin response header value

Returns:

the builder

copy

@Nonnull
public CorsPreflightResponse.Copier copy()

Vends a mutable copier seeded with this instance's data, suitable for building new instances.

Returns:

a copier for this instance

toString

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

getAccessControlAllowOrigin

@Nonnull
public String getAccessControlAllowOrigin()

Value for the Access-Control-Allow-Origin response header.

Returns:

the header value

getAccessControlAllowCredentials

@Nonnull
public Optional<Boolean> getAccessControlAllowCredentials()

Value for the Access-Control-Allow-Credentials response header.

Returns:

the header value, or Optional.empty() if not specified

getAccessControlMaxAge

@Nonnull
public Optional<Duration> getAccessControlMaxAge()

Value for the Access-Control-Max-Age response header.

Returns:

the header value, or Optional.empty() if not specified

getAccessControlAllowMethods

@Nonnull
public Set<HttpMethod> getAccessControlAllowMethods()

Set of values for the Access-Control-Allow-Methods response header.

Returns:

the header values, or the empty set if not specified

getAccessControlAllowHeaders

@Nonnull
public Set<String> getAccessControlAllowHeaders()

Set of values for the Access-Control-Allow-Headers response header.

Returns:

the header values, or the empty set if not specified