com.adobe.idp.dsc.registry.endpoint
Interface EndpointRegistry

All Known Implementing Classes:

EndpointRegistryClient

public interface 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 Adobe Experience Manager forms SDK Help.

Field Summary

static java.lang.String	ENDPOINT_CREATE_EVENT
static java.lang.String	ENDPOINT_DELETE_EVENT
static java.lang.String	ENDPOINT_PARAMETER
static java.lang.String	ENDPOINT_UPDATE_EVENT
static java.lang.String	OLD_ENDPOINT_PARAMETER
static java.lang.String	SERVICE_ID

Method Summary

java.util.List	adminGetEndpointsBySearchFilter(com.adobe.idp.dsc.filter.PagingFilter aFilter) Retrieves endpoints that meet the specified search filter.
Endpoint	createEndpoint(CreateEndpointInfo aEndpoint) 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 aConnectorId, java.util.List aCategories, com.adobe.idp.dsc.filter.PagingFilter aPagingFilter) Retrieves endpoints for the specified connector (for example, an Email connector) and category that are accessible by the current user.
java.util.List	getDirectChildCategories(EndpointCategory parent)
Endpoint	getEndpoint(long aEndpointId) Retrieves an endpoint that corresponds to the specified identifier value.
java.util.List	getEndpointCategories(com.adobe.idp.dsc.filter.PagingFilter aPagingFilter) Retrieves all endpoint categories that exist.
EndpointCategory	getEndpointCategory(java.lang.String fullpath) Retrieves the endpoint category that corresponds to the category full path.
java.util.List	getEndpoints(com.adobe.idp.dsc.filter.PagingFilter aPagingFilter) 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 aPagingFilter) 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	getRootEndpointCategories(com.adobe.idp.dsc.filter.PagingFilter aPagingFilter)
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 aPagingFilter) Retrieves endpoints for a specific service and category that are accessible by the current user.
Endpoint	modifyEndpoint(ModifyEndpointInfo aEndpoint) Modifies an existing endpoint.
EndpointCategory	modifyEndpointCategory(ModifyEndpointCategoryInfo aInfo) Updates an existing endpoint category.
void	remove(Endpoint aEndpoint) Removes an existing endpoint.
void	removeEndpointCategory(EndpointCategory category) Removes an existing endpoint category.
void	updateEndpointCategoryHierarchy(EndpointCategory child, EndpointCategory parent)

Field Detail

SERVICE_ID

static final java.lang.String SERVICE_ID

See Also:

Constant Field Values

ENDPOINT_UPDATE_EVENT

static final java.lang.String ENDPOINT_UPDATE_EVENT

See Also:

Constant Field Values

ENDPOINT_CREATE_EVENT

static final java.lang.String ENDPOINT_CREATE_EVENT

See Also:

Constant Field Values

ENDPOINT_DELETE_EVENT

static final java.lang.String ENDPOINT_DELETE_EVENT

See Also:

Constant Field Values

ENDPOINT_PARAMETER

static final java.lang.String ENDPOINT_PARAMETER

See Also:

Constant Field Values

OLD_ENDPOINT_PARAMETER

static final java.lang.String OLD_ENDPOINT_PARAMETER

See Also:

Constant Field Values

Method Detail

createEndpointCategory

EndpointCategory createEndpointCategory(CreateEndpointCategoryInfo aInfo)
                                        throws RegistryException

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 Adobe Experience Manager forms SDK Help.

Parameters:

aInfo - A CreateEndpointCategoryInfo that contains information about the category.

Returns:

An EndpointCategory object that represents the newly created category.

Throws:

RegistryException

getEndpointCategories

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

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.

Parameters:

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

getRootEndpointCategories

java.util.List getRootEndpointCategories(com.adobe.idp.dsc.filter.PagingFilter aPagingFilter)

getDirectChildCategories

java.util.List getDirectChildCategories(EndpointCategory parent)

getEndpointCategory

EndpointCategory getEndpointCategory(java.lang.String fullpath)
                                     throws EndpointCategoryNotFoundException

Retrieves the endpoint category that corresponds to the category full path.

Parameters:

fullpath - The category full path used to retrieve the category.

Returns:

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

Throws:

EndpointCategoryNotFoundException

removeEndpointCategory

void removeEndpointCategory(EndpointCategory category)
                            throws EndpointCategoryNotFoundException,
                                   EndpointCategoryInUseException

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

Parameters:

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

Throws:

EndpointCategoryNotFoundException - If the endpoint category does not correspond to a valid category.

EndpointCategoryInUseException - If the endpoint category is currently in use.

modifyEndpointCategory

EndpointCategory modifyEndpointCategory(ModifyEndpointCategoryInfo aInfo)
                                        throws RegistryException

Updates an existing endpoint category.

Parameters:

aInfo - A ModifyEndpointCategoryInfo object that represents the category changes.

Returns:

An EndpointCategory object that represents the modified endpoint category.

Throws:

RegistryException

updateEndpointCategoryHierarchy

void updateEndpointCategoryHierarchy(EndpointCategory child,
                                     EndpointCategory parent)
                                     throws EndpointCategoryNotFoundException,
                                            DuplicateEndpointCategoryException,
                                            EndpointCategoryLevelExceedException

Throws:

EndpointCategoryNotFoundException

DuplicateEndpointCategoryException

EndpointCategoryLevelExceedException

getEndpoints

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

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 Adobe Experience Manager forms. 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 Adobe Experience Manager forms SDK Help.

Parameters:

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

getEndpointsByCategory

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

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

Parameters:

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

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

getConnectorEndpoints

java.util.List getConnectorEndpoints(java.lang.String aConnectorId,
                                     java.util.List aCategories,
                                     com.adobe.idp.dsc.filter.PagingFilter aPagingFilter)

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 Adobe Experience Manager forms.

Parameters:

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

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

getServiceEndpoints

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

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 Adobe Experience Manager forms.

Parameters:

aServiceId - A service identifier value to which endpoints belong.

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

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

getServiceConnectorEndpoints

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. 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 Adobe Experience Manager forms.

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

getEndpointsBySearchFilter

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

Retrieves endpoints that meet the specified search filter.

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

getEndpoint

Endpoint getEndpoint(long aEndpointId)
                     throws EndpointNotFoundException

Retrieves an endpoint that corresponds to the specified identifier value.

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

Endpoint createEndpoint(CreateEndpointInfo aEndpoint)
                        throws RegistryException

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 Adobe Experience Manager forms SDK Help.

Parameters:

aEndpoint - 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

Endpoint modifyEndpoint(ModifyEndpointInfo aEndpoint)
                        throws RegistryException

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 Adobe Experience Manager forms SDK Help.

Parameters:

aEndpoint - 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

void remove(Endpoint aEndpoint)
            throws EndpointNotFoundException

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 Adobe Experience Manager forms SDK Help.

Parameters:

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

Throws:

EndpointNotFoundException

See Also:

Endpoint

enable

Endpoint enable(Endpoint aEndpoint)
                throws EndpointNotFoundException

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 Adobe Experience Manager forms SDK Help.

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

Endpoint disable(Endpoint aEndpoint)
                 throws EndpointNotFoundException

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

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.

adminGetEndpointsBySearchFilter

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

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

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