Retrieving Endpoint Connector Information

Summary of steps
Retrieve endpoint connector information using the Java API

You can programmatically retrieve information about endpoint connectors using the LiveCycle API. A connector enables an endpoint to invoke a service using various invocation methods. For example, a Watched Folder connector enables an endpoint to invoke a service using watched folders. By programmatically retrieving information about endpoint connectors, you can retrieve configuration values associated with a connector such as which configuration values are required and which ones are optional.

To demonstrate how to retrieve information about endpoint connectors, this section retrieves information about a Watched Folder connector. (See Adding Watched Folder Endpoints.)

Note: You cannot retrieve information about endpoints by using web services.

Note: This topic uses the ConnectorRegistryClient API to retrieve information about endpoint connectors. (See LiveCycle API Reference.)

Summary of steps

To retrieve endpoint connector information, perform the following tasks:

Include project files.
Create an ConnectorRegistryClient object.
Specify the connector type.
Retrieve configuration values.

Include project files

Include the necessary files into your development project. If you are creating a client application by using Java, include the necessary JAR files. If you are using web services, make sure that you include the proxy files.

The following JAR files must be added to your project’s class path:

adobe-livecycle-client.jar
adobe-usermanager-client.jar
adobe-utilities.jar (required if LiveCycle is deployed on JBoss Application Server)
jbossall-client.jar (required if LiveCycle is deployed on JBoss Application Server)

If LiveCycle is deployed on a supported J2EE application server that is not JBoss, then replace adobe-utilities.jar and jbossall-client.jar with JAR files that are specific to the J2EE application server on which LiveCycle is deployed. For information about the location of all LiveCycle JAR files, see Including LiveCycle Java library files.

Create an ConnectorRegistry Client object

To programmatically retrieve endpoint connector information, create a ConnectorRegistryClient object.

Specify the connector type

Specify the type of connector from which to retrieve information. The following types of connectors exist:

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.
Watched Folder: 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.

Retrieve configuration values

After you specify the connector type, you can retrieve information about the connector such as supported configuration value. For example, for any connector, you can determine which configuration values are required and which ones are optional.

Retrieve endpoint connector information using the Java API

Retrieve endpoint connector information by using the Java API:

Include project files. .

Include client JAR files, such as adobe-livecycle-client.jar, in your Java project’s class path.
Create a ConnectorRegistry Client object.
- Create a ServiceClientFactory object that contains connection properties.
- Create a ConnectorRegistryClient object by using its constructor and passing the ServiceClientFactory object.
Specify the connector type.

Specify the connector type by invoking the ConnectorRegistryClient object’s getEndpointDefinition method and passing a string value that specifies the connector type. For example, to specify the Watched Folder connector type, pass the string value WatchedFolder. This method returns an Endpoint object that corresponds to the connector type.
Retrieve configuration values.
- Retrieve configuration values that are associated within this endpoint by invoking the Endpoint object’s getConfigParameters method. This method returns an array of ConfigParameter objects.
- Retrieve information about each configuration value by retrieving each element within the array. Each element is a ConfigParameter object. You can, for example, determine whether the configuration value is required or optional by invoking the ConfigParameter object’s isRequired method. If the configuration value is required, then this method returns true.