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

Class AbstractAuthenticationProvider

java.lang.Object

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

All Implemented Interfaces:

Serializable, SessionAwareAuthenticationProvider, AuthenticationProvider

Direct Known Subclasses:

NTLMAuthenticationProvider, StandardAuthenticationProvider

public abstract class AbstractAuthenticationProvider
extends Object
implements SessionAwareAuthenticationProvider

Authentication provider class.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
AbstractAuthenticationProvider()

Method Summary

Methods

Modifier and Type	Method and Description
protected String	getBearerToken() Gets the bearer token from the session.
HandlerResolver	getHandlerResolver() Returns a HandlerResolver object that provides a list of SOAP handlers.
HostnameVerifier	getHostnameVerifier() Returns the Hostname Verifier for HTTPS connections.
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 String	getPassword() Gets the password from the session.
protected String	getProxyPassword() Gets the proxy password from the session.
protected String	getProxyUser() Gets the proxy user name from the session.
BindingSession	getSession() Returns BindingSession.
Element	getSOAPHeaders(Object portObject) Returns a SOAP header that should be added to a Web Services call.
SSLSocketFactory	getSSLSocketFactory() Returns the SSL Socket Factory to be used when creating sockets for HTTPS connections.
protected String	getUser() Gets the user name from the session.
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 java.lang.Object

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

Constructor Detail

AbstractAuthenticationProvider

public AbstractAuthenticationProvider()

Method Detail

setSession

public void setSession(BindingSession session)

Sets the BindingSession the authentication provider lives in.

Specified by:

setSession in interface SessionAwareAuthenticationProvider

getSession

public BindingSession getSession()

Returns BindingSession.

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

Parameters:

url - the URL of the HTTP call

Returns:

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

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

Parameters:

portObject - the port object

Returns:

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

getHandlerResolver

public HandlerResolver getHandlerResolver()

Description copied from interface: AuthenticationProvider

Returns a HandlerResolver object that provides a list of SOAP handlers.

Specified by:

getHandlerResolver in interface AuthenticationProvider

Returns:

the HandlerResolver or null if no handlers 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

Parameters:

url - the URL

statusCode - the status code

headers - the HTTP headers

getSSLSocketFactory

public SSLSocketFactory getSSLSocketFactory()

Description copied from interface: AuthenticationProvider

Returns the SSL Socket Factory to be used when creating sockets for HTTPS connections.

Specified by:

getSSLSocketFactory in interface AuthenticationProvider

Returns:

a SSLSocketFactory or null

getHostnameVerifier

public HostnameVerifier getHostnameVerifier()

Description copied from interface: AuthenticationProvider

Returns the Hostname Verifier for HTTPS connections.

Specified by:

getHostnameVerifier in interface AuthenticationProvider

Returns:

a HostnameVerifier or null

getUser

protected String getUser()

Gets the user name from the session.

Returns:

the user name or null if the user name is not set

getPassword

protected String getPassword()

Gets the password from the session.

Returns:

the password or null if the password is not set

getBearerToken

protected String getBearerToken()

Gets the bearer token from the session.

Returns:

the bearer token or null if the token is not set

getProxyUser

protected String getProxyUser()

Gets the proxy user name from the session.

Returns:

the proxy user name or null if the user name is not set

getProxyPassword

protected String getProxyPassword()

Gets the proxy password from the session.

Returns:

the proxy password or null if the password is not set