org.identityconnectors.framework.api

Interface ConnectorInfo

All Known Implementing Classes:

AbstractConnectorInfo, LocalConnectorInfoImpl, RemoteConnectorInfoImpl

public interface ConnectorInfo

The connector meta-data for a given connector.

Method Summary

Modifier and Type	Method and Description
APIConfiguration	createDefaultAPIConfiguration() Loads the Connector and Configuration class in order to determine the proper default configuration parameters.
String	getConnectorCategory() Get the category this connector belongs to.
String	getConnectorDisplayName() Returns a friendly name suitable for display in the UI.
ConnectorKey	getConnectorKey() Uniquely identifies this connector in a given installation.
ConnectorMessages	getMessages() Returns the connector messages for this connector.

Method Detail

getConnectorDisplayName

String getConnectorDisplayName()

Returns a friendly name suitable for display in the UI. The name will be localized using the CurrentLocale.

Returns:

The friendly name

getMessages

ConnectorMessages getMessages()

Returns the connector messages for this connector.

Returns:

The connector messages for this connector.

getConnectorCategory

String getConnectorCategory()

Get the category this connector belongs to.

Returns:

category name.

getConnectorKey

ConnectorKey getConnectorKey()

Uniquely identifies this connector in a given installation.

Returns:

The connector key

createDefaultAPIConfiguration

APIConfiguration createDefaultAPIConfiguration()

Loads the Connector and Configuration class in order to determine the proper default configuration parameters.