Class CorsResponse

java.lang.Object

com.soklet.CorsResponse

@ThreadSafe
public final class CorsResponse
extends Object

Response headers to send over the wire for non-preflight CORS 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	CorsResponse.Builder	Builder used to construct instances of CorsResponse via withAccessControlAllowOrigin(String).
static final class	CorsResponse.Copier	Builder used to copy instances of CorsResponse via copy().

Method Summary

Modifier and Type	Method	Description
CorsResponse.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.
String	getAccessControlAllowOrigin()	Value for the Access-Control-Allow-Origin response header.
Set<String>	getAccessControlExposeHeaders()	Value for the Access-Control-Expose-Headers response header.
int	hashCode()
String	toString()
static CorsResponse.Builder	withAccessControlAllowOrigin(String accessControlAllowOrigin)	Acquires a builder for CorsResponse instances.

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Method Details

withAccessControlAllowOrigin

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

Acquires a builder for CorsResponse instances.

Parameters:

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

Returns:

the builder

copy

@Nonnull
public CorsResponse.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

getAccessControlExposeHeaders

@Nonnull
public Set<String> getAccessControlExposeHeaders()

Value for the Access-Control-Expose-Headers response header.

Returns:

the header value