|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.adobe.idp.dsc.registry.endpoint.client.EndpointRegistryClient
public class EndpointRegistryClient
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:
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 |
---|
public EndpointRegistryClient(ServiceClientFactory clientServiceFactory)
EndpointRegistryClient
object.
clientServiceFactory
- A ServiceClientFactory
that contains connection properties.Method Detail |
---|
public java.util.List getEndpoints(com.adobe.idp.dsc.filter.PagingFilter aFilter)
EndpointRegistry
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.
getEndpoints
in interface EndpointRegistry
aFilter
- A result set filter that defines the start offset, the maximum
size, and the sort order of the returned list.
Endpoint
object.Endpoint
public EndpointCategory createEndpointCategory(CreateEndpointCategoryInfo aInfo) throws RegistryException
EndpointRegistry
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.
createEndpointCategory
in interface EndpointRegistry
aInfo
- A CreateEndpointCategoryInfo
that contains information about the category.
EndpointCategory
object that represents the newly created category.
RegistryException
public java.util.List getEndpointCategories(com.adobe.idp.dsc.filter.PagingFilter aFilter)
EndpointRegistry
getEndpointCategories
in interface EndpointRegistry
aFilter
- 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.public EndpointCategory getEndpointCategory(java.lang.String aId) throws EndpointCategoryNotFoundException
EndpointRegistry
getEndpointCategory
in interface EndpointRegistry
aId
- The category identifier value used to retrieve the category.
EndpointCategory
object that represents the category that corresponds to the identifier value.
EndpointCategoryNotFoundException
public void removeEndpointCategory(EndpointCategory aCategory) throws EndpointCategoryInUseException
EndpointRegistry
removeEndpointCategory
in interface EndpointRegistry
aCategory
- An EndpointCategory
object that represents the category to remove.
EndpointCategoryInUseException
- If the endpoint category is currently in use.public EndpointCategory modifyEndpointCategory(ModifyEndpointCategoryInfo aInfo) throws RegistryException
EndpointRegistry
modifyEndpointCategory
in interface EndpointRegistry
aInfo
- A ModifyEndpointCategoryInfo
object that represents the category changes.
EndpointCategory
object that represents the modified endpoint category.
RegistryException
public java.util.List getEndpointsByCategory(java.util.List aCategories, com.adobe.idp.dsc.filter.PagingFilter aFilter)
EndpointRegistry
getEndpointsByCategory
in interface EndpointRegistry
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.
Endpoint
object.Endpoint
public java.util.List getConnectorEndpoints(java.lang.String aConnectorName, java.util.List aCategories, com.adobe.idp.dsc.filter.PagingFilter aFilter)
EndpointRegistry
getConnectorEndpoints
in interface EndpointRegistry
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.
Endpoint
object.Endpoint
public java.util.List getServiceEndpoints(java.lang.String aServiceId, java.util.List aCategories, com.adobe.idp.dsc.filter.PagingFilter aFilter)
EndpointRegistry
getServiceEndpoints
in interface EndpointRegistry
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.
Endpoint
object.Endpoint
public Endpoint getEndpoint(long aEndpointId) throws EndpointNotFoundException
EndpointRegistry
getEndpoint
in interface EndpointRegistry
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
public Endpoint createEndpoint(CreateEndpointInfo aInfo) throws RegistryException
EndpointRegistry
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.
createEndpoint
in interface EndpointRegistry
aInfo
- A CreateEndpointInfo
object that contains endpoint information such as the service operation that is invoked.
Endpoint
object that represents the new endpoint.
RegistryException
- If the endpoint cannot be created.Endpoint
,
enable
,
CreateEndpointInfo
public Endpoint modifyEndpoint(ModifyEndpointInfo aInfo) throws RegistryException
EndpointRegistry
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.
modifyEndpoint
in interface EndpointRegistry
aInfo
- A ModifyEndpointInfo
object that represents modifications to the endpoint.
Endpoint
object that represents the modified endpoint.
RegistryException
- If the endpoint cannot be modified.public void remove(Endpoint aEndpoint)
EndpointRegistry
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.
remove
in interface EndpointRegistry
aEndpoint
- An Endpoint
object that represents the endpoint to remove.Endpoint
public Endpoint enable(Endpoint aEndpoint) throws EndpointNotFoundException
EndpointRegistry
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.
enable
in interface EndpointRegistry
aEndpoint
- An Endpoint
object that represents the endpoint to enable.
Endpoint
object that represents the enabled endpoint.
EndpointNotFoundException
- If the endpoint cannot be enables or is already enabled.Endpoint
,
createEndpoint
public Endpoint disable(Endpoint aEndpoint) throws EndpointNotFoundException
EndpointRegistry
enable
method.
disable
in interface EndpointRegistry
aEndpoint
- An Endpoint
object that represents the endpoint to disable.
Endpoint
object that represents the disabled endpoint.
EndpointNotFoundException
- If the endpoint cannot be disabled or cannot be located.public java.util.List getEndpointsBySearchFilter(com.adobe.idp.dsc.filter.PagingFilter aFilter)
EndpointRegistry
getEndpointsBySearchFilter
in interface EndpointRegistry
aFilter
- A result set filter that defines the start offset, the maximum
size, and the sort order of the returned list.
Endpoint
object.Endpoint
public java.util.List adminGetEndpointsBySearchFilter(com.adobe.idp.dsc.filter.PagingFilter aFilter)
EndpointRegistry
adminGetEndpointsBySearchFilter
in interface EndpointRegistry
aFilter
- A result set filter that defines the start offset, the maximum
size, and the sort order of the returned list.
Endpoint
object.Endpoint
public java.util.List getServiceConnectorEndpoints(java.lang.String aServiceId, java.lang.String aOperationName, java.lang.String aConnectorId, com.adobe.idp.dsc.filter.PagingFilter aPagingFilter)
EndpointRegistry
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.
getServiceConnectorEndpoints
in interface EndpointRegistry
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.
Endpoint
object.Endpoint
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |