org.apache.chemistry.opencmis.client.bindings.spi

Class StandardAuthenticationProvider

java.lang.Object

org.apache.chemistry.opencmis.client.bindings.spi.AbstractAuthenticationProvider

org.apache.chemistry.opencmis.client.bindings.spi.StandardAuthenticationProvider

All Implemented Interfaces:

Serializable, SessionAwareAuthenticationProvider, AuthenticationProvider

Direct Known Subclasses:

LTPAWSSecurityAuthenticationProvider, OAuthAuthenticationProvider

public class StandardAuthenticationProvider
extends AbstractAuthenticationProvider

Standard authentication provider class. Adds a basic authentication HTTP header and a WS-Security UsernameToken SOAP header.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	WSSE_NAMESPACE
protected static String	WSU_NAMESPACE

Constructor Summary

Constructors

Constructor and Description
StandardAuthenticationProvider()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addSessionParameterHeadersToFixedHeaders() Adds the SessionParameter.HEADER to the fixed headers.
protected List<String>	createBasicAuthHeaderValue(String username, String password) Creates a basic authentication header value from a username and a password.
protected Map<String,List<String>>	getFixedHeaders() Returns the HTTP headers that are sent with all requests.
protected boolean	getHandleCookies() Returns if the authentication provider should handle cookies.
Map<String,List<String>>	getHTTPHeaders(String url) Returns a set of HTTP headers (key-value pairs) that should be added to a HTTP call.
protected boolean	getSendBasicAuth() Returns if a HTTP Basic Authentication header should be sent.
protected boolean	getSendBearerToken() Returns if an OAuth Bearer token header should be sent.
protected boolean	getSendUsernameToken() Returns if a UsernameToken should be sent.
Element	getSOAPHeaders(Object portObject) Returns a SOAP header that should be added to a Web Services call.
protected boolean	isTrue(String parameterName) Returns true if the given parameter exists in the session and is set to true, false otherwise.
void	putResponseHeaders(String url, int statusCode, Map<String,List<String>> headers) Receives the HTTP headers after a call.
void	setSession(BindingSession session) Sets the BindingSession the authentication provider lives in.

Methods inherited from class org.apache.chemistry.opencmis.client.bindings.spi.AbstractAuthenticationProvider

getBearerToken, getHandlerResolver, getHostnameVerifier, getPassword, getProxyPassword, getProxyUser, getSession, getSSLSocketFactory, getUser

Methods inherited from class java.lang.Object

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

Field Detail

WSSE_NAMESPACE

protected static final String WSSE_NAMESPACE

See Also:

Constant Field Values

WSU_NAMESPACE

protected static final String WSU_NAMESPACE

See Also:

Constant Field Values

Constructor Detail

StandardAuthenticationProvider

public StandardAuthenticationProvider()

Method Detail

setSession

public void setSession(BindingSession session)

Description copied from class: AbstractAuthenticationProvider

Sets the BindingSession the authentication provider lives in.

Specified by:

setSession in interface SessionAwareAuthenticationProvider

Overrides:

setSession in class AbstractAuthenticationProvider

getHTTPHeaders

public Map<String,List<String>> getHTTPHeaders(String url)

Description copied from interface: AuthenticationProvider

Returns a set of HTTP headers (key-value pairs) that should be added to a HTTP call. This will be called by the AtomPub and the Web Services binding. You might want to check the binding in use before you set the headers.

Specified by:

getHTTPHeaders in interface AuthenticationProvider

Overrides:

getHTTPHeaders in class AbstractAuthenticationProvider

Parameters:

url - the URL of the HTTP call

Returns:

the HTTP headers or null if no additional headers should be set

putResponseHeaders

public void putResponseHeaders(String url,
                      int statusCode,
                      Map<String,List<String>> headers)

Description copied from interface: AuthenticationProvider

Receives the HTTP headers after a call.

Specified by:

putResponseHeaders in interface AuthenticationProvider

Overrides:

putResponseHeaders in class AbstractAuthenticationProvider

Parameters:

url - the URL

statusCode - the status code

headers - the HTTP headers

getSOAPHeaders

public Element getSOAPHeaders(Object portObject)

Description copied from interface: AuthenticationProvider

Returns a SOAP header that should be added to a Web Services call.

Specified by:

getSOAPHeaders in interface AuthenticationProvider

Overrides:

getSOAPHeaders in class AbstractAuthenticationProvider

Parameters:

portObject - the port object

Returns:

the SOAP headers or null if no additional headers should be set

getFixedHeaders

protected Map<String,List<String>> getFixedHeaders()

Returns the HTTP headers that are sent with all requests. The returned map is mutable but not synchronized!

addSessionParameterHeadersToFixedHeaders

protected void addSessionParameterHeadersToFixedHeaders()

Adds the SessionParameter.HEADER to the fixed headers. This method should only be called from the setSession(BindingSession) method to avoid threading issues.

createBasicAuthHeaderValue

protected List<String> createBasicAuthHeaderValue(String username,
                                      String password)

Creates a basic authentication header value from a username and a password.

getSendBasicAuth

protected boolean getSendBasicAuth()

Returns if a HTTP Basic Authentication header should be sent. (All bindings.)

getSendBearerToken

protected boolean getSendBearerToken()

Returns if an OAuth Bearer token header should be sent. (All bindings.)

getSendUsernameToken

protected boolean getSendUsernameToken()

Returns if a UsernameToken should be sent. (Web Services binding only.)

getHandleCookies

protected boolean getHandleCookies()

Returns if the authentication provider should handle cookies.

isTrue

protected boolean isTrue(String parameterName)

Returns true if the given parameter exists in the session and is set to true, false otherwise.