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

Class DefaultAuthenticator

java.lang.Object

com.exclamationlabs.connid.base.connector.authenticator.DefaultAuthenticator

All Implemented Interfaces:

Authenticator

public class DefaultAuthenticator
extends Object
implements Authenticator

Internal do-nothing Authenticator which is used if a connector does not specify an authenticator using setAuthenticator() in its constructor.

Constructor Summary

Constructors

Constructor	Description
DefaultAuthenticator()

Method Summary

Modifier and Type	Method	Description
String	authenticate(ConnectorConfiguration configuration)	Perform all required authentication needed for this connector.
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 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

Constructor Details

DefaultAuthenticator

public DefaultAuthenticator()

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.

Specified by:

getRequiredPropertyNames in interface Authenticator

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.

Specified by:

authenticate in interface Authenticator

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