com.adobe.idp.dsc.InvocationRequest (Livecycle)

	Method	Defined by
		String getEndPointURI() Retrieves the endpoint URI used by this invocation request.	InvocationRequest
		Object getInputParameter(String parameterName) Retrieves the value of the specified parameter.	InvocationRequest
		Map getInputParameters() Retrieves input parameters that are specified in the invocation request as a `java.util.map` object.	InvocationRequest
		Context getInvocationContext() Retrieves the `com.adobe.idp.Context` that is used in this invocation request.	InvocationRequest
		String getInvocationId() Returns the identifier value of this invocation request.	InvocationRequest
		String getOperationName() Retrieves the name of the service operation specified by this invocation request.	InvocationRequest
		Object getProperty(String propertyName) Retrieves the value of an invocation request property.	InvocationRequest
		Object getProperty(String propertyName, Object defaultValue) Retrieves an invocation request property.	InvocationRequest
		String getServiceExplicitVersion() Retrieves the explicit version of the LiveCycle service.	InvocationRequest
		String getServiceName() Retrieves the LiveCycle service name that is specified in this invocation request.	InvocationRequest
		String getServiceOriginalVersion() Retrieves the original verion of the LiveCycle service that is specified in this invocation request.	InvocationRequest
		ServiceConfiguration getTargetServiceConfiguration() Returns the target service configuration that was resolved based on the service identifier and versioning information specified in this invocation request.	InvocationRequest
		boolean isSynchronous() Determines whether the operation is going to be executed synchronously or asynchronously.	InvocationRequest
		Object removeProperty(String propertyName) Removes an associated property from the invocation request.	InvocationRequest
		void setClientParameters(Map parameters) Sets parameter values passed to the LiveCycle service.	InvocationRequest
		void setEndPointURI(String endpointURI) Specifies a valid endpoint URI, which is an address that is used to reference a LiveCycle service either locally or remotely.	InvocationRequest
		void setFaultCallback(FaultCallBackInfo info) Sets a fault callback.	InvocationRequest
		void setInputParameter(String parameterName, Object value) Specifies an input parameter and its value.	InvocationRequest
		void setInputParameters(Map inputParameters) Copies all the values from the specified map to this invocation request's input parameters.	InvocationRequest
		void setOperationName(String operationName) Specifies the service operation name that the client application wants to invoke.	InvocationRequest
		void setProperty(String propertyName, Object value) Specifies an invocation request property.	InvocationRequest
		void setResponseCallback(ResponseCallBackInfo info) Sets a response callback.	InvocationRequest
		void setServiceExplicitVersion(String explicitVersion) Specifies the explicit version of the LiveCycle service that this invocation request is bound to.	InvocationRequest
		void setServiceName(String serviceName) Specifies the service name that the client application wants to interact with.	InvocationRequest
		void setServiceOriginalVersion(String originalVersion) Specifies the original version of the LiveCycle service.	InvocationRequest
		void setSynchronous(boolean synchronous) Specifies if the operation is excuted synchronously or asynchronously.	InvocationRequest

Method Detail

getEndPointURI

()

public String getEndPointURI()

Retrieves the endpoint URI used by this invocation request.

Returns

A string value that represents the endpoint URI used by this invocation request.

getInputParameter

()

public Object getInputParameter(String parameterName)

Retrieves the value of the specified parameter. Operation parameters can be any serializable object, including a com.adobe.idp.Document object, a Map object, or a list of Document objects.

Parameters

parameterName — The name of the input parameter.

Returns

The value of the specified input parameter.

See also

setInputParameter(String, Object)

getInputParameters

()

public Map getInputParameters()

Retrieves input parameters that are specified in the invocation request as a java.util.map object. Consider the following invocation request that is sent to the Encryption service to remove password-based encryption from a PDF document:

 Map params = new HashMap();
 FileInputStream fileInputStream = new FileInputStream("C:\\MapPasswordEncrypt.pdf");
 Document inDoc = new Document ;(fileInputStream);
 String myPassword = "password2";
 params.put("inDocument", inDoc);
 params.put("password", myPassword);
 InvocationRequest request = myFactory.createInvocationRequest("EncryptionService", "removePDFPasswordSecurity",params,true);

