com.adobe.idp.dsc.clientsdk
Class ServiceClient

java.lang.Object
  com.adobe.idp.dsc.clientsdk.ServiceClient

public final class ServiceClient
extends java.lang.Object

Enables a client application to invoke a LiveCycle service by sending an invocation request and handling an invocation response. The recommended way to programmatically invoke a LiveCycle service is to use a service's strongly-typed API as opposed to using this object. However, not all LiveCycle services have a strongly-typed API. An orchestrated service does not have a service client and as a result, you can use a ServiceClient object to programmatically invoke an orchestrated service. For information, see Invoking LiveCycle Services.

Method Summary

com.adobe.idp.dsc.FaultResponse	createFaultReponse(java.lang.String invocationId) Creates the FaultResponse object that is used for a long-lived operation.
InvocationResponse	createInvocationReponse(java.lang.String invocationId) Creates an InvocationResponse object to complete a long-lived operation.
InvocationResponse	invoke(InvocationRequest aInvocationRequest) Invokes a specific LiveCycle service operation by sending it an invocation request.
void	sendFaultReponse(com.adobe.idp.dsc.FaultResponse faultResponse) Sends a FaultReponse instance to a long-lived operation.
void	sendInvocationResponse(InvocationResponse response) Sends an invocation response to complete a long-lived operation invocation.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

createInvocationReponse

public InvocationResponse createInvocationReponse(java.lang.String invocationId)
                                           throws com.adobe.idp.dsc.DSCException

Creates an InvocationResponse object to complete a long-lived operation. This method validates that the invocationId value matches an existing long-lived operation and the operation is in a running state.

Parameters:

invocationId - A string value that specifies an invocationId value.

Returns:

InvocationResponse An InvocationResponse instance that completes a long-lived operation.

Throws:

com.adobe.idp.dsc.DSCException

createFaultReponse

public com.adobe.idp.dsc.FaultResponse createFaultReponse(java.lang.String invocationId)
                                                   throws com.adobe.idp.dsc.DSCException

Creates the FaultResponse object that is used for a long-lived operation.

Parameters:

invocationId - A string value that specifies an invocationId value.

Returns:

FaultResponse A FaultResponse object that is used for a long-lived operation.

Throws:

com.adobe.idp.dsc.DSCException

sendFaultReponse

public void sendFaultReponse(com.adobe.idp.dsc.FaultResponse faultResponse)
                      throws com.adobe.idp.dsc.DSCException

Sends a FaultReponse instance to a long-lived operation.

Parameters:

faultResponse - A FaultReponse instance to send to a long-lived operation.

Throws:

com.adobe.idp.dsc.DSCException

sendInvocationResponse

public void sendInvocationResponse(InvocationResponse response)
                            throws com.adobe.idp.dsc.DSCException

Sends an invocation response to complete a long-lived operation invocation.

Parameters:

response - An InvocationResponse object that represents an invocation response.

Throws:

com.adobe.idp.dsc.DSCException

invoke

public InvocationResponse invoke(InvocationRequest aInvocationRequest)
                          throws com.adobe.idp.dsc.DSCException

Invokes a specific LiveCycle service operation by sending it an invocation request. The current implementation only supports RMI protocol.

Parameters:

aInvocationRequest - An InvocationRequest object that represens the invocation request to send to a LiveCycle service.

Returns:

An InvocationResponse object that contains the operation results if the operation is invoked synchronously. If the operation is invoked asynchronously, then the InvocationResponse object contains the job identifier value.

Throws:

com.adobe.idp.dsc.DSCException - If the operation fails.

com.adobe.idp.dsc.DSCRuntimeException - If the invocation request is not successfully sent to the LiveCycle service.