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

public interface Endpoint

An Endpoint object enables you to set and retrieve endpoint information. An endpoint associates a service operation with an available connector, such as a WatchedFolder connector, thereby enabling a client application to invoke the service operation by using different invocation methods. For example, a Watched Folder endpoint enables a Watched Folder to invoke a specific service operation. An Endpoint instance is not instantiated directly. Instead, an Endpoint instance is returned by methods such as the EndpointRegistryClient object's createEndpoint method. For information about programmatically adding an endpoint to a service, see Managing Endpoints in the Adobe Experience Manager forms SDK Help.

Method Summary

EndpointCategory	getCategory() Retrieves the endpoint category.
ConfigParameter[]	getConfigParameters() Retrieves configuration parameter values for this endpoint.
java.lang.String	getConnectorId() Retrieves the identifier of this endpoint's connector.
java.lang.String	getCreatedBy() Retrieves the creator of the endpoint.
java.lang.String	getDescription() Retrieves the endpoint description.
EndpointURI	getEndpointURI() Retrieves the endpoint URI.
long	getId() Retrieves this unique identifier of the endpoint.
InputParameterMapping[]	getInputParameterMappings() Retrieves input data mappings values.
java.lang.String	getName() Retrieves the unique name of this endpoint.
java.lang.String	getOperationName() Retrieves the operation name that is invoked by using this endpoint.
com.adobe.idp.dsc.registry.infomodel.OutputParameterMapping[]	getOutputParameterMappings() Retrieves output data mapping values.
java.lang.String	getServiceId() Get the service identifier for which this endpoint is associated.
java.lang.String	getServiceSpecificationId() Retrieves the specification identifier of a service, identifying its contract.
java.util.Date	getUpdateTime() Retrieves the last update time for the endpoint.
boolean	isEnabled() Determines if the endpoint is enabled.
void	setCreatedBy(java.lang.String aCreatedBy) Sets the creator of the endpoint.
void	setDescription(java.lang.String aDescription) Sets a new endpoint description.
void	setEndpointURI(EndpointURI aEndpointUri) Sets the endpoint URI.

Method Detail

getId

long getId()

Retrieves this unique identifier of the endpoint.

Returns:

A unique identifier of the endpoint.

getName

java.lang.String getName()

Retrieves the unique name of this endpoint.

Returns:

A string value that specifies the name of the endpoint.

getDescription

java.lang.String getDescription()

Retrieves the endpoint description.

Returns:

A string value that specifies the description of the endpoint.

setDescription

void setDescription(java.lang.String aDescription)

Sets a new endpoint description.

Parameters:

aDescription - A string value that specifies the description of the endpoint.

getCategory

EndpointCategory getCategory()

Retrieves the endpoint category. Categories are used to organize services within Workspace ES.

Returns:

A string value that specifies the category assoicated with this endpoint.

getUpdateTime

java.util.Date getUpdateTime()

Retrieves the last update time for the endpoint. Last update time help is optimizing client side computations

Returns:

A Date that specifies the endpoint update time.

getServiceId

java.lang.String getServiceId()

Get the service identifier for which this endpoint is associated.

Returns:

A string value that specifies the service identifier for which this endpoint is associated.

getServiceSpecificationId

java.lang.String getServiceSpecificationId()

Retrieves the specification identifier of a service, identifying its contract. A specification identifier may be shared across services with the same contract or signature.

Returns:

The specification identifier of a service.

getConnectorId

java.lang.String getConnectorId()

Retrieves the identifier of this endpoint's connector. Valid values are: EJB, SOAP, WatchedFolder, Email, Remoting, and TaskManagerConnector.

Returns:

A string value that specifies the identifier of this endpoint's connector.

getEndpointURI

EndpointURI getEndpointURI()

Retrieves the endpoint URI.

Returns:

A string value that specifies URI of the endpoint.

setEndpointURI

void setEndpointURI(EndpointURI aEndpointUri)
                    throws java.lang.Exception

Sets the endpoint URI.

Parameters:

aEndpointUri - An EndpointURI object that sets the URI for this endpoint.

Throws:

java.lang.Exception - If an invalid URI is specified.

getConfigParameters

ConfigParameter[] getConfigParameters()

Retrieves configuration parameter values for this endpoint. Configuration parameters are defined for endpoints that have Email or WatchedFolder connectors. For information about configuration values, see Managing Endpoints in the Adobe Experience Manager forms SDK Help.

Returns:

An array of ConfigParameter objects that represent configuration parameters for this endpoint.

See Also:

ConfigParameter

getInputParameterMappings

InputParameterMapping[] getInputParameterMappings()

Retrieves input data mappings values. These values describe the input values that are passed to the operation that is invoked by this endpoint. For information about setting input data mapping values, see Adding Watched Folder Endpoints or Adding Email Endpointsin the Adobe Experience Manager forms SDK Help.

Returns:

An array of InputParameterMapping objects.

See Also:

InputParameterMapping

getOutputParameterMappings

com.adobe.idp.dsc.registry.infomodel.OutputParameterMapping[] getOutputParameterMappings()

Retrieves output data mapping values. These values describe the output value of the operation that is invoked by this endpoint. For information about setting output data mapping values, see Adding Watched Folder Endpoints or Adding Email Endpointsin the Adobe Experience Manager forms SDK Help.

Returns:

An array of OutputParameterMapping objects.

See Also:

OutputParameterMapping

getOperationName

java.lang.String getOperationName()

Retrieves the operation name that is invoked by using this endpoint.

Returns:

A string value that specifies the name of the operation that is invoked by this endpoint.

getCreatedBy

java.lang.String getCreatedBy()

Retrieves the creator of the endpoint.

Returns:

A string value that specifies the name of endpoint creator.

setCreatedBy

void setCreatedBy(java.lang.String aCreatedBy)

Sets the creator of the endpoint.

Parameters:

aCreatedBy - A string value that specifies the creator of the endpoint.

isEnabled

boolean isEnabled()

Determines if the endpoint is enabled.

Returns:

Returns true if the endpoint is enabled; otherwise, returns false.