Package com.exclamationlabs.connid.base.connector.configuration

Class BaseConnectorConfiguration

java.lang.Object

com.exclamationlabs.connid.base.connector.configuration.BaseConnectorConfiguration

All Implemented Interfaces:

ConnectorConfiguration, org.identityconnectors.framework.spi.Configuration

public abstract class BaseConnectorConfiguration
extends Object
implements ConnectorConfiguration

All configuration classes in the Base connector framework need to subclass this abstract type. This is an overlay for ConnId's configuration class, which can be confusing and uninviting to use, and we needed something more streamlined.

Constructor Summary

Constructors

Constructor	Description
BaseConnectorConfiguration()
BaseConnectorConfiguration(String configurationName)

Method Summary

Modifier and Type	Method	Description
List<String>	getAdditionalPropertyNames()	Return any non-standard custom configuration property names for a specific connector.
abstract String	getConfigurationFilePath()	Override this method and return a path to configuration file if the configuration for this Connector is file-based (most will be).
org.identityconnectors.framework.common.objects.ConnectorMessages	getConnectorMessages()
String	getCredentialAccessToken()
Map<String,String>	getExtraJWTClaimData()
String	getMidPointConfigurationFilePath()
String	getName()	Get the connector configuration name
OAuth2AccessTokenContainer	getOauth2Information()
String	getProperty(ConnectorProperty propertyIn)	Get connector configuration property value
String	getProperty(String nameIn)	Get connector configuration property value
String	getPropertyFile(ConnectorProperty propertyIn)
Set<ConnectorProperty>	getRequiredPropertyNames()
boolean	isValidated()	Get whether of not the connector has already been validated
void	setConfigurationFilePath(String path)
void	setConnectorMessages(org.identityconnectors.framework.common.objects.ConnectorMessages messages)
protected void	setConnectorProperties(Properties testProperties)	For testing/stubbing or Configuration not loaded from file.
void	setCredentialAccessToken(String credentialAccessToken)
void	setExtraJWTClaimData(Map<String,String> extraJWTClaimData)
void	setMidPointConfigurationFilePath(String inputPath)
void	setOauth2Information(OAuth2AccessTokenContainer oauth2Information)
void	setProperty(String nameIn, String valueIn)	Most often used for testing purposes.
void	setRequiredPropertyNames(Set<ConnectorProperty>... sets)
void	setTestConfiguration()
void	setup()	The validate method should load all applicable configuration input (input file(s), properties, etc.).
void	setValidated()
void	validateConfiguration()	Validate all configuration input.

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.configuration.ConnectorConfiguration

validate

Constructor Details

BaseConnectorConfiguration

public BaseConnectorConfiguration()

BaseConnectorConfiguration

public BaseConnectorConfiguration(String configurationName)

Method Details

setRequiredPropertyNames

@SafeVarargs public final void setRequiredPropertyNames(Set<ConnectorProperty>... sets)

getConfigurationFilePath

public abstract String getConfigurationFilePath()

Override this method and return a path to configuration file if the configuration for this Connector is file-based (most will be).

Returns:

file path/name (relative or absolute) for Connector configuration file

setConfigurationFilePath

public void setConfigurationFilePath(String path)

getName

public String getName()

Description copied from interface: ConnectorConfiguration

Get the connector configuration name

Specified by:

getName in interface ConnectorConfiguration

Returns:

String containing a name representation for this connector's configuration

setValidated

public void setValidated()

isValidated

public boolean isValidated()

Description copied from interface: ConnectorConfiguration

Get whether of not the connector has already been validated

Specified by:

isValidated in interface ConnectorConfiguration

Returns:

true if validation has already been run and was successful, false if it hasn't been attempted.

setup

public void setup() throws org.identityconnectors.framework.common.exceptions.ConfigurationException

Description copied from interface: ConnectorConfiguration

The validate method should load all applicable configuration input (input file(s), properties, etc.). If any problems occur while loading a reliable configuration for this connector, then ConfigurationException should be thrown.

Specified by:

setup in interface ConnectorConfiguration

Throws:

org.identityconnectors.framework.common.exceptions.ConfigurationException - If configuration input could not be loaded or failed validation.

getProperty

public String getProperty(String nameIn)

Description copied from interface: ConnectorConfiguration

Get connector configuration property value

Specified by:

getProperty in interface ConnectorConfiguration

Returns:

String containing configuration value for input property

setProperty

public void setProperty(String nameIn, String valueIn)

Most often used for testing purposes.

Specified by:

setProperty in interface ConnectorConfiguration

Parameters:

nameIn - Name of configuration property to set

valueIn - Configuration value to set

getProperty

public String getProperty(ConnectorProperty propertyIn)

Description copied from interface: ConnectorConfiguration

Get connector configuration property value

Specified by:

getProperty in interface ConnectorConfiguration

Returns:

String containing configuration value for input property

getPropertyFile

public String getPropertyFile(ConnectorProperty propertyIn)

setConnectorProperties

protected void setConnectorProperties(Properties testProperties)

For testing/stubbing or Configuration not loaded from file.

Parameters:

testProperties - Populated Properties object w/ test properties needed

getAdditionalPropertyNames

public List<String> getAdditionalPropertyNames()

Return any non-standard custom configuration property names for a specific connector. This method should be overridden if your connector requires any additional property names loaded from its configuration properties file that aren't already defined in ConnectorProperty enum.

Returns:

List of Strings containing any additional property names than an implementing connector uses.

validateConfiguration

public void validateConfiguration() throws org.identityconnectors.framework.common.exceptions.ConfigurationException

Description copied from interface: ConnectorConfiguration

Validate all configuration input. If any problems occur while validating a reliable configuration for this connector, then ConfigurationException should be thrown.

Specified by:

validateConfiguration in interface ConnectorConfiguration

Throws:

org.identityconnectors.framework.common.exceptions.ConfigurationException - If configuration input could not be loaded or failed validation.

getCredentialAccessToken

public String getCredentialAccessToken()

Specified by:

getCredentialAccessToken in interface ConnectorConfiguration

setCredentialAccessToken

public void setCredentialAccessToken(String credentialAccessToken)

Specified by:

setCredentialAccessToken in interface ConnectorConfiguration

getConnectorMessages

public org.identityconnectors.framework.common.objects.ConnectorMessages getConnectorMessages()

Specified by:

getConnectorMessages in interface org.identityconnectors.framework.spi.Configuration

setConnectorMessages

public void setConnectorMessages(org.identityconnectors.framework.common.objects.ConnectorMessages messages)

Specified by:

setConnectorMessages in interface org.identityconnectors.framework.spi.Configuration

getMidPointConfigurationFilePath

public String getMidPointConfigurationFilePath()

setMidPointConfigurationFilePath

public void setMidPointConfigurationFilePath(String inputPath)

getOauth2Information

public OAuth2AccessTokenContainer getOauth2Information()

Specified by:

getOauth2Information in interface ConnectorConfiguration

setOauth2Information

public void setOauth2Information(OAuth2AccessTokenContainer oauth2Information)

Specified by:

setOauth2Information in interface ConnectorConfiguration

getExtraJWTClaimData

public Map<String,String> getExtraJWTClaimData()

Specified by:

getExtraJWTClaimData in interface ConnectorConfiguration

setExtraJWTClaimData

public void setExtraJWTClaimData(Map<String,String> extraJWTClaimData)

getRequiredPropertyNames

public Set<ConnectorProperty> getRequiredPropertyNames()

setTestConfiguration

public void setTestConfiguration()