Package org.identityconnectors.framework.spi

Class AbstractConfiguration

java.lang.Object

org.identityconnectors.framework.spi.AbstractConfiguration

All Implemented Interfaces:

Configuration

Direct Known Subclasses:

AbstractScriptedConfiguration, TstConnectorConfig

public abstract class AbstractConfiguration
extends Object
implements Configuration

Convenient base-class for Configuration objects to extend.

Constructor Summary

Constructors

Constructor	Description
AbstractConfiguration()

Method Summary

Modifier and Type	Method	Description
final ConnectorMessages	getConnectorMessages()	Should return the message catalog that is set by Configuration.setConnectorMessages(ConnectorMessages).
final void	setConnectorMessages(ConnectorMessages messages)	Sets the message catalog instance that allows the Connector to localize messages.
abstract void	validate()	Determines if the configuration is valid.

Methods inherited from class java.lang.Object

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

Constructor Details

AbstractConfiguration

public AbstractConfiguration()

Method Details

getConnectorMessages

public final ConnectorMessages getConnectorMessages()

Description copied from interface: Configuration

Should return the message catalog that is set by Configuration.setConnectorMessages(ConnectorMessages).

Specified by:

getConnectorMessages in interface Configuration

Returns:

the ConnectorMessages instance.

setConnectorMessages

public final void setConnectorMessages(ConnectorMessages messages)

Description copied from interface: Configuration

Sets the message catalog instance that allows the Connector to localize messages. This method is called before any bean property setter, the Configuration.validate() method or the Configuration.getConnectorMessages() method.

Specified by:

setConnectorMessages in interface Configuration

Parameters:

messages - the message catalog.

validate

public abstract void validate()

Description copied from interface: Configuration

Determines if the configuration is valid.

A valid configuration is one that is ready to be used by the connector: it is complete (all the required properties have been given values) and the property values are well-formed (are in the expected range, have the expected format, etc.)

Implementations of this method should not connect to the resource in an attempt to validate the configuration. For example, implementations should not attempt to check that a host of the specified name exists by making a connection to it. Such checks can be performed in the implementation of the TestOp.test() method.

Specified by:

validate in interface Configuration