Package com.adobe.idp.dsc.clientsdk
Classpublic final class ServiceClient
InheritanceServiceClient Inheritance 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.


Public Methods
 MethodDefined by
  
FaultResponse createFaultReponse(String invocationId)
Creates the FaultResponse object that is used for a long-lived operation.
ServiceClient
  
InvocationResponse createInvocationReponse(String invocationId)
Creates an InvocationResponse object to complete a long-lived operation.
ServiceClient
  
InvocationResponse invoke(InvocationRequest aInvocationRequest)
Invokes a specific LiveCycle service operation by sending it an invocation request.
ServiceClient
  
void sendFaultReponse(FaultResponse faultResponse)
Sends a FaultReponse instance to a long-lived operation.
ServiceClient
  
void sendInvocationResponse(InvocationResponse response)
Sends an invocation response to complete a long-lived operation invocation.
ServiceClient
Method Detail
createFaultReponse()
public FaultResponse createFaultReponse(String invocationId)

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.
createInvocationReponse() 
public InvocationResponse createInvocationReponse(String invocationId)

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.
invoke() 
public InvocationResponse invoke(InvocationRequest aInvocationRequest)

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
DSCException — If the operation fails.
 
DSCRuntimeException — If the invocation request is not successfully sent to the LiveCycle service.
sendFaultReponse() 
public void sendFaultReponse(FaultResponse faultResponse)

Sends a FaultReponse instance to a long-lived operation.

Parameters

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

sendInvocationResponse() 
public void sendInvocationResponse(InvocationResponse response)

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

Parameters

response — An InvocationResponse object that represents an invocation response.




© 2004-2006 Adobe Systems Incorporated. All rights reserved.
Thu Sep 27 2007, 8:38 AM GMT-07:00

 

Send me an e-mail when comments are added to this page | Comment Report

Current page: http://livedocs.adobe.com/livecycle/es/sdkHelp/programmer/javadoc/com/adobe/idp/dsc/clientsdk/ServiceClient.html