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

Interface ConnectorConfiguration

All Superinterfaces:

org.identityconnectors.framework.spi.Configuration

All Known Implementing Classes:

BaseConnectorConfiguration

public interface ConnectorConfiguration
extends org.identityconnectors.framework.spi.Configuration

Architectural interface used to wrap ConnId's Configuration interface, which the BaseConnectorConfiguration implements.

Method Summary

Modifier and Type	Method	Description
String	getCredentialAccessToken()
default Map<String,String>	getExtraJWTClaimData()
String	getName()	Get the connector configuration name
default OAuth2AccessTokenContainer	getOauth2Information()
String	getProperty(ConnectorProperty propertyIn)	Get connector configuration property value
String	getProperty(String input)	Get connector configuration property value
boolean	isValidated()	Get whether of not the connector has already been validated
void	setCredentialAccessToken(String token)
default void	setOauth2Information(OAuth2AccessTokenContainer oauth2Information)
void	setProperty(String key, String value)	Set a connector configuration property value
void	setup()	The validate method should load all applicable configuration input (input file(s), properties, etc.).
default void	validate()
void	validateConfiguration()	Validate all configuration input.

Methods inherited from interface org.identityconnectors.framework.spi.Configuration

getConnectorMessages, setConnectorMessages

Method Details

getProperty

String getProperty(ConnectorProperty propertyIn)

Get connector configuration property value

Returns:

String containing configuration value for input property

getProperty

String getProperty(String input)

Get connector configuration property value

Returns:

String containing configuration value for input property

setProperty

void setProperty(String key, String value)

Set a connector configuration property value

Parameters:

key - Configuration property name to set

value - Configuration property value to set

getName

String getName()

Get the connector configuration name

Returns:

String containing a name representation for this connector's configuration

isValidated

boolean isValidated()

Get whether of not the connector has already been validated

Returns:

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

setup

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

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.

Throws:

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

validateConfiguration

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

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

Throws:

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

getCredentialAccessToken

String getCredentialAccessToken()

setCredentialAccessToken

void setCredentialAccessToken(String token)

getOauth2Information

default OAuth2AccessTokenContainer getOauth2Information()

setOauth2Information

default void setOauth2Information(OAuth2AccessTokenContainer oauth2Information)

getExtraJWTClaimData

default Map<String,String> getExtraJWTClaimData()

validate

default void validate()

Specified by:

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