Package com.symphony.bdk.core.auth.impl

Class AbstractCustomAuthenticator

java.lang.Object

com.symphony.bdk.core.auth.impl.AbstractCustomAuthenticator

All Implemented Interfaces:

CustomEnhancedAuthAuthenticator

@API(status=EXPERIMENTAL)
public abstract class AbstractCustomAuthenticator
extends Object
implements CustomEnhancedAuthAuthenticator

Constructor Summary

Constructors

Constructor	Description
AbstractCustomAuthenticator(com.symphony.bdk.core.config.model.BdkConfig bdkConfig)

Method Summary

Modifier and Type	Method	Description
String	authenticate()	Authenticates.
protected abstract String	doRetrieveToken()	map custom auth request failure exception to ApiException

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.symphony.bdk.core.auth.CustomEnhancedAuthAuthenticator

isAuthTokenExpired

Constructor Details

AbstractCustomAuthenticator

public AbstractCustomAuthenticator(com.symphony.bdk.core.config.model.BdkConfig bdkConfig)

Method Details

authenticate

@Nonnull
public String authenticate()
                    throws AuthUnauthorizedException

Description copied from interface: CustomEnhancedAuthAuthenticator

Authenticates.

Specified by:

authenticate in interface CustomEnhancedAuthAuthenticator

Returns:

the authentication session.

Throws:

AuthUnauthorizedException

doRetrieveToken

@Nonnull
protected abstract String doRetrieveToken()
                                   throws com.symphony.bdk.http.api.ApiException

map custom auth request failure exception to ApiException

Returns:

Throws:

com.symphony.bdk.http.api.ApiException