org.trellisldp.http

Class CrossOriginResourceSharingFilter

java.lang.Object

org.trellisldp.http.CrossOriginResourceSharingFilter

All Implemented Interfaces:

ContainerResponseFilter

@Provider
public class CrossOriginResourceSharingFilter
extends Object
implements ContainerResponseFilter

A ContainerResponseFilter that adds CORS-related headers to HTTP responses.

See Also:

Cross-Origin Resource Sharing

Field Summary

Fields

Modifier and Type	Field and Description
static String	CONFIG_HTTP_CORS_ALLOW_CREDENTIALS The configuration key controlling the CORS -Allow-Credentials header.
static String	CONFIG_HTTP_CORS_ALLOW_HEADERS The configuration key controlling the CORS -Allow-Headers header.
static String	CONFIG_HTTP_CORS_ALLOW_METHODS The configuration key controlling the CORS -Allow-Methods header.
static String	CONFIG_HTTP_CORS_ALLOW_ORIGIN The configuration key controlling the CORS -Allow-Origin header.
static String	CONFIG_HTTP_CORS_EXPOSE_HEADERS The configuration key controlling the CORS -Expose-Headers header.
static String	CONFIG_HTTP_CORS_MAX_AGE The configuration key controlling the CORS -Max-Age header.

Constructor Summary

Constructors

Constructor and Description
CrossOriginResourceSharingFilter() Create a CORS filter with default values.
CrossOriginResourceSharingFilter(Collection<String> origins, Collection<String> allowedMethods, Collection<String> allowedHeaders, Collection<String> exposedHeaders, boolean credentials, int cacheSeconds) Create a CORS filter.

Method Summary

Modifier and Type	Method and Description
void	filter(ContainerRequestContext req, ContainerResponseContext res)

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CONFIG_HTTP_CORS_ALLOW_ORIGIN

public static final String CONFIG_HTTP_CORS_ALLOW_ORIGIN

The configuration key controlling the CORS -Allow-Origin header.

See Also:

Constant Field Values

CONFIG_HTTP_CORS_ALLOW_METHODS

public static final String CONFIG_HTTP_CORS_ALLOW_METHODS

The configuration key controlling the CORS -Allow-Methods header.

See Also:

Constant Field Values

CONFIG_HTTP_CORS_ALLOW_HEADERS

public static final String CONFIG_HTTP_CORS_ALLOW_HEADERS

The configuration key controlling the CORS -Allow-Headers header.

See Also:

Constant Field Values

CONFIG_HTTP_CORS_EXPOSE_HEADERS

public static final String CONFIG_HTTP_CORS_EXPOSE_HEADERS

The configuration key controlling the CORS -Expose-Headers header.

See Also:

Constant Field Values

CONFIG_HTTP_CORS_ALLOW_CREDENTIALS

public static final String CONFIG_HTTP_CORS_ALLOW_CREDENTIALS

The configuration key controlling the CORS -Allow-Credentials header.

See Also:

Constant Field Values

CONFIG_HTTP_CORS_MAX_AGE

public static final String CONFIG_HTTP_CORS_MAX_AGE

The configuration key controlling the CORS -Max-Age header.

See Also:

Constant Field Values

Constructor Detail

CrossOriginResourceSharingFilter

@Inject
public CrossOriginResourceSharingFilter()

Create a CORS filter with default values.

CrossOriginResourceSharingFilter

public CrossOriginResourceSharingFilter(Collection<String> origins,
                                        Collection<String> allowedMethods,
                                        Collection<String> allowedHeaders,
                                        Collection<String> exposedHeaders,
                                        boolean credentials,
                                        int cacheSeconds)

Create a CORS filter.

Parameters:

origins - a collection of allowed origin values

allowedMethods - a collection of allowed methods

allowedHeaders - a collection of allowed headers

exposedHeaders - a collection of exposed headers

credentials - true if the Access-Control-Allow-Credentials header is to be set

cacheSeconds - set this to a value greater than zero to set the Access-Control-Max-Age header

Method Detail

filter

public void filter(ContainerRequestContext req,
                   ContainerResponseContext res)

Specified by:

filter in interface ContainerResponseFilter