com.adobe.idp.dsc.registry.connector.client
Class ConnectorRegistryClient

java.lang.Object
  com.adobe.idp.dsc.registry.connector.client.ConnectorRegistryClient

All Implemented Interfaces:

ConnectorRegistry

public class ConnectorRegistryClient
extends java.lang.Object
implements ConnectorRegistry

Enables the creation of a Java object that provides the ability to perform tasks such as removing 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

Fields inherited from interface com.adobe.idp.dsc.registry.connector.ConnectorRegistry

SERVICE_ID

Constructor Summary

ConnectorRegistryClient(ServiceClientFactory clientServiceFactory)
A constructor that creates a ConnectorRegistryClient object.

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 aConnectorId) Retrieves the endpoint definition that corresponds to the specified connector identifier.
void	remove(Connector aConnector) Removes an existing connector.

Methods inherited from class java.lang.Object

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

Constructor Detail

ConnectorRegistryClient

public ConnectorRegistryClient(ServiceClientFactory clientServiceFactory)

A constructor that creates a ConnectorRegistryClient object.

Parameters:

clientServiceFactory - A ServiceClientFactory that contains connection properties.

Method Detail

getConnectors

public java.util.List getConnectors()

Description copied from interface: ConnectorRegistry

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

Specified by:

getConnectors in interface ConnectorRegistry

Returns:

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

See Also:

Connector

getConnector

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

Description copied from interface: ConnectorRegistry

Retrieves a connector that corresponds to the specified identifier value.

Specified by:

getConnector in interface ConnectorRegistry

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

public Endpoint getEndpointDefinition(java.lang.String aConnectorId)

Description copied from interface: ConnectorRegistry

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

Specified by:

getEndpointDefinition in interface ConnectorRegistry

Parameters:

aConnectorId - The connector identifier value.

Returns:

An Endpoint object that corresponds to connector identifier value.

See Also:

Endpoint

create

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

Description copied from interface: ConnectorRegistry

Creates a new connector.

Specified by:

create in interface ConnectorRegistry

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

public void remove(Connector aConnector)
            throws ConnectorNotFoundException

Description copied from interface: ConnectorRegistry

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

Specified by:

remove in interface ConnectorRegistry

Parameters:

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

Throws:

ConnectorNotFoundException - If the specified connector does not exist.

See Also:

Connector