Adding SOAP Endpoints

Summary of steps
Add a SOAP endpoint using the Java API

You can programmatically add a SOAP endpoint to a service by using the LiveCycle Java API. By adding a SOAP endpoint, you enable a client application to invoke the service by using the SOAP mode. That is, when setting connection properties required to invoke LiveCycle, you can select the SOAP mode.

Note: You cannot add a SOAP endpoint by using web services.

Note: Typically, a SOAP endpoint is added to a service by default, However, a SOAP endpoint can be added to a process that is programmatically deployed or when a SOAP endpoint was removed and has to be added again.

Summary of steps

To add a SOAP endpoint to a service, perform the following tasks:

Include project files.
Create an EndpointRegistryClient object.
Set SOAP endpoint attributes.
Create a SOAP endpoint.
Enable the endpoint.

Include project files

Include the necessary files in 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)

These JAR files are required to create a SOAP endpoint. However, you require addition JAR files if you use the SOAP endpoint to invoke the service. For information about LiveCycle JAR files, see Including LiveCycle Java library files.

Create an EndpointRegistry Client object

To programmatically add a SOAP endpoint to a service, you must create an EndpointRegistryClient object.

Set SOAP endpoint attributes

To add a SOAP endpoint to a service, specify the following values:

Connector identifier value: Specifies the type of endpoint to create. To create a SOAP endpoint, specify SOAP.
Description: Specifies the endpoint description.
Name: Specifies the endpoint name.
Service identifier value: Specifies the service to which the endpoint belongs.
Operation name: Specifies the name of the operation that is invoked by using the endpoint. When creating a SOAP endpoint, specify a wildcard character (*). However, if you want to specify a specific operation as opposed to invoking all service operations, specify the name of the operation as opposed to using the wildcard character (*).

Create a SOAP endpoint

After you set SOAP endpoint attributes, you can create a SOAP endpoint.

Enable the endpoint

After you create a new endpoint, you must enable it. When the endpoint is enabled, it can be used to invoke the service. After you enable the endpoint, you can view see it within Administration Console.

Add a SOAP endpoint using the Java API

Add a SOAP endpoint to a service 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 an EndpointRegistry Client object.
- Create a ServiceClientFactory object that contains connection properties.
- Create an EndpointRegistryClient object by using its constructor and passing the ServiceClientFactory object.
Set SOAP endpoint attributes.
- Create a CreateEndpointInfo object by using its constructor.
- Specify the connector identifier value by invoking the CreateEndpointInfo object’s setConnectorId method and passing the string value SOAP.
- Specify the description of the endpoint by invoking the CreateEndpointInfo object’s setDescription method and passing a string value that describes the endpoint.
- Specify the name of the endpoint by invoking the CreateEndpointInfo object’s setName method and passing a string value that specifies the name.
- Specify the service to which the endpoint belongs by invoking the CreateEndpointInfo object’s setServiceId method and passing a string value that specifies the service name.
- Specify the operation that is invoked by invoking the CreateEndpointInfo object’s setOperationName method and passing a string value that specifies the operation name. For SOAP and EJB endpoints, specify a wildcard character (*), which implies all operations.
Create a SOAP endpoint.

Create the endpoint by invoking the EndpointRegistryClient object’s createEndpoint method and passing the CreateEndpointInfo object. This method returns an Endpoint object that represents the new SOAP endpoint.
Enable the endpoint.

Enable the endpoint by invoking the EndpointRegistryClient object’s enable method and pass the Endpoint object that was returned by the createEndpoint method.