com.adobe.idp.dsc.registry.connector
Interface ConnectorRegistry

All Known Implementing Classes:

ConnectorRegistryClient

public interface ConnectorRegistry

Enables the creation of a Java object that provides the ability to perform tasks such as querying information about supported connectors. A connector enables an endpoint to invoke a service using various invocation methods. For example, an Email connector enables an endpoint to invoke a service using email messages.

Field Summary

static java.lang.String

SERVICE_ID Represents the service identifier value.

Method Summary

Connector	create(Connector aConnector) Creates a new connector.
Connector	getConnector(java.lang.String aConnectorId) Retrieves a connector that corresponds to the specified identifier value.
java.util.List	getConnectors() Returns a list of supported connectors defined in the service container.
Endpoint	getEndpointDefinition(java.lang.String connectorId) Retrieves the endpoint definition that corresponds to the specified connector identifier.
void	remove(Connector aConnector) Removes an existing connector.

Field Detail

SERVICE_ID

static final java.lang.String SERVICE_ID

Represents the service identifier value.

See Also:

Constant Field Values

Method Detail

getConnectors

java.util.List getConnectors()

Returns a list of supported connectors defined in the service container.

Returns:

A java.util.List object that contains a list of supported connectors. Each element is a Connector object.

See Also:

Connector

getConnector

Connector getConnector(java.lang.String aConnectorId)
                       throws ConnectorNotFoundException

Retrieves a connector that corresponds to the specified identifier value.

Parameters:

aConnectorId - A unique identifier value used to query a valid connector.

Returns:

A Connector object that represents the connector that corresponds to the specified identifier value.

Throws:

ConnectorNotFoundException - If the identifier value does not correspond to a connector.

See Also:

Connector

getEndpointDefinition

Endpoint getEndpointDefinition(java.lang.String connectorId)

Retrieves the endpoint definition that corresponds to the specified connector identifier.

Parameters:

connectorId - The connector identifier value.

Returns:

An Endpoint object that corresponds to connector identifier value.

See Also:

Endpoint

create

Connector create(Connector aConnector)
                 throws DuplicateConnectorException,
                        com.adobe.idp.dsc.DSCRuntimeException

Creates a new connector.

Parameters:

aConnector - A Connector object that represents a new connector that an endpoint can use.

Returns:

A Connector object that represents the new connector that is defined in the service container.

Throws:

DuplicateConnectorException - If the connector already exists.

com.adobe.idp.dsc.DSCRuntimeException - If a run-time error occurs.

See Also:

Connector

remove

void remove(Connector aConnector)
            throws ConnectorNotFoundException

Removes an existing connector. All endpoints that use this connector are automatically removed.

Parameters:

aConnector - A Connector object that represents the connector to remove.

Throws:

ConnectorNotFoundException - If the specified connector does not exist.

See Also:

Connector