com.adobe.idp.dsc.registry.endpoint.client
Class EndpointRegistryClient

java.lang.Object
  com.adobe.idp.dsc.registry.endpoint.client.EndpointRegistryClient

All Implemented Interfaces:

EndpointRegistry

public class EndpointRegistryClient
extends java.lang.Object
implements EndpointRegistry

Enables the creation of a Java object that performs endpoint operations, such as creating and removing endpoints. An endpoint associates a service operation with an available connector, such as Watched Folders thereby enabling a client application to invoke the service operation by using different invocation methods. For example, a Java client application can invoke a service that has either an EJB or SOAP endpoint. You can create the following endpoint types using an EndpointRegistryClient object:

• 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.

For information about programmatically creating endpoints, see Managing Endpoints in the LiveCycle SDK Help.

Field Summary

Fields inherited from interface com.adobe.idp.dsc.registry.endpoint.EndpointRegistry

ENDPOINT_CREATE_EVENT, ENDPOINT_DELETE_EVENT, ENDPOINT_PARAMETER, ENDPOINT_UPDATE_EVENT, OLD_ENDPOINT_PARAMETER, SERVICE_ID

Constructor Summary

EndpointRegistryClient(ServiceClientFactory clientServiceFactory)
A constructor that creates an EndpointRegistryClient object.

Method Summary

java.util.List	adminGetEndpointsBySearchFilter(com.adobe.idp.dsc.filter.PagingFilter aFilter) Retrieves endpoints that meet the specified search filter.
Endpoint	createEndpoint(CreateEndpointInfo aInfo) Creates a new endpoint that is based on the information specified in the CreateEndpointInfo object.
EndpointCategory	createEndpointCategory(CreateEndpointCategoryInfo aInfo) Creates a new endpoint category that you can use with a TaskManager endpoint.
Endpoint	disable(Endpoint aEndpoint) Disables an endpoint.
Endpoint	enable(Endpoint aEndpoint) Enables an endpoint.
java.util.List	getConnectorEndpoints(java.lang.String aConnectorName, java.util.List aCategories, com.adobe.idp.dsc.filter.PagingFilter aFilter) Retrieves endpoints for the specified connector (for example, an Email connector) and category that are accessible by the current user.
Endpoint	getEndpoint(long aEndpointId) Retrieves an endpoint that corresponds to the specified identifier value.
java.util.List	getEndpointCategories(com.adobe.idp.dsc.filter.PagingFilter aFilter) Retrieves all endpoint categories that exist.
EndpointCategory	getEndpointCategory(java.lang.String aId) Retrieves the endpoint category that corresponds to the category identifier value.
java.util.List	getEndpoints(com.adobe.idp.dsc.filter.PagingFilter aFilter) Retrieves all the endpoints defined in the registry that are accessible by the current user.
java.util.List	getEndpointsByCategory(java.util.List aCategories, com.adobe.idp.dsc.filter.PagingFilter aFilter) Retrieves endpoints associated with the specified categories that are accessible by the current user.
java.util.List	getEndpointsBySearchFilter(com.adobe.idp.dsc.filter.PagingFilter aFilter) Retrieves endpoints that meet the specified search filter.
java.util.List	getServiceConnectorEndpoints(java.lang.String aServiceId, java.lang.String aOperationName, java.lang.String aConnectorId, com.adobe.idp.dsc.filter.PagingFilter aPagingFilter) Retrieves endpoints for a given service, connector, and possible operation name.
java.util.List	getServiceEndpoints(java.lang.String aServiceId, java.util.List aCategories, com.adobe.idp.dsc.filter.PagingFilter aFilter) Retrieves endpoints for a specific service and category that are accessible by the current user.
Endpoint	modifyEndpoint(ModifyEndpointInfo aInfo) Modifies an existing endpoint.
EndpointCategory	modifyEndpointCategory(ModifyEndpointCategoryInfo aInfo) Updates an existing endpoint category.
void	remove(Endpoint aEndpoint) Removes an existing endpoint.
void	removeEndpointCategory(EndpointCategory aCategory) Removes an existing endpoint category.

Methods inherited from class java.lang.Object

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

Constructor Detail