In this situation, this method returns a java.util.map object that contains a com.adobe.idp.Document object that was passed to the inDocument parameter and a string value that was passed to the to the password parameter. For information about passing parameter values as part of an invocation request, see Invoking LiveCycle Services.

Returns

A java.util.map object that contains input parameters.

See also

setInputParameters()

getInvocationContext

()

public Context getInvocationContext()

Retrieves the com.adobe.idp.Context that is used in this invocation request.

Returns

the com.adobe.idp.Context that is used in this invocation request.

getInvocationId

()

public String getInvocationId()

Returns the identifier value of this invocation request.

Returns

The identifier value of this invocation request.

getOperationName

()

public String getOperationName()

Retrieves the name of the service operation specified by this invocation request. The operation name is specified as a parameter value to the ServiceClientFactory object's createInvocationRequest method.

Returns

The name of the service operation that was specified in the invocation request.

getProperty

()

public Object getProperty(String propertyName)

Retrieves the value of an invocation request property.

Parameters

propertyName — The name of the invocation request property.

Returns

The value of the specified invocation request property. If the property does not exist, then a null value is returned.

See also

setProperty(String, Object)

getProperty

()

public Object getProperty(String propertyName, Object defaultValue)

Retrieves an invocation request property. Properties can be arbitrary. For example, you can pass custom metadata with your request.

Parameters

	`propertyName` — The name of the property.

	`defaultValue` — A default value if the property does not exist in the invocation request.

Returns

The property value or the default value if the property does not exist.

See also

setProperty(String, Object)

getServiceExplicitVersion

()

public String getServiceExplicitVersion()

Retrieves the explicit version of the LiveCycle service.

Returns

A string value that represents the explicit version of a LiveCycle service.

See also

setServiceExplicitVersion(String)

getServiceName

()

public String getServiceName()

Retrieves the LiveCycle service name that is specified in this invocation request. The service name is specified as a parameter value to the ServiceClientFactory object's createInvocationRequest method.

Returns

The service name that is specified in this invocation request.

getServiceOriginalVersion

()

public String getServiceOriginalVersion()

Retrieves the original verion of the LiveCycle service that is specified in this invocation request.

Returns

The original version of the LiveCycle service.

getTargetServiceConfiguration

()

public ServiceConfiguration getTargetServiceConfiguration()

Returns the target service configuration that was resolved based on the service identifier and versioning information specified in this invocation request.

Returns

A ServiceConfiguration object that contains service configuration information.

isSynchronous

()

public boolean isSynchronous()

Determines whether the operation is going to be executed synchronously or asynchronously.

Returns

true if the operation is executed synchronously, otherwise false.

See also

isSynchronous()

removeProperty

()

public Object removeProperty(String propertyName)

Removes an associated property from the invocation request.

Parameters

propertyName — The name of the property to remove.

Returns

The value of the removed property.

setClientParameters

()

public void setClientParameters(Map parameters)

Sets parameter values passed to the LiveCycle service.

Parameters

parameters — A map of parameter values.

setEndPointURI

()

public void setEndPointURI(String endpointURI)

Specifies a valid endpoint URI, which is an address that is used to reference a LiveCycle service either locally or remotely. Endpoint URIs are usually in one of the following form, although a provider implementation can introduce its own scheme:

scheme://[host][:port]/[endpoint name]/[address]?[params]

For example: ejb://localhost:1099/SomeService?method=remoteMethod.

The transport provider scheme must always be specified in an endpoint URI. The host and port value in the endpoint URI is used by providers that support a socket-based protocol, such as tcp, http, and udp. For example: http://localhost:8080.

The name of an endpoint URI is used to refer to a pre-configured end point. If both host/port and the endpoint name are set, the endpoint information is used. The address value of an endpoint URI is used by providers that support addresses such as file path. For example: file:///C:/temp/files.

The params value of an endpoint URI is used to specify properties that are associated with the Transport Provider. For example: file:///inbound/myfiles?filterPattern="*.txt,*.xml".

