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

public interface EndpointStore

Enables the creation of a Java object that performs operations on existing endpoints.

Method Summary

Endpoint	create(Endpoint aEndpoint) Creates a new endpoint that is based on the information specified in the Endpoint object.
EndpointCategory	createEndpointCategory(EndpointCategory parent, java.lang.String shortName, java.lang.String aDescription)
EndpointCategory	createEndpointCategory(java.lang.String path, java.lang.String description) Creates a new root endpoint category.
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 the endpoint categories.
EndpointCategory	getEndpointCategory(long parentOid, java.lang.String shortName)
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 aFilter) Retrieves all defined endpoints that are accessible by the current user.
java.util.List	getEndpoints(java.lang.String aServiceId, java.lang.String aOperationName, java.lang.String aConnectorId, java.util.List aCategories, com.adobe.idp.dsc.filter.PagingFilter aPagingFilter) Retrieves endpoints that meet the specified search criteria.
java.util.List	getRootEndpointCategories(com.adobe.idp.dsc.filter.PagingFilter aPagingFilter)
void	remove(Endpoint aEndpoint) Removes an endpoint from the registry.
void	removeEndpointCategory(EndpointCategory category) Removes an existing endpoint category.
int	sizeOf(java.lang.String aServiceId, java.lang.String aConnectorId, java.util.List aCategories) Returns the size of the endpoint.
Endpoint	update(Endpoint aEndpoint) Updates an existing endpoint.
EndpointCategory	updateEndpointCategory(long oid, java.lang.String newFullpath, java.lang.String newDesc) Update an existing endpoint category.
void	updateEndpointCategoryHierarchy(EndpointCategory child, EndpointCategory parent)

Method Detail

createEndpointCategory

EndpointCategory createEndpointCategory(java.lang.String path,
                                        java.lang.String description)
                                        throws DuplicateEndpointCategoryException,
                                               EndpointCategoryNotFoundException,
                                               EndpointCategoryLevelExceedException

Creates a new root endpoint category. A new category can be created when creating an endpoint that requires a category and existing categories cannot be used.

Parameters:

path - The full path of the category. For example, PTO/Beijing means the child category Beijing under PTO category. These 2 categories will be created cascading.

description - The description of the leaf category.

Returns:

An EndpointCategory object that represents the new leaf endpoint category.

Throws:

DuplicateEndpointCategoryException - If the category already exists.

EndpointCategoryNotFoundException

EndpointCategoryLevelExceedException

createEndpointCategory

EndpointCategory createEndpointCategory(EndpointCategory parent,
                                        java.lang.String shortName,
                                        java.lang.String aDescription)
                                        throws DuplicateEndpointCategoryException,
                                               EndpointCategoryNotFoundException,
                                               EndpointCategoryLevelExceedException

Throws:

DuplicateEndpointCategoryException

EndpointCategoryNotFoundException

EndpointCategoryLevelExceedException

getEndpointCategories

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

Retrieves all the endpoint categories.

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:

id - The category full path value used to retrieve the category.

Returns:

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

Throws:

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

getEndpointCategory

EndpointCategory getEndpointCategory(long parentOid,
                                     java.lang.String shortName)
                                     throws EndpointCategoryNotFoundException

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.

updateEndpointCategory

EndpointCategory updateEndpointCategory(long oid,
                                        java.lang.String newFullpath,
                                        java.lang.String newDesc)
                                        throws EndpointCategoryNotFoundException,
                                               DuplicateEndpointCategoryException,
                                               EndpointCategoryLevelExceedException

Update an existing endpoint category.

Parameters:

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

Throws:

EndpointCategoryNotFoundException

DuplicateEndpointCategoryException

EndpointCategoryLevelExceedException

updateEndpointCategoryHierarchy

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

Throws:

EndpointCategoryNotFoundException

DuplicateEndpointCategoryException

EndpointCategoryLevelExceedException

getEndpoints

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

Retrieves endpoints that meet the specified search criteria. The value Null for any parameter implies that particular parameter is not part of the search criteria. This method only returns endpoints to which the current user has access rights. A user is specified in connection properties required to invoke Adobe Experience Manager forms.

Parameters:

aServiceId - The name of the service that the endpoints belong to.

aOperationName - The operation name from the service.

aConnectorId - The connector identifier value.

aCategories - A list of the category names to which the endpoints belongs.

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 endpoints satisfying the query conditions. Each element in the list is an Endpoint object.

See Also:

Endpoint

sizeOf

int sizeOf(java.lang.String aServiceId,
           java.lang.String aConnectorId,
           java.util.List aCategories)

Returns the size of the endpoint.

Parameters:

aServiceId - The name of the service that the endpoint belongs to.

aConnectorId - The connector identifier value.

aCategories - A list of category names that the endpoint belong to.

Returns:

The size of the endpoint in bytes.

getEndpoints

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

Retrieves all defined endpoints 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:

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

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:

A Endpoint object that corresponds to the identifier value.

Throws:

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

See Also:

Endpoint

create

Endpoint create(Endpoint aEndpoint)
                throws DuplicateEndpointException,
                       ConnectorNotFoundException,
                       EndpointCategoryNotFoundException

Creates a new endpoint that is based on the information specified in the Endpoint object. After you create an endpoint, you must enable it using the enable method. For information about creating endpoints, see Managing Endpoints in the Adobe Experience Manager forms SDK Help.

Parameters:

aEndpoint - A Endpoint object that represents the endpoint to create.

Returns:

A Endpoint object that represents the new endpoint.

Throws:

ConnectorNotFoundException - If the connector specified in the endpoint is not valid.

EndpointCategoryNotFoundException - If the category specified in the endpoint is not valid.

DuplicateEndpointException

See Also:

Endpoint

update

Endpoint update(Endpoint aEndpoint)
                throws EndpointNotFoundException,
                       EndpointCategoryNotFoundException

Updates an existing endpoint. For information about updating endpoints, see Modifying Endpoints in the Adobe Experience Manager forms SDK Help.

Parameters:

aEndpoint - A Endpoint object that represents the endpoint to update.

Returns:

A Endpoint object that represents the updated endpoint.

Throws:

EndpointNotFoundException - The specified endpoint is not valid.

EndpointCategoryNotFoundException - If the category specified in the endpoint is not valid.

See Also:

Endpoint

remove

void remove(Endpoint aEndpoint)
            throws EndpointNotFoundException

Removes an endpoint from the registry. After an endpoint is removed, the service cannot be invoked using the invocation method that the endpoint enabled. For information about removing an endpoint, see Removing Endpoints in the Adobe Experience Manager forms SDK Help.

Parameters:

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

Throws:

EndpointNotFoundException - The specified endpoint is not valid.

See Also:

Endpoint