EndpointRegistryClient

public EndpointRegistryClient(ServiceClientFactory clientServiceFactory)

A constructor that creates an EndpointRegistryClient object.

Parameters:

clientServiceFactory - A ServiceClientFactory that contains connection properties.

Method Detail

getEndpoints

public java.util.List getEndpoints(com.adobe.idp.dsc.filter.PagingFilter aFilter)

Description copied from interface: EndpointRegistry

Retrieves all the endpoints defined in the registry that are accessible by the current user. A user is specified in connection properties required to invoke LiveCycle ES. To retrieve all endpoints, specify an administrator within connection properties.

To see this method used in a code example, see the Modifying an endpoint using the Java API quick start in the LiveCycle SDK Help.

Specified by:

getEndpoints in interface EndpointRegistry

Parameters:

aFilter - A result set filter that defines the start offset, the maximum size, and the sort order of the returned list.

Returns:

A list of endpoints satisfying the result filter conditions. Each element is an Endpoint object.

See Also:

Endpoint

createEndpointCategory

public EndpointCategory createEndpointCategory(CreateEndpointCategoryInfo aInfo)
                                        throws RegistryException

Description copied from interface: EndpointRegistry

Creates a new endpoint category that you can use with a TaskManager endpoint. Categories are used to organize services within Workspace ES. That is, a Workspace ES user is able to invoke a service that has a TaskManager endpoint by selecting a category within Workspace ES.

To see this method used in a code example, see the Adding a TaskManager endpoint using the Java API quick start in the LiveCycle SDK Help.

Specified by:

createEndpointCategory in interface EndpointRegistry

Parameters:

aInfo - A CreateEndpointCategoryInfo that contains information about the category.

Returns:

An EndpointCategory object that represents the newly created category.

Throws:

RegistryException

getEndpointCategories

public java.util.List getEndpointCategories(com.adobe.idp.dsc.filter.PagingFilter aFilter)

Description copied from interface: EndpointRegistry

Retrieves all endpoint categories that exist. Categories are used to organize services within Workspace ES. That is, a Workspace ES user is able to invoke a service that has a TaskManager endpoint by selecting a category within Workspace ES.

Specified by:

getEndpointCategories in interface EndpointRegistry

Parameters:

aFilter - A PagingFilter object that represents a filter which defines the start offset, the maximum size, and the sorted order of the returned list.

Returns:

A java.util.List object that contains endpoint catagories satisfying the result filter conditions. Each element in the list is an EndpointCategory object.

getEndpointCategory

public EndpointCategory getEndpointCategory(java.lang.String aId)
                                     throws EndpointCategoryNotFoundException

Description copied from interface: EndpointRegistry

Retrieves the endpoint category that corresponds to the category identifier value.

Specified by:

getEndpointCategory in interface EndpointRegistry

Parameters:

aId - The category identifier value used to retrieve the category.

Returns:

An EndpointCategory object that represents the category that corresponds to the identifier value.

Throws:

EndpointCategoryNotFoundException

removeEndpointCategory

public void removeEndpointCategory(EndpointCategory aCategory)
                            throws EndpointCategoryInUseException

Description copied from interface: EndpointRegistry

Removes an existing endpoint category. A category cannot be removed if it is being used.

Specified by:

removeEndpointCategory in interface EndpointRegistry

Parameters:

aCategory - An EndpointCategory object that represents the category to remove.

Throws:

EndpointCategoryInUseException - If the endpoint category is currently in use.

modifyEndpointCategory

public EndpointCategory modifyEndpointCategory(ModifyEndpointCategoryInfo aInfo)
                                        throws RegistryException

Description copied from interface: EndpointRegistry

Updates an existing endpoint category.

Specified by:

modifyEndpointCategory in interface EndpointRegistry

Parameters:

aInfo - A ModifyEndpointCategoryInfo object that represents the category changes.

Returns:

An EndpointCategory object that represents the modified endpoint category.

Throws:

RegistryException

getEndpointsByCategory

public java.util.List getEndpointsByCategory(java.util.List aCategories,
                                             com.adobe.idp.dsc.filter.PagingFilter aFilter)

Description copied from interface: EndpointRegistry