Note the invocation request end point specification overrides the service name specification.

Parameters

endpointURI — The invocation request endpoint URI that references a LiveCycle service.

setFaultCallback

()

public void setFaultCallback(FaultCallBackInfo info)

Sets a fault callback.

Parameters

info

setInputParameter

()

public void setInputParameter(String parameterName, Object value)

Specifies an input parameter and its value.

Parameters

	`parameterName` — The name of the specified input parameter.

	`value` — The value of the specified input parameter.

See also

getInputParameter(String)

setInputParameters

()

public void setInputParameters(Map inputParameters)

Copies all the values from the specified map to this invocation request's input parameters. Operation parameters can be any serializable object, including a com.adobe.idp.Document object, a java.util.Map object, or a list of Document objects.

Parameters

inputParameters — Copies all of the key pair values from this map object to this invocation request's input parameters. Exisiting key pair values are overwritten by the ones specified in the map object.

setOperationName

()

public void setOperationName(String operationName)

Specifies the service operation name that the client application wants to invoke. The name must match the service definition specified in the LiveCycle Service Registry. You can call this method to replace an existing operation name. The operation name is specified as a parameter value to the ServiceClientFactory object's createInvocationRequest method.

Parameters

operationName — The name of the LiveCycle service operation.

setProperty

()

public void setProperty(String propertyName, Object value)

Specifies an invocation request property. Properties can be arbitrary. For example, you can pass custom metadata with your invocation request.

Parameters

	`propertyName` — The name of the invocation request property.

	`value` — The value of the specified invocation request property.

See also

getProperty(String)

setResponseCallback

()

public void setResponseCallback(ResponseCallBackInfo info)

Sets a response callback.

Parameters

info

setServiceExplicitVersion

()

public void setServiceExplicitVersion(String explicitVersion)

Specifies the explicit version of the LiveCycle service that this invocation request is bound to. The version of the invoking service is handled in the following manner:

No version specification: If a client application does not specify any version information the invocation request is routed to the latest version (Head) of the service.
Explicit version specification: If the client application specifies the explicit version to bind to for a Service, then the invocation request is routed to that specific version.
Original version specification: If the client application specifies the service's original version, the invocation request is routed to the service with the latest version that is compatible with the specified version. A Service version is considered compatible with an inbound request if it has the same Major version number as specifid in the Original version
If both explicit version and original version is specified, the explicit version overrides the original version.

Parameters

explicitVersion — The explicit version of the LiveCycle service.

setServiceName

()

public void setServiceName(String serviceName)

Specifies the service name that the client application wants to interact with. The name of the service has to match the one defined in the LiveCycle Service Registry. The service name is specified as a parameter value to the ServiceClientFactory object's createInvocationRequest method. .

Parameters

serviceName — The service name.

setServiceOriginalVersion

()

public void setServiceOriginalVersion(String originalVersion)

Specifies the original version of the LiveCycle service. The invocation request is routed to the latest version of the LiveCycle service that is compatible with the specified version. The version of the invoking service is handled in the following manner:

Explicit version specification: If the client application specifies the explicit version to bind to for a Service, then the invocation request is routed to that specific version.
Original version specification: If the client application specifies the service's original version, the invocation request is routed to the service with the latest version that is compatible with the specified version. A Service version is considered compatible with an inbound request if it has the same Major version number as specifid in the Original version
If both explicit version and original version is specified, the explicit version overrides the original version.

Parameters

originalVersion — The service original version.

setSynchronous

()

public void setSynchronous(boolean synchronous)

Specifies if the operation is excuted synchronously or asynchronously. A synchronous invocation request is blocked until the LiveCycle service finishes processing the invocation request and returns the result back to the caller.

Parameters

synchronous — Set to true if the invocation request is a synchronous request. Set to false if the invocation request is an asynchronous request.

See also

isSynchronous()

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

LiveCycle ES Java API Reference	All Packages \| All Classes \| Index \| Frames No Frames
Interface InvocationRequest	Methods

Package	com.adobe.idp.dsc
Interface	public interface InvocationRequest