Package com.exclamationlabs.connid.base.connector.authenticator

Class OAuth2TokenRefreshTokenAuthenticator

java.lang.Object

com.exclamationlabs.connid.base.connector.authenticator.AbstractOAuth2TokenAuthenticator

com.exclamationlabs.connid.base.connector.authenticator.OAuth2TokenRefreshTokenAuthenticator

All Implemented Interfaces:

Authenticator

public class OAuth2TokenRefreshTokenAuthenticator
extends AbstractOAuth2TokenAuthenticator

This implementation performs the OAuth2 "refresh_token" grant type.

Field Summary

Fields

Modifier and Type	Field	Description
protected static com.google.gson.GsonBuilder	gsonBuilder

Constructor Summary

Constructors

Constructor	Description
OAuth2TokenRefreshTokenAuthenticator()

Method Summary

Modifier and Type	Method	Description
String	authenticate(ConnectorConfiguration configuration)	Perform all required authentication needed for this connector.
protected org.apache.http.client.HttpClient	createClient()
Set<ConnectorProperty>	getRequiredPropertyNames()	Returns the names of the properties for properties that must be present in order for this Authenticator to function.

Methods inherited from class com.exclamationlabs.connid.base.connector.authenticator.AbstractOAuth2TokenAuthenticator

executeRequest, initializeForHttp

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.exclamationlabs.connid.base.connector.authenticator.Authenticator

getAdditionalAuthenticationHeaders

Field Details

gsonBuilder

protected static com.google.gson.GsonBuilder gsonBuilder

Constructor Details

OAuth2TokenRefreshTokenAuthenticator

public OAuth2TokenRefreshTokenAuthenticator()

Method Details

getRequiredPropertyNames

public Set<ConnectorProperty> getRequiredPropertyNames()

Description copied from interface: Authenticator

Returns the names of the properties for properties that must be present in order for this Authenticator to function. This method should return the required property names for any sub-authenticators or key loaders that it uses.

Returns:

Set containing property names, represented as a set of enum values. Returning null or an empty set is also allowed if there are no properties for this driver.

authenticate

public String authenticate(ConnectorConfiguration configuration) throws org.identityconnectors.framework.common.exceptions.ConnectorSecurityException

Description copied from interface: Authenticator

Perform all required authentication needed for this connector.

Parameters:

configuration - The configuration object respective to this connector

Returns:

String containing an access token or other value produced as a result of authentication. In some implementations this could return a String flag of some kind or null if authenticator has no meaningful output or actual authentication.

Throws:

org.identityconnectors.framework.common.exceptions.ConnectorSecurityException - if could not authenticate or permissions was denied

createClient

protected org.apache.http.client.HttpClient createClient()