com.atlassian.plugins.rest.cors

Class SimpleCorsDefaults

java.lang.Object

com.atlassian.plugins.rest.cors.SimpleCorsDefaults

All Implemented Interfaces:

CorsDefaults

public class SimpleCorsDefaults
extends Object
implements CorsDefaults

A basic implementation of CorsDefaults purely for testing purposes. This is not published by the REST module.

Field Summary

Fields

Modifier and Type	Field and Description
static String	CREDENTIALS
static String	NO_CREDENTIALS

Constructor Summary

Constructors

Constructor and Description
SimpleCorsDefaults()

Method Summary

Modifier and Type	Method and Description
boolean	allowsCredentials(String uri) Given an origin which has already passed an CorsDefaults.allowsOrigin(String) check, tests that origin to determine if it is whitelisted for making a credentialed CORS request, on behalf of a specific user.
boolean	allowsOrigin(String uri) Tests the provided origin to determine if it is whitelisted for making non-credentialed CORS requests.
Set<String>	getAllowedRequestHeaders(String uri) For the provided origin, returns a set of HTTP headers which the browser may include when making a request.
Set<String>	getAllowedResponseHeaders(String uri) For the provided origin, returns a set of HTTP headers which the browser's CORS support can forward on to the underlying request.

Methods inherited from class java.lang.Object

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

Field Detail

CREDENTIALS

public static final String CREDENTIALS

See Also:

Constant Field Values

NO_CREDENTIALS

public static final String NO_CREDENTIALS

See Also:

Constant Field Values

Constructor Detail

SimpleCorsDefaults

public SimpleCorsDefaults()

Method Detail

allowsCredentials

public boolean allowsCredentials(String uri)
                          throws IllegalArgumentException

Description copied from interface: CorsDefaults

Given an origin which has already passed an CorsDefaults.allowsOrigin(String) check, tests that origin to determine if it is whitelisted for making a credentialed CORS request, on behalf of a specific user.

Specified by:

allowsCredentials in interface CorsDefaults

Parameters:

uri - The origin that has already been allowed. Will never be null

Returns:

True if the origin allows origin requests that contain credentials such as cookies or HTTP auth

Throws:

IllegalArgumentException - Thrown if the uri is not a valid origin or is null.

allowsOrigin

public boolean allowsOrigin(String uri)

Description copied from interface: CorsDefaults

Tests the provided origin to determine if it is whitelisted for making non-credentialed CORS requests.

Specified by:

allowsOrigin in interface CorsDefaults

Parameters:

uri - The origin. Will never be null

Returns:

True if the origin provided matches any values in the whitelist

getAllowedRequestHeaders

public Set<String> getAllowedRequestHeaders(String uri)

Description copied from interface: CorsDefaults

For the provided origin, returns a set of HTTP headers which the browser may include when making a request. These headers are only relevant for a CORS preflight check, which is made for non-simple HTTP requests.

Specified by:

getAllowedRequestHeaders in interface CorsDefaults

Parameters:

uri - the origin that has already been allowed. Will never be null

Returns:

set of allowed non-simple (see spec) HTTP headers. Must not be null

See Also:

CorsHeaders.ACCESS_CONTROL_ALLOW_HEADERS

getAllowedResponseHeaders

public Set<String> getAllowedResponseHeaders(String uri)

Description copied from interface: CorsDefaults

For the provided origin, returns a set of HTTP headers which the browser's CORS support can forward on to the underlying request. For resources accessed via CORS which have non-simple headers they return, only those headers which are allowed this set will actually be exposed by the browser after the request completes. These headers are only relevant for simple HTTP requests, which do not require a CORS preflight check.

Specified by:

getAllowedResponseHeaders in interface CorsDefaults

Parameters:

uri - the origin that has already been allowed. Will never be null

Returns:

set of allowed simple (see spec) HTTP headers. Must not be null

See Also:

CorsHeaders.ACCESS_CONTROL_EXPOSE_HEADERS