Retrieves endpoints associated with the specified categories that are accessible by the current user. A user is specified in connection properties required to invoke LiveCycle ES. To retrieve all endpoints, specify an administrator within connection properties.

Specified by:

getEndpointsByCategory in interface EndpointRegistry

Parameters:

aCategories - A list of categories that are used to retrieve endpoints.

aFilter - A result set filter that defines the start offset, the maximum size, and the sort order of the returned list.

Returns:

A list of endpoints satisfying the result filter conditions. Each element is an Endpoint object.

See Also:

Endpoint

getConnectorEndpoints

public java.util.List getConnectorEndpoints(java.lang.String aConnectorName,
                                            java.util.List aCategories,
                                            com.adobe.idp.dsc.filter.PagingFilter aFilter)

Description copied from interface: EndpointRegistry

Retrieves endpoints for the specified connector (for example, an Email connector) and category that are accessible by the current user. A user is specified in connection properties required to invoke LiveCycle ES.

Specified by:

getConnectorEndpoints in interface EndpointRegistry

Parameters:

aConnectorName - A connector idenitifer value used in the search criteria. Valid values are: EJB, SOAP, WatchedFolder, Email, Remoting, and TaskManagerConnector.

aCategories - A list of categories that are used to retrieve endpoints.

aFilter - A result set filter that defines the start offset, the maximum size, and the sort order of the returned list.

Returns:

A list of endpoints satisfying the result filter conditions. Each element is an Endpoint object.

See Also:

Endpoint

getServiceEndpoints

public java.util.List getServiceEndpoints(java.lang.String aServiceId,
                                          java.util.List aCategories,
                                          com.adobe.idp.dsc.filter.PagingFilter aFilter)

Description copied from interface: EndpointRegistry

Retrieves endpoints for a specific service and category that are accessible by the current user. A user is specified in connection properties required to invoke LiveCycle ES.

Specified by:

getServiceEndpoints in interface EndpointRegistry

Parameters:

aServiceId - A service identifier value to which endpoints belong.

aCategories - A list of categories that are used to retrieve endpoints.

aFilter - A result set filter that defines the start offset, the maximum size, and the sort order of the returned list.

Returns:

A list of endpoints satisfying the result filter conditions. Each element is an Endpoint object.

See Also:

Endpoint

getEndpoint

public Endpoint getEndpoint(long aEndpointId)
                     throws EndpointNotFoundException

Description copied from interface: EndpointRegistry

Retrieves an endpoint that corresponds to the specified identifier value.

Specified by:

getEndpoint in interface EndpointRegistry

Parameters:

aEndpointId - A unique identifier value of the endpoint.

Returns:

An Endpoint object that corresponds to the identifier value.

Throws:

EndpointNotFoundException - If an endpoint does not exist for the specified identifier value.

See Also:

Endpoint

createEndpoint

public Endpoint createEndpoint(CreateEndpointInfo aInfo)
                        throws RegistryException

Description copied from interface: EndpointRegistry

Creates a new endpoint that is based on the information specified in the CreateEndpointInfo object. After you create an endpoint, you must enable it using the enable method.

To see this method used in a code example, see the Adding a Watched Folder endpoint using the Java API quick start in the LiveCycle SDK Help.

Specified by:

createEndpoint in interface EndpointRegistry

Parameters:

aInfo - A CreateEndpointInfo object that contains endpoint information such as the service operation that is invoked.

Returns:

An Endpoint object that represents the new endpoint.

Throws:

RegistryException - If the endpoint cannot be created.

See Also:

Endpoint, enable, CreateEndpointInfo

modifyEndpoint

public Endpoint modifyEndpoint(ModifyEndpointInfo aInfo)
                        throws RegistryException

Description copied from interface: EndpointRegistry

Modifies an existing endpoint.

To see this method used in a code example, see the Modifying an endpoint using the Java API quick start in the LiveCycle SDK Help.

Specified by:

modifyEndpoint in interface EndpointRegistry

Parameters:

aInfo - A ModifyEndpointInfo object that represents modifications to the endpoint.

Returns:

An Endpoint object that represents the modified endpoint.

Throws:

RegistryException - If the endpoint cannot be modified.

