com.adobe.idp.dsc.clientsdk
Class ServiceClientFactoryProperties

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

public abstract class ServiceClientFactoryProperties
extends java.lang.Object

Represents properties used to invoke LiveCycle services. For information about setting property values, see Invoking LiveCycle Services.

Field Summary

static java.lang.String	DSC_CALLER_OPERATION Set by LiveCycle to enable the target service to identify the caller in the case of nested service invocations.
static java.lang.String	DSC_CALLER_SERVICE Set by LiveCycle to enable the target service to identify the caller in the case of nested service invocations.
static java.lang.String	DSC_CALLER_VERSION Set by LiveCycle to enable the target service to identify the caller in the case of nested service invocations.
static java.lang.String	DSC_CLIENTSERVICE_FACTORY_CLASS Specifies the client service factory class.
static java.lang.String	DSC_CONTEXT Represents the context of the LiveCycle component.
static java.lang.String	DSC_CREDENTIAL Represents a credential specification.
static java.lang.String	DSC_CREDENTIAL_PASSWORD Represents a LiveCycle password.
static java.lang.String	DSC_CREDENTIAL_USERNAME Represents a LiveCycle user name.
static java.lang.String	DSC_DEFAULT_EJB_ENDPOINT Specifies the default EJB end point.
static java.lang.String	DSC_DEFAULT_SOAP_ENDPOINT Specifies the default SOAP end point.
static java.lang.String	DSC_DIRECT_PASSTHROUGH An IN VM Passthrough stratgey that allows the VM provider to pass input and output parameters directly between the client and the target Service.
static java.lang.String	DSC_DOCUMENT_HTTP_CHUNKED_STREAMING_BUFFER_LENGTH The chunked streaming buffer length used during Document client side push to the server over HTTP.
static java.lang.String	DSC_DOCUMENT_HTTP_ENDPOINT Specifies the HTTP end point used for uploading/downloading the content of the com.adobe.idp.Document object.
static java.lang.String	DSC_DOCUMENT_HTTP_FIXED_LENGTH_STREAMING True (default) if Document client side push to the server over HTTP should use the JDK's fixed length streaming mode, false otherwise.
static java.lang.String	DSC_EJB_PROTOCOL Specifies the EJB protocol.
static java.lang.String	DSC_IN_VM_PASSTHROUGH_STRATEGY Specifies the stratgy to use when non-managed clients (for example, Non DSCs) are sending invocation requests through the VM provider, whereby two ClassLoaders are involved; the Clients ClassLoader and the DSC's ClassLoader.
static java.lang.String	DSC_JBOSS_SERVER_TYPE Specifies that LiveCycle is deployed on a JBoss J2EE Application Server.
static java.lang.String	DSC_PASSTHROUGH_BY_PROXY An IN VM Passthrough stratgey that forces the VM provider to create a Proxy around input and output parameters allowing them to work across what would typically be incompatible ClassLoaders.
static java.lang.String	DSC_PASSTHROUGH_BY_SERIALIZATION An IN VM Passthrough stratgey that forces the VM provider to automatically serialize the requests and responses sent between a caller and the target Service.
static java.lang.String	DSC_PROVIDER_PROPERTIES_RESOURCE The resource path (per ClassLoader.getResource()) where the Provider.properties can be found.
static java.lang.String	DSC_SERVER_TYPE Specifies the server type of the J2EE application server on which LiveCycle is deployed.
static java.lang.String	DSC_SOAP_PROTOCOL Specifies the SOAP protocol.
static java.lang.String	DSC_TRANSPORT_PROTOCOL Specifies the client transport protocol.
static java.lang.String	DSC_WEBLOGIC_SERVER_TYPE Specifies that LiveCycle is deployed on a BEA WebLogic J2EE Application Server.
static java.lang.String	DSC_WEBSPHERE_SERVER_TYPE Specifies that LiveCycle is deployed on an IBM WebSphere J2EE Application Server.

Constructor Summary

ServiceClientFactoryProperties()

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

DSC_CLIENTSERVICE_FACTORY_CLASS

public static java.lang.String DSC_CLIENTSERVICE_FACTORY_CLASS

Specifies the client service factory class. This property is optional.

DSC_TRANSPORT_PROTOCOL

public static final java.lang.String DSC_TRANSPORT_PROTOCOL

Specifies the client transport protocol. This is the property name to be used with value DSC_EJB_PROTOCOL or DSC_SOAP_PROTOCOL. This setting is defaulted to DSC_EJB_PROTOCOL.

See Also:

Constant Field Values

DSC_EJB_PROTOCOL

public static final java.lang.String DSC_EJB_PROTOCOL

Specifies the EJB protocol.

See Also:

Constant Field Values

DSC_SOAP_PROTOCOL

public static final java.lang.String DSC_SOAP_PROTOCOL

Specifies the SOAP protocol.

See Also:

Constant Field Values

DSC_SERVER_TYPE

public static final java.lang.String DSC_SERVER_TYPE

Specifies the server type of the J2EE application server on which LiveCycle is deployed.

See Also:

Constant Field Values

DSC_WEBSPHERE_SERVER_TYPE

public static final java.lang.String DSC_WEBSPHERE_SERVER_TYPE

Specifies that LiveCycle is deployed on an IBM WebSphere J2EE Application Server.

See Also:

Constant Field Values

DSC_WEBLOGIC_SERVER_TYPE

public static final java.lang.String DSC_WEBLOGIC_SERVER_TYPE

Specifies that LiveCycle is deployed on a BEA WebLogic J2EE Application Server.

