Package io.muserver.rest

Class CORSConfig

java.lang.Object

io.muserver.rest.CORSConfig

public class CORSConfig
extends java.lang.Object

CORS configuration for REST resources. Create this using CORSConfigBuilder.corsConfig()

Field Summary

Fields

Modifier and Type	Field	Description
boolean	allowCredentials	Deprecated. use allowCredentials() instead
java.util.Collection<java.lang.String>	allowedHeaders	Deprecated. use allowedHeaders() instead
java.util.List<java.util.regex.Pattern>	allowedOriginRegex	Deprecated. use allowedOriginRegex() instead
java.util.Collection<java.lang.String>	allowedOrigins	Deprecated. use allowedOrigins() instead
java.util.Collection<java.lang.String>	exposedHeaders	Deprecated. use exposedHeaders() instead
long	maxAge	Deprecated. use maxAge() instead

Method Summary

Modifier and Type	Method	Description
boolean	allowCredentials()
java.util.Collection<java.lang.String>	allowedHeaders()
java.util.List<java.util.regex.Pattern>	allowedOriginRegex()
java.util.Collection<java.lang.String>	allowedOrigins()
boolean	equals(java.lang.Object o)
java.util.Collection<java.lang.String>	exposedHeaders()
int	hashCode()
long	maxAge()
java.lang.String	toString()
boolean	writeHeaders(MuRequest request, MuResponse response, java.util.Set<Method> allowedMethods)	Adds CORS headers to the response, if needed.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

allowCredentials

@Deprecated
public final boolean allowCredentials

Deprecated.

use allowCredentials() instead

allowedOrigins

@Deprecated
public final java.util.Collection<java.lang.String> allowedOrigins

Deprecated.

use allowedOrigins() instead

allowedOriginRegex

@Deprecated
public final java.util.List<java.util.regex.Pattern> allowedOriginRegex

Deprecated.

use allowedOriginRegex() instead

exposedHeaders

@Deprecated
public final java.util.Collection<java.lang.String> exposedHeaders

Deprecated.

use exposedHeaders() instead

maxAge

@Deprecated
public final long maxAge

Deprecated.

use maxAge() instead

allowedHeaders

@Deprecated
public final java.util.Collection<java.lang.String> allowedHeaders

Deprecated.

use allowedHeaders() instead

Method Detail

writeHeaders

public boolean writeHeaders(MuRequest request,
                            MuResponse response,
                            java.util.Set<Method> allowedMethods)

Adds CORS headers to the response, if needed.

Parameters:

request - The request

response - The response to add headers to

allowedMethods - The methods

Returns:

Returns true if any Access Control headers were added; otherwise false. (Note: the Vary: origin header is always added.

allowCredentials

public boolean allowCredentials()

Returns:

the value described by CORSConfigBuilder.withAllowCredentials(boolean)

allowedOrigins

public java.util.Collection<java.lang.String> allowedOrigins()

Returns:

the value described by CORSConfigBuilder.withAllowedOrigins(java.util.Collection<java.lang.String>)

allowedOriginRegex

public java.util.List<java.util.regex.Pattern> allowedOriginRegex()

Returns:

the value described by CORSConfigBuilder.withAllowedOriginRegex(java.util.regex.Pattern)

exposedHeaders

public java.util.Collection<java.lang.String> exposedHeaders()

Returns:

the value described by CORSConfigBuilder.withExposedHeaders(java.lang.String...)

maxAge

public long maxAge()

Returns:

the value described by CORSConfigBuilder.withMaxAge(long)

allowedHeaders

public java.util.Collection<java.lang.String> allowedHeaders()

Returns:

the value described by CORSConfigBuilder.withAllowedHeaders(java.lang.String...)

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object