remove

public void remove(Endpoint aEndpoint)

Description copied from interface: EndpointRegistry

Removes an existing endpoint. After you remove an endpoint, the service cannot be invoked using the invocation method that the endpoint enabled.

To see this method used in a code example, see the Removing an endpoint using the Java API quick start in the LiveCycle SDK Help.

Specified by:

remove in interface EndpointRegistry

Parameters:

aEndpoint - An Endpoint object that represents the endpoint to remove.

See Also:

Endpoint

enable

public Endpoint enable(Endpoint aEndpoint)
                throws EndpointNotFoundException

Description copied from interface: EndpointRegistry

Enables an endpoint. After you create an endpoint using the createEndpoint method, you must enable it using this method.

To see this method used in a code example, see the Adding a Watched Folder endpoint using the Java API quick start in the LiveCycle SDK Help.

Specified by:

enable in interface EndpointRegistry

Parameters:

aEndpoint - An Endpoint object that represents the endpoint to enable.

Returns:

An Endpoint object that represents the enabled endpoint.

Throws:

EndpointNotFoundException - If the endpoint cannot be enables or is already enabled.

See Also:

Endpoint, createEndpoint

disable

public Endpoint disable(Endpoint aEndpoint)
                 throws EndpointNotFoundException

Description copied from interface: EndpointRegistry

Disables an endpoint. After an endpoint is disabled, it cannot invoke sevice operations until it is enabled using the enable method.

Specified by:

disable in interface EndpointRegistry

Parameters:

aEndpoint - An Endpoint object that represents the endpoint to disable.

Returns:

An Endpoint object that represents the disabled endpoint.

Throws:

EndpointNotFoundException - If the endpoint cannot be disabled or cannot be located.

getEndpointsBySearchFilter

public java.util.List getEndpointsBySearchFilter(com.adobe.idp.dsc.filter.PagingFilter aFilter)

Description copied from interface: EndpointRegistry

Retrieves endpoints that meet the specified search filter.

Specified by:

getEndpointsBySearchFilter in interface EndpointRegistry

Parameters:

aFilter - A result set filter that defines the start offset, the maximum size, and the sort order of the returned list.

Returns:

A list of endpoints satisfying the result filter conditions. Each element is an Endpoint object.

See Also:

Endpoint

adminGetEndpointsBySearchFilter

public java.util.List adminGetEndpointsBySearchFilter(com.adobe.idp.dsc.filter.PagingFilter aFilter)

Description copied from interface: EndpointRegistry

Retrieves endpoints that meet the specified search filter. This method filters results based on the specified user having add and remove endpoints permissions.

Specified by:

adminGetEndpointsBySearchFilter in interface EndpointRegistry

Parameters:

aFilter - A result set filter that defines the start offset, the maximum size, and the sort order of the returned list.

Returns:

A list of endpoints satisfying the result filter conditions. Each element is a Endpoint object.

See Also:

Endpoint

getServiceConnectorEndpoints

public java.util.List getServiceConnectorEndpoints(java.lang.String aServiceId,
                                                   java.lang.String aOperationName,
                                                   java.lang.String aConnectorId,
                                                   com.adobe.idp.dsc.filter.PagingFilter aPagingFilter)

Description copied from interface: EndpointRegistry

Retrieves endpoints for a given service, connector, and possible operation name. This method is used to determine if an endpoint is enabled for a given service that is specified in the search criteria. A null value for a parameter implies that the specific parameter is not part of the search criteria. This method only returns endpoints that are accessible by the current user. A user is specified in connection properties required to invoke LiveCycle ES.

Specified by:

getServiceConnectorEndpoints in interface EndpointRegistry

Parameters:

aServiceId - A service identifier value to which endpoints belong.

aOperationName - The name of the operation that is invoked by the endpoints.

aConnectorId - A connector idenitifer value used in the search criteria. Valid values are: EJB, SOAP, WatchedFolder, Email, Remoting, and TaskManagerConnector.

aPagingFilter - A result set filter that defines the start offset, the maximum size, and the sort order of the returned list.

Returns:

A list of endpoints satisfying the result filter conditions. Each element is an Endpoint object.

See Also:

Endpoint