See Also:

Constant Field Values

DSC_JBOSS_SERVER_TYPE

public static final java.lang.String DSC_JBOSS_SERVER_TYPE

Specifies that LiveCycle is deployed on a JBoss J2EE Application Server.

See Also:

Constant Field Values

DSC_DEFAULT_EJB_ENDPOINT

public static java.lang.String DSC_DEFAULT_EJB_ENDPOINT

Specifies the default EJB end point.

DSC_DEFAULT_SOAP_ENDPOINT

public static java.lang.String DSC_DEFAULT_SOAP_ENDPOINT

Specifies the default SOAP end point.

DSC_DOCUMENT_HTTP_ENDPOINT

public static java.lang.String DSC_DOCUMENT_HTTP_ENDPOINT

Specifies the HTTP end point used for uploading/downloading the content of the com.adobe.idp.Document object. This property is typically used with DSC_EJB_PROTOCOL. If the DSC_DOCUMENT_HTTP_ENDPOINT is not specified, DSC_EJB_PROTOCOL uses the RMI/IIOP protocol to upload/download the content. The RMI/IIOP protocol is typically slower than HTTP.

DSC_DOCUMENT_HTTP_FIXED_LENGTH_STREAMING

public static java.lang.String DSC_DOCUMENT_HTTP_FIXED_LENGTH_STREAMING

True (default) if Document client side push to the server over HTTP should use the JDK's fixed length streaming mode, false otherwise. This applies when the document is initialized with a source whose length can be determined apriori. (File, some URLs, inline bytes) Fixed length streaming uses the JDK's HTTPURLConnection.setFixedLengthStreamingMode. This mode should work with virtually all web servers, proxies and app servers. False may be set for this parameter in the unlikely event problems are seen with Document corruption or rejection during upload in your environment.

DSC_DOCUMENT_HTTP_CHUNKED_STREAMING_BUFFER_LENGTH

public static java.lang.String DSC_DOCUMENT_HTTP_CHUNKED_STREAMING_BUFFER_LENGTH

The chunked streaming buffer length used during Document client side push to the server over HTTP. Pass -1 (the default) to disable chunked streaming. Pass 0 to request the default buffer length (currently 65530). Chunked streaming uses the JDK's HTTPURLConnection.setChunkedStreamingMode. Not all Document initializations allow fixed length streaming FTP URLs for example don't provide a length upfront and require chunked streaming for efficient transport. Lack of a streaming mode requires the entire content to be read into memory before it can be sent to the server. This can result in an OutOfMemoryError if the JVM heap is too small. Enable this setting to avoid OutOfMemoryErrors uploading large content whose size is not known apriori, such as FTP URLs. But chunked streaming isn't supported by all web servers, proxies and app servers, so this setting defaults to disabling chunked streaming. Enable this setting with a value of 0 or something preferably 4096 or higher if your environment supports chunked streaming

DSC_CREDENTIAL

public static java.lang.String DSC_CREDENTIAL

Represents a credential specification.

DSC_CREDENTIAL_USERNAME

public static java.lang.String DSC_CREDENTIAL_USERNAME

Represents a LiveCycle user name.

DSC_CREDENTIAL_PASSWORD

public static java.lang.String DSC_CREDENTIAL_PASSWORD

Represents a LiveCycle password.

DSC_CONTEXT

public static java.lang.String DSC_CONTEXT

Represents the context of the LiveCycle component.

DSC_CALLER_SERVICE

public static java.lang.String DSC_CALLER_SERVICE

Set by LiveCycle to enable the target service to identify the caller in the case of nested service invocations.

DSC_CALLER_VERSION

public static java.lang.String DSC_CALLER_VERSION

Set by LiveCycle to enable the target service to identify the caller in the case of nested service invocations.

DSC_CALLER_OPERATION

public static java.lang.String DSC_CALLER_OPERATION

Set by LiveCycle to enable the target service to identify the caller in the case of nested service invocations.

DSC_IN_VM_PASSTHROUGH_STRATEGY

public static java.lang.String DSC_IN_VM_PASSTHROUGH_STRATEGY

Specifies the stratgy to use when non-managed clients (for example, Non DSCs) are sending invocation requests through the VM provider, whereby two ClassLoaders are involved; the Clients ClassLoader and the DSC's ClassLoader. If the two ClassLoaders are different and the InVM Provider is used, either SERIALIZATION or PROXY must be specified. Otherwise a ClassCastException or IllegalArgumentException are likely to occur.

DSC_PASSTHROUGH_BY_SERIALIZATION

public static java.lang.String DSC_PASSTHROUGH_BY_SERIALIZATION

An IN VM Passthrough stratgey that forces the VM provider to automatically serialize the requests and responses sent between a caller and the target Service.

DSC_PASSTHROUGH_BY_PROXY

public static java.lang.String DSC_PASSTHROUGH_BY_PROXY

An IN VM Passthrough stratgey that forces the VM provider to create a Proxy around input and output parameters allowing them to work across what would typically be incompatible ClassLoaders.

DSC_DIRECT_PASSTHROUGH

public static java.lang.String DSC_DIRECT_PASSTHROUGH

An IN VM Passthrough stratgey that allows the VM provider to pass input and output parameters directly between the client and the target Service.

DSC_PROVIDER_PROPERTIES_RESOURCE

public static java.lang.String DSC_PROVIDER_PROPERTIES_RESOURCE

The resource path (per ClassLoader.getResource()) where the Provider.properties can be found.

Constructor Detail

ServiceClientFactoryProperties

public ServiceClientFactoryProperties()