com.adobe.idp.dsc.registry.infomodel
Interface Connector

All Superinterfaces:

java.io.Serializable

public interface Connector
extends java.io.Serializable

A Connector object allows you to retrieve 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. The following type of connectors exist:

• EJB: Enables a client application to invoke a service using the EJB mode.
• SOAP: Enables a client application to invoke a service using the SOAP mode.
• WatchedFolder: Enables Watched Folders to invoke a service.
• Email: Enables email messages to invoke a service.
• Remoting: Enables a Flex client application to invoke a service.
• TaskManagerConnector: Enables a Workspace user to invoke a service from within Workspace.

Field Summary

static java.lang.String	ENDPOINT_DEFINITION_OUTPUT_PARAMETER Endpoint definition output parameter.
static java.lang.String	GET_ENDPOINT_DEFINITION_OPERATION Retrieves the endpoint definition.

Method Summary

java.lang.String	getDisplayName() Retrieves the connector display name.
java.lang.String	getEventHandlerName() Retrieve the service name that handles event notifications such as endpoint modification events.
java.lang.String	getId() Retrieves this connector's unique identifier value.
boolean	requireEndpointEventNotification() Deprecated. Use the Connector.getEventHandlerName() method instead.
boolean	supportEndpointCategory() Determines whether this connector support an endpoint category.
boolean	supportMultipleServiceEndpoints() Determines whether this connector supports multiple endpoints for a specific service.

Field Detail

GET_ENDPOINT_DEFINITION_OPERATION

static final java.lang.String GET_ENDPOINT_DEFINITION_OPERATION

Retrieves the endpoint definition.

See Also:

Constant Field Values

ENDPOINT_DEFINITION_OUTPUT_PARAMETER

static final java.lang.String ENDPOINT_DEFINITION_OUTPUT_PARAMETER

Endpoint definition output parameter.

See Also:

Constant Field Values

Method Detail

getId

java.lang.String getId()

Retrieves this connector's unique identifier value.

Returns:

A string value that specifies the unique identifier value for this connector.

getDisplayName

java.lang.String getDisplayName()

Retrieves the connector display name.

Returns:

A string value that specifies the connector name.

getEventHandlerName

java.lang.String getEventHandlerName()

Retrieve the service name that handles event notifications such as endpoint modification events. If the return value is not null, the connector sends events to the specified service when an endpoint is created, updated, or deleted.

Returns:

The name of the service that handles event notifications.

requireEndpointEventNotification

boolean requireEndpointEventNotification()

Deprecated. Use the Connector.getEventHandlerName() method instead.

Determines whether this connector needs to be informed when an endpoint is created, updated, or deleted.

Returns:

The value true if the connector requires endpoint notification.

supportMultipleServiceEndpoints

boolean supportMultipleServiceEndpoints()

Determines whether this connector supports multiple endpoints for a specific service.

Returns:

The value true if this connector supports multiple endpoints for a service.

supportEndpointCategory

boolean supportEndpointCategory()

Determines whether this connector support an endpoint category.

Returns:

The value true if this connector supports an endpoint category.