Adding EJB Endpoints

Summary of steps
Adding an EJB endpoint using the Java API

You can programmatically add an EJB endpoint to a service by using the LiveCycle Java API. By adding an EJB endpoint to a service, you are enabling a client application to invoke the service by using the EJB mode. That is, when setting connection properties that are required to invoke LiveCycle, you can select the EJB mode. (See Setting connection properties.)

Note: You cannot add an EJB endpoint by using web services.

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

Summary of steps

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

Include project files.
Create an EndpointRegistry Client object.
Set EJB endpoint attributes.
Create an EJB endpoint.
Enable the endpoint.

Include project files

Include necessary files in your development project. 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)

For information about the location of these JAR files, see Including LiveCycle Java library files.

Create an EndpointRegistry Client object

Before you can programmatically add an EJB endpoint, you must create an EndpointRegistryClient object.

Set EJB endpoint attributes

To create an EJB endpoint for a service, specify the following values:

Connector identifier: Specifies the type of endpoint to create. To create an EJB endpoint, specify EJB.
Description: Specifies the endpoint description.
Name: Specifies the name of the endpoint.
Service identifier: 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 an EJB 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 an EJB endpoint

After you set EJB endpoint attributes, you can create an EJB endpoint for a service.

Enable the endpoint

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

Adding an EJB endpoint using the Java API

Add an EJB endpoint 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 EJB 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 EJB.
- 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 pass a string value that specifies the operation name. For SOAP and EJB endpoints, specify a wildcard character (*), which implies all operations.
Create an EJB 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 EJB endpoint.
Enable the endpoint.

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