org.symphonyoss.symphony.clients

Class AuthenticationClient

java.lang.Object

org.symphonyoss.symphony.clients.AuthenticationClient

public class AuthenticationClient
extends java.lang.Object

Authentication client to support retrieval of session, key tokens.

Tokens are used by most REST API endpoint calls to validate access.

Constructor Summary

Constructors

Constructor and Description
AuthenticationClient(java.lang.String sessionUrl, java.lang.String keyUrl) Construct client implementation with session and key endpoints
AuthenticationClient(java.lang.String sessionUrl, java.lang.String keyUrl, javax.ws.rs.client.Client httpClient) Construct client implementation with session and key endpoints with overridden HTTP client
AuthenticationClient(java.lang.String sessionUrl, java.lang.String keyUrl, javax.ws.rs.client.Client httpClientForSessionToken, javax.ws.rs.client.Client httpClientForKeyToken) Construct client implementation with session and key endpoints with two different overridden HTTP clients for session-token and key-token

Method Summary

Modifier and Type	Method and Description
SymAuth	authenticate() Authenticate and return session and key tokens encapsulated in SymAuth object.
SymExtensionAppAuth	authenticateExtensionApp(java.lang.String appToken) Authentication call for Extensions API Applications.
org.symphonyoss.symphony.authenticator.model.Token	getKeyToken()
org.symphonyoss.symphony.authenticator.model.Token	getSessionToken()
boolean	isLoggedIn()
void	sessionLogout(SymAuth symAuth) Logout from an existing session
void	setKeystores(java.lang.String serverTruststore, java.lang.String truststorePass, java.lang.String clientKeystore, java.lang.String keystorePass) Force registration of certificate stores
void	setKeyToken(org.symphonyoss.symphony.authenticator.model.Token keyToken)
void	setSessionToken(org.symphonyoss.symphony.authenticator.model.Token sessionToken)

Methods inherited from class java.lang.Object

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

Constructor Detail

AuthenticationClient

public AuthenticationClient(java.lang.String sessionUrl,
                            java.lang.String keyUrl)

Construct client implementation with session and key endpoints

Parameters:

sessionUrl - Session Service URL base endpoint

keyUrl - Key Service URL base endpoint

AuthenticationClient

public AuthenticationClient(java.lang.String sessionUrl,
                            java.lang.String keyUrl,
                            javax.ws.rs.client.Client httpClient)

Construct client implementation with session and key endpoints with overridden HTTP client

Parameters:

sessionUrl - Session Service URL base endpoint

keyUrl - Key Service URL base endpoint

httpClient - Http Client to use when communicating to the Session/Key endpoints.

AuthenticationClient

public AuthenticationClient(java.lang.String sessionUrl,
                            java.lang.String keyUrl,
                            javax.ws.rs.client.Client httpClientForSessionToken,
                            javax.ws.rs.client.Client httpClientForKeyToken)

Construct client implementation with session and key endpoints with two different overridden HTTP clients for session-token and key-token

Parameters:

sessionUrl - Session Service URL base endpoint

keyUrl - Key Service URL base endpoint

httpClientForSessionToken - Http Client to use when communicating to the session-token endpoint

httpClientForKeyToken - Http Client to use when communicating to the key-token endpoint

Method Detail

authenticate

public SymAuth authenticate()
                     throws AuthenticationException

Authenticate and return session and key tokens encapsulated in SymAuth object.

Returns:

SymAuth object containing session and key tokens.

Throws:

AuthenticationException - Exception generated from underlying REST API calls.

sessionLogout

public void sessionLogout(SymAuth symAuth)
                   throws AuthenticationException

Logout from an existing session

Parameters:

symAuth - SymAuth object containing session token to logout

Throws:

AuthenticationException - Exception generated from underlying REST API calls.

authenticateExtensionApp

public SymExtensionAppAuth authenticateExtensionApp(java.lang.String appToken)
                                             throws AuthenticationException

Authentication call for Extensions API Applications. Returns

Parameters:

appToken - Arbitrary application token to assign session.

Returns:

SymExtensionAppAuth object containing session token and application ID.

Throws:

AuthenticationException - Exception generated from underlying REST API calls.

setKeystores

public void setKeystores(java.lang.String serverTruststore,
                         java.lang.String truststorePass,
                         java.lang.String clientKeystore,
                         java.lang.String keystorePass)

Force registration of certificate stores

Parameters:

serverTruststore - Truststore file containing root and chain certs

truststorePass - Truststore password

clientKeystore - Client certificate keystore (P12) containing CN= bot user name

keystorePass - Client keystore password

isLoggedIn

public boolean isLoggedIn()

getKeyToken

public org.symphonyoss.symphony.authenticator.model.Token getKeyToken()

setKeyToken

public void setKeyToken(org.symphonyoss.symphony.authenticator.model.Token keyToken)

getSessionToken

public org.symphonyoss.symphony.authenticator.model.Token getSessionToken()

setSessionToken

public void setSessionToken(org.symphonyoss.symphony.authenticator.model.Token sessionToken)