|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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(java.lang.String id,
java.lang.String description)
Creates a new endpoint category. |
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(java.lang.String id)
Retrieves the endpoint category that corresponds to the category identifier value. |
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. |
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(EndpointCategory category)
Update an existing endpoint category. |
Method Detail |
---|
EndpointCategory createEndpointCategory(java.lang.String id, java.lang.String description) throws DuplicateEndpointCategoryException
id
- The identifier value of the category.description
- The description of the category.
EndpointCategory
object that represents a new endpoint category.
uplicateEndpointCategoryException
- If the category already exists.
DuplicateEndpointCategoryException
java.util.List getEndpointCategories(com.adobe.idp.dsc.filter.PagingFilter aPagingFilter)
aPagingFilter
- A PagingFilter
object that represents a filter which defines the start offset, the maximum
size, and the sorted order of the returned list.
java.util.List
object that contains endpoint catagories satisfying the result filter conditions. Each element in the list is an EndpointCategory
object.EndpointCategory getEndpointCategory(java.lang.String id) throws EndpointCategoryNotFoundException
id
- The category identifier value used to retrieve the category.
EndpointCategory
object that represents the category that corresponds to the identifier value.
EndpointCategoryNotFoundException
- If the identifier value does not correspond to a endpoint category.void removeEndpointCategory(EndpointCategory category) throws EndpointCategoryNotFoundException, EndpointCategoryInUseException
category
- An EndpointCategory
object that represents the category to remove.
EndpointCategoryNotFoundException
- If the endpoint category does not correspond to a valid category.
EndpointCategoryInUseException
- If the endpoint category is currently in use.EndpointCategory updateEndpointCategory(EndpointCategory category) throws EndpointCategoryNotFoundException
category
- An EndpointCategory
object that represents the category to update.
EndpointCategoryNotFoundException
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)
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 LiveCycle ES.
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.
java.util.List
object that contains endpoints satisfying the query conditions. Each element in the list is an Endpoint
object.Endpoint
int sizeOf(java.lang.String aServiceId, java.lang.String aConnectorId, java.util.List aCategories)
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.
java.util.List getEndpoints(com.adobe.idp.dsc.filter.PagingFilter aFilter)
aFilter
- A result set filter that defines the start offset, the maximum
size, and the sort order of the returned list.
Endpoint
object.Endpoint
Endpoint getEndpoint(long aEndpointId) throws EndpointNotFoundException
aEndpointId
- A unique identifier value of the endpoint.
Endpoint
object that corresponds to the identifier value.
EndpointNotFoundException
- If an endpoint does not exist for the specified identifier value.Endpoint
Endpoint create(Endpoint aEndpoint) throws DuplicateEndpointException, ConnectorNotFoundException, EndpointCategoryNotFoundException
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 LiveCycle SDK Help.
aEndpoint
- A Endpoint
object that represents the endpoint to create.
Endpoint
object that represents the new endpoint.
ConnectorNotFoundException
- If the connector specified in the endpoint is not valid.
EndpointCategoryNotFoundException
- If the category specified in the endpoint is not valid.
DuplicateEndpointException
Endpoint
Endpoint update(Endpoint aEndpoint) throws EndpointNotFoundException, EndpointCategoryNotFoundException
aEndpoint
- A Endpoint
object that represents the endpoint to update.
Endpoint
object that represents the updated endpoint.
EndpointNotFoundException
- The specified endpoint is not valid.
EndpointCategoryNotFoundException
- If the category specified in the endpoint is not valid.Endpoint
void remove(Endpoint aEndpoint) throws EndpointNotFoundException
aEndpoint
- An Endpoint
object that represents the endpoint to remove.
EndpointNotFoundException
- The specified endpoint is not valid.Endpoint
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |