|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.adobe.idp.dsc.registry.connector.client.ConnectorRegistryClient
public class ConnectorRegistryClient
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 |
---|
public ConnectorRegistryClient(ServiceClientFactory clientServiceFactory)
ConnectorRegistryClient
object.
clientServiceFactory
- A ServiceClientFactory
that contains connection properties.Method Detail |
---|
public java.util.List getConnectors()
ConnectorRegistry
getConnectors
in interface ConnectorRegistry
java.util.List
object that contains a list of supported connectors.
Each element is a Connector
object.Connector
public Connector getConnector(java.lang.String aConnectorId) throws ConnectorNotFoundException
ConnectorRegistry
getConnector
in interface ConnectorRegistry
aConnectorId
- A unique identifier value used to query a valid connector.
Connector
object that represents the connector that corresponds to the specified identifier value.
ConnectorNotFoundException
- If the identifier value does not correspond to a connector.Connector
public Endpoint getEndpointDefinition(java.lang.String aConnectorId)
ConnectorRegistry
getEndpointDefinition
in interface ConnectorRegistry
aConnectorId
- The connector identifier value.
Endpoint
object that corresponds to connector identifier value.Endpoint
public Connector create(Connector aConnector) throws DuplicateConnectorException, com.adobe.idp.dsc.DSCRuntimeException
ConnectorRegistry
create
in interface ConnectorRegistry
aConnector
- A Connector
object that represents a new connector that an endpoint can use.
Connector
object that represents the new connector that is defined in the service container.
DuplicateConnectorException
- If the connector already exists.
com.adobe.idp.dsc.DSCRuntimeException
- If a run-time error occurs.Connector
public void remove(Connector aConnector) throws ConnectorNotFoundException
ConnectorRegistry
remove
in interface ConnectorRegistry
aConnector
- A Connector
object that represents the connector to remove.
ConnectorNotFoundException
- If the specified connector does not exist.Connector
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |