Content Engine Java API: ConfigurationParameter

java.lang.Object
- com.filenet.api.constants.ConfigurationParameter

All Implemented Interfaces:

java.io.Serializable
```
public final class ConfigurationParameter
extends java.lang.Object
implements java.io.Serializable
```
Specifies the parameters that can be used when configuring the Content Engine API.
This class provides a set of constants to specify values for:
- Configuring connections to the IBM FileNet P8 domain.
- Specifying client metadata cache (CMC) configuration options.
- Specifying configuration options for the Enterprise Java™Beans (EJB) transport of the API.
Note: Some constant names are prefixed with "WSI". This prefix refers to the web services transport of the API.

This class includes support for parsing configuration values. With one exception, comparisons and lookups are case-insensitive, so the case of string key equivalents is not significant. The exception is when you set a configuration parameter with a Java system property. In that case, the name you specify must exactly match the case of the property name or it must be the all-lowercase version (for example, –DFileNet.EJB.ContextProperties=FooBar or –Dfilenet.ejb.contextproperties=FooBar). Internally, the exact match is checked first, and only when it is not found is the all-lowercase version checked. (If a configuration item is not found either way, a hard-coded default is used.) Once the system property becomes a ConfigurationParameter instance, case insensitivity is again the normal behavior for comparisons and lookups.

This class also includes an array of valid types, such as {Integer.class, Boolean.class}, to assist you in parsing and validating parameter values. The list is null if not applicable, or is dependent on the context of where the parameter is used. A non-null list always has a length of at least one.

To set parameter values, create an instance of ConfigurationParameters, call ConfigurationParameters.setParameter, passing in the desired parameter values, and then call Configuration.init. The code snippet below sets the block size for retrieving content:
```
      ConfigurationParameters parameters = new ConfigurationParameters();
      Object value = new Integer(64);
      parameters.setParameter(ConfigurationParameter.CONTENT_GET_BLOCK_SIZE_KB, value);
      Configuration.init(parameters);
```
You can also set configuration parameters on the Connection object, or in the FileNet.properties file.
See Also:
ConfigurationParameters, Configuration, Connection, Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static ConfigurationParameter`	`CMC_ENABLED` A constant representing a `ConfigurationParameter` instance of type `CMC_ENABLED`.
`static int`	`CMC_ENABLED_AS_INT` An integer associated with the `CMC_ENABLED` instance of this class.
`static java.lang.String`	`CMC_ENABLED_AS_STRING` A Property name associated with the `CMC_ENABLED` instance of this class.
`static ConfigurationParameter`	`CMC_TIME_TO_LIVE` A constant representing a `ConfigurationParameter` instance of type `CMC_TIME_TO_LIVE`.
`static int`	`CMC_TIME_TO_LIVE_AS_INT` An integer associated with the `CMC_TIME_TO_LIVE` instance of this class.
`static java.lang.String`	`CMC_TIME_TO_LIVE_AS_STRING` A Property name associated with the `CMC_TIME_TO_LIVE` instance of this class.
`static ConfigurationParameter`	`CMC_USER_SPECIFIC` A constant representing a `ConfigurationParameter` instance of type `CMC_USER_SPECIFIC`.
`static int`	`CMC_USER_SPECIFIC_AS_INT` An integer associated with the `CMC_USER_SPECIFIC` instance of this class.
`static java.lang.String`	`CMC_USER_SPECIFIC_AS_STRING` A Property name associated with the `CMC_USER_SPECIFIC` instance of this class.
`static ConfigurationParameter`	`CONNECTION_CLIENT_METADATA_CACHE` A constant representing a `ConfigurationParameter` instance of type `CONNECTION_CLIENT_METADATA_CACHE`.
`static int`	`CONNECTION_CLIENT_METADATA_CACHE_AS_INT` An integer associated with the `CONNECTION_CLIENT_METADATA_CACHE` instance of this class.
`static java.lang.String`	`CONNECTION_CLIENT_METADATA_CACHE_AS_STRING` A Property name associated with the `CONNECTION_CLIENT_METADATA_CACHE` instance of this class.
`static ConfigurationParameter`	`CONNECTION_IMPLEMENTATION_API_LOCATION` A constant representing a `ConfigurationParameter` instance of type `CONNECTION_IMPLEMENTATION_API_LOCATION`.
`static int`	`CONNECTION_IMPLEMENTATION_API_LOCATION_AS_INT` An integer associated with the `CONNECTION_IMPLEMENTATION_API_LOCATION` instance of this class.
`static java.lang.String`	`CONNECTION_IMPLEMENTATION_API_LOCATION_AS_STRING` A Property name associated with the `CONNECTION_IMPLEMENTATION_API_LOCATION` instance of this class.
`static ConfigurationParameter`	`CONNECTION_IMPLEMENTATION_API_LOCATIONS` A constant representing a `ConfigurationParameter` instance of type `CONNECTION_IMPLEMENTATION_API_LOCATIONS`.
`static int`	`CONNECTION_IMPLEMENTATION_API_LOCATIONS_AS_INT` An integer associated with the `CONNECTION_IMPLEMENTATION_API_LOCATIONS` instance of this class.
`static java.lang.String`	`CONNECTION_IMPLEMENTATION_API_LOCATIONS_AS_STRING` A Property name associated with the `CONNECTION_IMPLEMENTATION_API_LOCATIONS` instance of this class.
`static ConfigurationParameter`	`CONNECTION_IMPLEMENTATION_API_URLS` A constant representing a `ConfigurationParameter` instance of type `CONNECTION_IMPLEMENTATION_API_URLS`.
`static int`	`CONNECTION_IMPLEMENTATION_API_URLS_AS_INT` An integer associated with the `CONNECTION_IMPLEMENTATION_API_URLS` instance of this class.
`static java.lang.String`	`CONNECTION_IMPLEMENTATION_API_URLS_AS_STRING` A Property name associated with the `CONNECTION_IMPLEMENTATION_API_URLS` instance of this class.
`static ConfigurationParameter`	`CONNECTION_PARTICIPATES_IN_TRANSACTION` A constant representing a `ConfigurationParameter` instance of type `CONNECTION_PARTICIPATES_IN_TRANSACTION`.
`static int`	`CONNECTION_PARTICIPATES_IN_TRANSACTION_AS_INT` An integer associated with the `CONNECTION_PARTICIPATES_IN_TRANSACTION` instance of this class.
`static java.lang.String`	`CONNECTION_PARTICIPATES_IN_TRANSACTION_AS_STRING` A Property name associated with the `CONNECTION_PARTICIPATES_IN_TRANSACTION` instance of this class.
`static ConfigurationParameter`	`CONTENT_DOWNLOAD_SERVER_AFFINITY_ENABLED` A constant representing a `ConfigurationParameter` instance of type `CONTENT_DOWNLOAD_SERVER_AFFINITY_ENABLED`.
`static int`	`CONTENT_DOWNLOAD_SERVER_AFFINITY_ENABLED_AS_INT` A boolean associated with the `CONTENT_DOWNLOAD_SERVER_AFFINITY_ENABLED` instance of this class.
`static java.lang.String`	`CONTENT_DOWNLOAD_SERVER_AFFINITY_ENABLED_AS_STRING` A Property name associated with the `CONTENT_DOWNLOAD_SERVER_AFFINITY_ENABLED` instance of this class.
`static ConfigurationParameter`	`CONTENT_GET_BLOCK_SIZE_KB` A constant representing a `ConfigurationParameter` instance of type `CONTENT_GET_BLOCK_SIZE_KB`.
`static int`	`CONTENT_GET_BLOCK_SIZE_KB_AS_INT` An integer associated with the `CONTENT_GET_BLOCK_SIZE_KB` instance of this class.
`static java.lang.String`	`CONTENT_GET_BLOCK_SIZE_KB_AS_STRING` A Property name associated with the `CONTENT_GET_BLOCK_SIZE_KB` instance of this class.
`static ConfigurationParameter`	`CONTENT_MAX_UPLOAD_THREADS` A constant representing a `ConfigurationParameter` instance of type `CONTENT_MAX_UPLOAD_THREADS`.
`static int`	`CONTENT_MAX_UPLOAD_THREADS_AS_INT` An integer associated with the `CONTENT_MAX_UPLOAD_THREADS` instance of this class.
`static java.lang.String`	`CONTENT_MAX_UPLOAD_THREADS_AS_STRING` A Property name associated with the `CONTENT_MAX_UPLOAD_THREADS` instance of this class.
`static ConfigurationParameter`	`CONTENT_PUT_BLOCK_SIZE_KB` A constant representing a `ConfigurationParameter` instance of type `CONTENT_PUT_BLOCK_SIZE_KB`.
`static int`	`CONTENT_PUT_BLOCK_SIZE_KB_AS_INT` An integer associated with the `CONTENT_PUT_BLOCK_SIZE_KB` instance of this class.
`static java.lang.String`	`CONTENT_PUT_BLOCK_SIZE_KB_AS_STRING` A Property name associated with the `CONTENT_PUT_BLOCK_SIZE_KB` instance of this class.
`static ConfigurationParameter`	`CONTENT_UPLOAD_SERVER_AFFINITY_ENABLED` A constant representing a `ConfigurationParameter` instance of type `CONTENT_UPLOAD_SERVER_AFFINITY_ENABLED`.
`static int`	`CONTENT_UPLOAD_SERVER_AFFINITY_ENABLED_AS_INT` A boolean associated with the `CONTENT_UPLOAD_SERVER_AFFINITY_ENABLED` instance of this class.
`static java.lang.String`	`CONTENT_UPLOAD_SERVER_AFFINITY_ENABLED_AS_STRING` A Property name associated with the `CONTENT_UPLOAD_SERVER_AFFINITY_ENABLED` instance of this class.
`static ConfigurationParameter`	`EJB_CONTEXT_PROPERTIES` A constant representing a `ConfigurationParameter` instance of type `EJB_CONTEXT_PROPERTIES`.
`static int`	`EJB_CONTEXT_PROPERTIES_AS_INT` An integer associated with the `EJB_CONTEXT_PROPERTIES` instance of this class.
`static java.lang.String`	`EJB_CONTEXT_PROPERTIES_AS_STRING` A Property name associated with the `EJB_CONTEXT_PROPERTIES` instance of this class.
`static java.lang.String`	`WSI_AUTO_DETECT_LTPA_TOKEN` A constant representing a `ConfigurationParameter` instance of type `WSI_AUTO_DETECT_LTPA_TOKEN` By default Client will not auto detect the LTPA token in the subject.
`static ConfigurationParameter`	`WSI_SYSTINET_HOME` Deprecated. This constant is not supported.
`static int`	`WSI_SYSTINET_HOME_AS_INT` Deprecated. This constant is not supported.
`static java.lang.String`	`WSI_SYSTINET_HOME_AS_STRING` Deprecated. This constant is not supported.
`static ConfigurationParameter`	`WSI_SYSTINET_LOGGING_LEVEL` Deprecated. This constant is not supported.
`static int`	`WSI_SYSTINET_LOGGING_LEVEL_AS_INT` Deprecated. This constant is not supported.
`static java.lang.String`	`WSI_SYSTINET_LOGGING_LEVEL_AS_STRING` Deprecated. This constant is not supported.
`static ConfigurationParameter`	`WSI_TRANSPORT_CONNECTION_TIMEOUT` A constant representing a `ConfigurationParameter` instance of type `WSI_TRANSPORT_CONNECTION_TIMEOUT`.
`static int`	`WSI_TRANSPORT_CONNECTION_TIMEOUT_AS_INT` An integer associated with the `WSI_TRANSPORT_CONNECTION_TIMEOUT` instance of this class.
`static java.lang.String`	`WSI_TRANSPORT_CONNECTION_TIMEOUT_AS_STRING` A Property name associated with the `WSI_TRANSPORT_CONNECTION_TIMEOUT` instance of this class.

Method Summary

Methods
Modifier and Type	Method and Description
`static ConfigurationParameter`	`getInstanceFromInt(int value)` Returns an instance of this class using its associated integer value (the *_AS_INT fields).
`static ConfigurationParameter`	`getInstanceFromString(java.lang.String value)` Returns an instance of this class using its associated `String` value.
`int`	`getIntValue()` Returns a constant's internal integer value.
`java.lang.String`	`getStringValue()` Returns a constant's string key equivalent.
`java.lang.Class[]`	`getValueTypes()` Returns an array of valid types, such as `{Integer.class, Boolean.class}`, to assist you in parsing and validating parameter values.
`java.lang.String`	`toString()` Returns the name of a given constant.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - CONNECTION_PARTICIPATES_IN_TRANSACTION_AS_INT
```
public static final int CONNECTION_PARTICIPATES_IN_TRANSACTION_AS_INT
```
    An integer associated with the CONNECTION_PARTICIPATES_IN_TRANSACTION instance of this class.
    
    See Also:
    Constant Field Values
  - CONNECTION_PARTICIPATES_IN_TRANSACTION_AS_STRING
```
public static final java.lang.String CONNECTION_PARTICIPATES_IN_TRANSACTION_AS_STRING
```
    A Property name associated with the CONNECTION_PARTICIPATES_IN_TRANSACTION instance of this class.
    
    See Also:
    Constant Field Values
  - CONNECTION_PARTICIPATES_IN_TRANSACTION
```
public static final ConfigurationParameter CONNECTION_PARTICIPATES_IN_TRANSACTION
```
    A constant representing a ConfigurationParameter instance of type CONNECTION_PARTICIPATES_IN_TRANSACTION.
    There are several ways in which a transaction might have been started. Regardless of how a transaction is started, you may choose whether or not the server participates in the client transaction. By default, the Content Engine server does not participate in client transactions (that is, the default is Boolean.FALSE). For the client to participate in a distributed transaction, you must explicitly set this configuration parameter to Boolean.TRUE when establishing a connection.
    
    When setting transaction participation, the following constraints apply:
    - Transaction participation is not supported for updating GCD objects, such as ObjectStore, Marking, and MarkingSet objects. You can only set transaction participation for updating objects that support the RepositoryObject interface.
    - Do not mix connections that have different values for CONNECTION_PARTICIPATES_IN_TRANSACTION. Doing so can result in a hang condition. As an example, assume the API is participating in a transaction and updates an object. A hang will occur if, from inside the transaction, and prior to database commit or rollback, the API attempts to fetch the same object with a connection that does not participate in a transaction.
    For EJB connections, setting CONNECTION_PARTICIPATES_IN_TRANSACTION to true when the client is not in a transaction does not produce an error. For Content Engine web services (SOAP-based) connections, doing so causes an EngineRuntimeException to be thrown. (The Content Engine web services transport does not support transactions.)
  - CONNECTION_CLIENT_METADATA_CACHE_AS_INT
```
public static final int CONNECTION_CLIENT_METADATA_CACHE_AS_INT
```
    An integer associated with the CONNECTION_CLIENT_METADATA_CACHE instance of this class.
    
    See Also:
    Constant Field Values
  - CONNECTION_CLIENT_METADATA_CACHE_AS_STRING
```
public static final java.lang.String CONNECTION_CLIENT_METADATA_CACHE_AS_STRING
```
    A Property name associated with the CONNECTION_CLIENT_METADATA_CACHE instance of this class.
    
    See Also:
    Constant Field Values
  - CONNECTION_CLIENT_METADATA_CACHE
```
public static final ConfigurationParameter CONNECTION_CLIENT_METADATA_CACHE
```
    A constant representing a ConfigurationParameter instance of type CONNECTION_CLIENT_METADATA_CACHE. This configuration parameter specifies whether to use caching for operations with the given connection. The default is Factory.MetadataCache.getDefaultInstance(), equivalent to Boolean.TRUE, which specifies that caching is used.
  - CMC_ENABLED_AS_INT
```
public static final int CMC_ENABLED_AS_INT
```
    An integer associated with the CMC_ENABLED instance of this class.
    
    See Also:
    Constant Field Values
  - CMC_ENABLED_AS_STRING
```
public static final java.lang.String CMC_ENABLED_AS_STRING
```
    A Property name associated with the CMC_ENABLED instance of this class.
    
    See Also:
    Constant Field Values
  - CMC_ENABLED
```
public static final ConfigurationParameter CMC_ENABLED
```
    A constant representing a ConfigurationParameter instance of type CMC_ENABLED. The default is Boolean.TRUE, which enables client metadata caching.
    Refer to Boolean.valueOf(String) for parsing.
    
    Note: This setting can only be configured during initialization. (See Configuration.init.) This setting affects global client metadata caching. For example, if set to Boolean.FALSE at initialization, you cannot subsequently use ConfigurationParameter.CONNECTION_CLIENT_METADATA_CACHE to enable client metadata caching for a connection.
  - CMC_TIME_TO_LIVE_AS_INT
```
public static final int CMC_TIME_TO_LIVE_AS_INT
```
    An integer associated with the CMC_TIME_TO_LIVE instance of this class.
    
    See Also:
    Constant Field Values
  - CMC_TIME_TO_LIVE_AS_STRING
```
public static final java.lang.String CMC_TIME_TO_LIVE_AS_STRING
```
    A Property name associated with the CMC_TIME_TO_LIVE instance of this class.
    
    See Also:
    Constant Field Values
  - CMC_TIME_TO_LIVE
```
public static final ConfigurationParameter CMC_TIME_TO_LIVE
```
    A constant representing a ConfigurationParameter instance of type CMC_TIME_TO_LIVE. The Time-To-Live (TTL) value is specified in milliseconds; the default is 10 hours. Items are removed from the cache when their TTL expires.
    Note: This can only be configured during initialization. See Configuration.init.
  - CMC_USER_SPECIFIC_AS_INT
```
public static final int CMC_USER_SPECIFIC_AS_INT
```
    An integer associated with the CMC_USER_SPECIFIC instance of this class.
    
    See Also:
    Constant Field Values
  - CMC_USER_SPECIFIC_AS_STRING
```
public static final java.lang.String CMC_USER_SPECIFIC_AS_STRING
```
    A Property name associated with the CMC_USER_SPECIFIC instance of this class.
    
    See Also:
    Constant Field Values
  - CMC_USER_SPECIFIC
```
public static final ConfigurationParameter CMC_USER_SPECIFIC
```
    A constant representing a ConfigurationParameter instance of type CMC_USER_SPECIFIC. The boolean value specifies whether the client metadata cache should be sensitive to user identity. The default is false.
  - WSI_SYSTINET_HOME_AS_INT
```
public static final int WSI_SYSTINET_HOME_AS_INT
```
    Deprecated. This constant is not supported.
    
    See Also:
    Constant Field Values
  - WSI_SYSTINET_HOME_AS_STRING
```
public static final java.lang.String WSI_SYSTINET_HOME_AS_STRING
```
    Deprecated. This constant is not supported.
    
    See Also:
    Constant Field Values
  - WSI_SYSTINET_HOME
```
public static final ConfigurationParameter WSI_SYSTINET_HOME
```
    Deprecated. This constant is not supported.
  - WSI_SYSTINET_LOGGING_LEVEL_AS_INT
```
public static final int WSI_SYSTINET_LOGGING_LEVEL_AS_INT
```
    Deprecated. This constant is not supported.
    
    See Also:
    Constant Field Values
  - WSI_SYSTINET_LOGGING_LEVEL_AS_STRING
```
public static final java.lang.String WSI_SYSTINET_LOGGING_LEVEL_AS_STRING
```
    Deprecated. This constant is not supported.
    
    See Also:
    Constant Field Values
  - WSI_SYSTINET_LOGGING_LEVEL
```
public static final ConfigurationParameter WSI_SYSTINET_LOGGING_LEVEL
```
    Deprecated. This constant is not supported.
  - CONTENT_MAX_UPLOAD_THREADS_AS_INT
```
public static final int CONTENT_MAX_UPLOAD_THREADS_AS_INT
```
    An integer associated with the CONTENT_MAX_UPLOAD_THREADS instance of this class.
    
    See Also:
    Constant Field Values
  - CONTENT_MAX_UPLOAD_THREADS_AS_STRING
```
public static final java.lang.String CONTENT_MAX_UPLOAD_THREADS_AS_STRING
```
    A Property name associated with the CONTENT_MAX_UPLOAD_THREADS instance of this class.
    
    See Also:
    Constant Field Values
  - CONTENT_MAX_UPLOAD_THREADS
```
public static final ConfigurationParameter CONTENT_MAX_UPLOAD_THREADS
```
    A constant representing a ConfigurationParameter instance of type CONTENT_MAX_UPLOAD_THREADS. This value is the maximum number of threads per document that can be used to upload content to the Content Engine server. The default value is 3.
  - CONTENT_PUT_BLOCK_SIZE_KB_AS_INT
```
public static final int CONTENT_PUT_BLOCK_SIZE_KB_AS_INT
```
    An integer associated with the CONTENT_PUT_BLOCK_SIZE_KB instance of this class.
    
    See Also:
    Constant Field Values
  - CONTENT_PUT_BLOCK_SIZE_KB_AS_STRING
```
public static final java.lang.String CONTENT_PUT_BLOCK_SIZE_KB_AS_STRING
```
    A Property name associated with the CONTENT_PUT_BLOCK_SIZE_KB instance of this class.
    
    See Also:
    Constant Field Values
  - CONTENT_PUT_BLOCK_SIZE_KB
```
public static final ConfigurationParameter CONTENT_PUT_BLOCK_SIZE_KB
```
    A constant representing a ConfigurationParameter instance of type CONTENT_PUT_BLOCK_SIZE_KB. This value is the size of the buffer used for each PutContent request to upload content to the Content Engine Server, measured in kilobytes. The default value is 1024. The maximum limit on chunk size for PutContent is 10*1024 (10MB).
  - CONTENT_GET_BLOCK_SIZE_KB_AS_INT
```
public static final int CONTENT_GET_BLOCK_SIZE_KB_AS_INT
```
    An integer associated with the CONTENT_GET_BLOCK_SIZE_KB instance of this class.
    
    See Also:
    Constant Field Values
  - CONTENT_GET_BLOCK_SIZE_KB_AS_STRING
```
public static final java.lang.String CONTENT_GET_BLOCK_SIZE_KB_AS_STRING
```
    A Property name associated with the CONTENT_GET_BLOCK_SIZE_KB instance of this class.
    
    See Also:
    Constant Field Values
  - CONTENT_GET_BLOCK_SIZE_KB
```
public static final ConfigurationParameter CONTENT_GET_BLOCK_SIZE_KB
```
    A constant representing a ConfigurationParameter instance of type CONTENT_GET_BLOCK_SIZE_KB. This value is the number of bytes to get from the Content Engine server on each GetContent request, measured in kilobytes. The default value is 1024 (1 MB).
    As an example, if this value is set to 64, then 64*1024 bytes of content are requested from the Content Engine server for each GetContent request.
  - WSI_TRANSPORT_CONNECTION_TIMEOUT_AS_INT
```
public static final int WSI_TRANSPORT_CONNECTION_TIMEOUT_AS_INT
```
    An integer associated with the WSI_TRANSPORT_CONNECTION_TIMEOUT instance of this class.
    
    See Also:
    Constant Field Values
  - WSI_AUTO_DETECT_LTPA_TOKEN
```
public static final java.lang.String WSI_AUTO_DETECT_LTPA_TOKEN
```
    A constant representing a ConfigurationParameter instance of type WSI_AUTO_DETECT_LTPA_TOKEN By default Client will not auto detect the LTPA token in the subject. This value by default is FALSE,
    
    See Also:
    Constant Field Values
  - WSI_TRANSPORT_CONNECTION_TIMEOUT_AS_STRING
```
public static final java.lang.String WSI_TRANSPORT_CONNECTION_TIMEOUT_AS_STRING
```
    A Property name associated with the WSI_TRANSPORT_CONNECTION_TIMEOUT instance of this class.
    
    See Also:
    Constant Field Values
  - WSI_TRANSPORT_CONNECTION_TIMEOUT
```
public static final ConfigurationParameter WSI_TRANSPORT_CONNECTION_TIMEOUT
```
    A constant representing a ConfigurationParameter instance of type WSI_TRANSPORT_CONNECTION_TIMEOUT. This value determines the amount of time, in milliseconds, allowed before a connection timeout occurs when using the WSI transport. There is no default for this setting. If not set, there will be no timeout; that is, an infinite amount of time is allowed for the API call to complete.
  - EJB_CONTEXT_PROPERTIES_AS_INT
```
public static final int EJB_CONTEXT_PROPERTIES_AS_INT
```
    An integer associated with the EJB_CONTEXT_PROPERTIES instance of this class.
    
    See Also:
    Constant Field Values
  - EJB_CONTEXT_PROPERTIES_AS_STRING
```
public static final java.lang.String EJB_CONTEXT_PROPERTIES_AS_STRING
```
    A Property name associated with the EJB_CONTEXT_PROPERTIES instance of this class.
    
    See Also:
    Constant Field Values
  - EJB_CONTEXT_PROPERTIES
```
public static final ConfigurationParameter EJB_CONTEXT_PROPERTIES
```
    A constant representing a ConfigurationParameter instance of type EJB_CONTEXT_PROPERTIES. The value of this parameter is used to override the default environment for the java.naming.InitialContext that is used to locate the internal EJB used by the API EJB transport. If EJB_CONTEXT_PROPERTIES is not defined, the InitialContext is created with an environment consisting of only a calculated provider URL. JNDI has its own defaulting mechanism used in the absence of explicit environment values.
    The value of this parameter is a string which is itself treated as a collection of properties in the same format as a properties file understood by the java.util.Properties.load() method. Except as described below, all of the properties are then put into the environment for the InitialContext. No case conversion, filtering, or value manipulation is done. java.naming.Context.PROVIDER_URL (java.naming.provider.url) is treated as a special case:
    - If no value is supplied via EJB_CONTEXT_PROPERTIES (including when EJB_CONTEXT_PROPERTIES is not defined at all), then Context.PROVIDER_URL is computed and supplied by taking the scheme, host, and port number portions of the URI supplied to the Connection object.
    - If the value supplied via EJB_CONTEXT_PROPERTIES is literally an exclamation mark ("!"), then no value for Context.PROVIDER_URL is placed into the environment for the InitialContext.
    - Otherwise, any value supplied via EJB_CONTEXT_PROPERTIES is used as-is.
    Here is an example of a setting for this parameter as it might appear in a traditional properties file. Note the convention for embedded newlines.
```
     FileNet.EJB.ContextProperties = java.naming.factory.initial=com.example.InitialContextFactory\n\
       java.naming.referral=follow\n\
       something.else=vendor.value
       
```
  - CONTENT_DOWNLOAD_SERVER_AFFINITY_ENABLED_AS_INT
```
public static final int CONTENT_DOWNLOAD_SERVER_AFFINITY_ENABLED_AS_INT
```
    A boolean associated with the CONTENT_DOWNLOAD_SERVER_AFFINITY_ENABLED instance of this class.
    
    See Also:
    Constant Field Values
  - CONTENT_DOWNLOAD_SERVER_AFFINITY_ENABLED_AS_STRING
```
public static final java.lang.String CONTENT_DOWNLOAD_SERVER_AFFINITY_ENABLED_AS_STRING
```
    A Property name associated with the CONTENT_DOWNLOAD_SERVER_AFFINITY_ENABLED instance of this class.
    
    See Also:
    Constant Field Values
  - CONTENT_DOWNLOAD_SERVER_AFFINITY_ENABLED
```
public static final ConfigurationParameter CONTENT_DOWNLOAD_SERVER_AFFINITY_ENABLED
```
    A constant representing a ConfigurationParameter instance of type CONTENT_DOWNLOAD_SERVER_AFFINITY_ENABLED. This parameter applies to a connection using the EJB transport in a Content Engine server farm.
    Content that is greater than the size specified by the CONTENT_GET_BLOCK_SIZE_KB parameter requires multiple server round trips to retrieve. When the value of this parameter is true, the full download of large content requiring multiple server round trips is handled by the same CE server in the farm. When the value of this parameter is false, the download requests are distributed among multiple servers in the farm, increasing overhead.
    
    The default value is true.
  - CONTENT_UPLOAD_SERVER_AFFINITY_ENABLED_AS_INT
```
public static final int CONTENT_UPLOAD_SERVER_AFFINITY_ENABLED_AS_INT
```
    A boolean associated with the CONTENT_UPLOAD_SERVER_AFFINITY_ENABLED instance of this class.
    
    See Also:
    Constant Field Values
  - CONTENT_UPLOAD_SERVER_AFFINITY_ENABLED_AS_STRING
```
public static final java.lang.String CONTENT_UPLOAD_SERVER_AFFINITY_ENABLED_AS_STRING
```
    A Property name associated with the CONTENT_UPLOAD_SERVER_AFFINITY_ENABLED instance of this class.
    
    See Also:
    Constant Field Values
  - CONTENT_UPLOAD_SERVER_AFFINITY_ENABLED
```
public static final ConfigurationParameter CONTENT_UPLOAD_SERVER_AFFINITY_ENABLED
```
    A constant representing a ConfigurationParameter instance of type CONTENT_UPLOAD_SERVER_AFFINITY_ENABLED. This parameter applies to a connection using the EJB transport in a Content Engine server farm.
    Content that is greater than the size specified by the CONTENT_GET_BLOCK_SIZE_KB parameter requires multiple server round trips to upload. When the value of this parameter is true, the full upload of large content requring multiple server round trips is handled by the same CE server in the farm. When the value of this parameter is false, the upload requests are distributed among multiple servers in the farm, increasing overhead.
    
    The default value is true.
  - CONNECTION_IMPLEMENTATION_API_LOCATION_AS_INT
```
public static final int CONNECTION_IMPLEMENTATION_API_LOCATION_AS_INT
```
    An integer associated with the CONNECTION_IMPLEMENTATION_API_LOCATION instance of this class.
    
    See Also:
    Constant Field Values
  - CONNECTION_IMPLEMENTATION_API_LOCATION_AS_STRING
```
public static final java.lang.String CONNECTION_IMPLEMENTATION_API_LOCATION_AS_STRING
```
    A Property name associated with the CONNECTION_IMPLEMENTATION_API_LOCATION instance of this class.
    
    See Also:
    Constant Field Values
  - CONNECTION_IMPLEMENTATION_API_LOCATION
```
public static final ConfigurationParameter CONNECTION_IMPLEMENTATION_API_LOCATION
```
    A constant representing a ConfigurationParameter instance of type CONNECTION_IMPLEMENTATION_API_LOCATION. This configuration parameter specifies the path to a Content Engine Java API JAR file. That JAR file is typically named Jace.jar, but that is not enforced. It may be used as an alternative to CONNECTION_IMPLEMENTATION_API_LOCATIONS. If both are used, CONNECTION_IMPLEMENTATION_API_LOCATION takes precedence.
    
    The default has no value set.
    
    In an environment where the calling application is using the cross-release classloading feature of the Content Engine Java API, this parameter, obtained from the Connection object, is unconditionally used to locate the implementation version of the API to be used with that Connection. It is an error if the named JAR file does not exist or cannot be read.
    
    See Also:
    CONNECTION_IMPLEMENTATION_API_LOCATIONS, CONNECTION_IMPLEMENTATION_API_URLS
  - CONNECTION_IMPLEMENTATION_API_LOCATIONS_AS_INT
```
public static final int CONNECTION_IMPLEMENTATION_API_LOCATIONS_AS_INT
```
    An integer associated with the CONNECTION_IMPLEMENTATION_API_LOCATIONS instance of this class.
    
    See Also:
    Constant Field Values
  - CONNECTION_IMPLEMENTATION_API_LOCATIONS_AS_STRING
```
public static final java.lang.String CONNECTION_IMPLEMENTATION_API_LOCATIONS_AS_STRING
```
    A Property name associated with the CONNECTION_IMPLEMENTATION_API_LOCATIONS instance of this class.
    
    See Also:
    Constant Field Values
  - CONNECTION_IMPLEMENTATION_API_LOCATIONS
```
public static final ConfigurationParameter CONNECTION_IMPLEMENTATION_API_LOCATIONS
```
    A constant representing a ConfigurationParameter instance of type CONNECTION_IMPLEMENTATION_API_LOCATIONS. This configuration parameter specifies a mapping between Content Engine release numbers and paths to Content Engine Java API JAR files. Those JAR files are typically named Jace.jar, but that is not enforced. Such JAR files should not be on the application classpath. It may be used as an alternative to CONNECTION_IMPLEMENTATION_API_LOCATION. If both are used, CONNECTION_IMPLEMENTATION_API_LOCATION takes precedence. When CONNECTION_IMPLEMENTATION_API_LOCATIONS is used, then CONNECTION_IMPLEMENTATION_API_URLS must also be used.
    
    The default has no value set.
    
    In an environment where the calling application is using the cross-release classloading feature of the Content Engine Java API, this parameter, obtained from the Connection object, is used together with CONNECTION_IMPLEMENTATION_API_URLS to locate the implementation version of the API to be used with that Connection.
    
    To select the applicable API JAR file, the URL obtained from the Connection object is stripped of its query string, if any. It is then used as a key to find a Content Engine release number from among the key/value pairs in CONNECTION_IMPLEMENTATION_API_URLS. That Content Engine release number is then used as a key to find an API JAR location from among the key/value pairs in CONNECTION_IMPLEMENTATION_API_LOCATIONS. The reason for the two-stage search is for convenience when multiple Connection URLs can use the same API JAR file. If either stage of the search gives no result or an empty string result, it is not an error. In such cases, the version of the API already in use by the application, which is called the visible API, is used as a fallback. On the other hand, if the two-stage search does result in the location of an API JAR file, it is an error if the named JAR file does not exist or cannot be read.
    
    The values of CONNECTION_IMPLEMENTATION_API_LOCATIONS and CONNECTION_IMPLEMENTATION_API_URLS are both strings encoding key/value pairs. The syntax rules for both parameters are the same. In each case, the list of pairs is concatenated together with a user-chosen delimiter character. The chosen delimiter must not appear among the keys or values. The trailing delimiter is optional, but the leading delimiter is not. White space immediately before or after a delimiter is ignored. The order of the pairs is not significant.
    
    The use of Content Engine release numbers in both parameter values is only a convention. Any other suitable tags could be used as long as they are used consistently in both parameter values.
    
    Here is an example, with a value for CONNECTION_IMPLEMENTATION_API_LOCATIONS followed by a value for CONNECTION_IMPLEMENTATION_API_URLS:
    
    ^6.0.2.3 ^ /my/vault/Jace-6.0.2.3.jar^ 7.11.0.0 ^ /my/vault/7.11.0.0/Jace.jar
    
    ~http://svr1:9080/x1 ~ 6.0.2.3 ~ https://svr1:9443/wsi/x1 ~ 6.0.2.3 ~ iiop://svr2:2809/y2 ~ 7.11.0.0~
    
    See Also:
    CONNECTION_IMPLEMENTATION_API_URLS, CONNECTION_IMPLEMENTATION_API_LOCATION
  - CONNECTION_IMPLEMENTATION_API_URLS_AS_INT
```
public static final int CONNECTION_IMPLEMENTATION_API_URLS_AS_INT
```
    An integer associated with the CONNECTION_IMPLEMENTATION_API_URLS instance of this class.
    
    See Also:
    Constant Field Values
  - CONNECTION_IMPLEMENTATION_API_URLS_AS_STRING
```
public static final java.lang.String CONNECTION_IMPLEMENTATION_API_URLS_AS_STRING
```
    A Property name associated with the CONNECTION_IMPLEMENTATION_API_URLS instance of this class.
    
    See Also:
    Constant Field Values
  - CONNECTION_IMPLEMENTATION_API_URLS
```
public static final ConfigurationParameter CONNECTION_IMPLEMENTATION_API_URLS
```
    A constant representing a ConfigurationParameter instance of type CONNECTION_IMPLEMENTATION_API_URLS. This configuration parameter specifies a mapping of Connection URLs to Content Engine release numbers. The default is to have no value set. When CONNECTION_IMPLEMENTATION_API_URLS is used, then CONNECTION_IMPLEMENTATION_API_LOCATIONS must also be used.
    
    The default has no value set.
    
    In an environment where the calling application is using the cross-release classloading feature of the Content Engine Java API, this parameter, obtained from the Connection object, is used together with CONNECTION_IMPLEMENTATION_API_LOCATIONS to locate the implementation version of the API to be used with that Connection. For details, see the documentation for CONNECTION_IMPLEMENTATION_API_LOCATIONS.
    
    See Also:
    CONNECTION_IMPLEMENTATION_API_LOCATIONS, CONNECTION_IMPLEMENTATION_API_LOCATION
- Method Detail
  - getIntValue
```
public int getIntValue()
```
    Returns a constant's internal integer value.
    
    Returns:
    The integer value of the constant, such as CMC_ENABLED_AS_INT.
  - getStringValue
```
public java.lang.String getStringValue()
```
    Returns a constant's string key equivalent.
    
    Returns:
    A String value.
  - getValueTypes
```
public java.lang.Class[] getValueTypes()
```
    Returns an array of valid types, such as {Integer.class, Boolean.class}, to assist you in parsing and validating parameter values. The list is null if not applicable or if dependent on the context of where the parameter is used. A non-null list always has a length of at least one.
    
    Returns:
    An array of Class objects.
  - toString
```
public java.lang.String toString()
```
    Returns the name of a given constant.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    A String containing the constant name.
  - getInstanceFromInt
```
public static ConfigurationParameter getInstanceFromInt(int value)
```
    Returns an instance of this class using its associated integer value (the *_AS_INT fields).
    
    Parameters:
    value - An integer representing a particular static instance of this class.
    
    Returns:
    The ConfigurationParameter instance referenced.
  - getInstanceFromString
```
public static ConfigurationParameter getInstanceFromString(java.lang.String value)
```
    Returns an instance of this class using its associated String value.
    
    Parameters:
    value - A String representing a particular static instance of this class.
    
    Returns:
    The ConfigurationParameter instance referenced.
    
    Throws:
    
    EngineRuntimeException - if the input parameter is an invalid value.
    See Also:
    ExceptionCode.API_INVALID_CONFIGURATION_PARAMETER

Methods inherited from class java.lang.Object

CONNECTION_PARTICIPATES_IN_TRANSACTION_AS_INT

CONNECTION_PARTICIPATES_IN_TRANSACTION_AS_STRING

CONNECTION_PARTICIPATES_IN_TRANSACTION

CONNECTION_CLIENT_METADATA_CACHE_AS_INT

CONNECTION_CLIENT_METADATA_CACHE_AS_STRING

CONNECTION_CLIENT_METADATA_CACHE

CMC_ENABLED_AS_INT

CMC_ENABLED_AS_STRING

CMC_ENABLED

CMC_TIME_TO_LIVE_AS_INT

CMC_TIME_TO_LIVE_AS_STRING

CMC_TIME_TO_LIVE

CMC_USER_SPECIFIC_AS_INT

CMC_USER_SPECIFIC_AS_STRING

CMC_USER_SPECIFIC

WSI_SYSTINET_HOME_AS_INT

WSI_SYSTINET_HOME_AS_STRING

WSI_SYSTINET_HOME

WSI_SYSTINET_LOGGING_LEVEL_AS_INT

WSI_SYSTINET_LOGGING_LEVEL_AS_STRING

WSI_SYSTINET_LOGGING_LEVEL

CONTENT_MAX_UPLOAD_THREADS_AS_INT

CONTENT_MAX_UPLOAD_THREADS_AS_STRING

CONTENT_MAX_UPLOAD_THREADS

CONTENT_PUT_BLOCK_SIZE_KB_AS_INT

CONTENT_PUT_BLOCK_SIZE_KB_AS_STRING

CONTENT_PUT_BLOCK_SIZE_KB

CONTENT_GET_BLOCK_SIZE_KB_AS_INT

CONTENT_GET_BLOCK_SIZE_KB_AS_STRING

CONTENT_GET_BLOCK_SIZE_KB

WSI_TRANSPORT_CONNECTION_TIMEOUT_AS_INT

WSI_AUTO_DETECT_LTPA_TOKEN

WSI_TRANSPORT_CONNECTION_TIMEOUT_AS_STRING

WSI_TRANSPORT_CONNECTION_TIMEOUT

EJB_CONTEXT_PROPERTIES_AS_INT

EJB_CONTEXT_PROPERTIES_AS_STRING

EJB_CONTEXT_PROPERTIES

CONTENT_DOWNLOAD_SERVER_AFFINITY_ENABLED_AS_INT

CONTENT_DOWNLOAD_SERVER_AFFINITY_ENABLED_AS_STRING

CONTENT_DOWNLOAD_SERVER_AFFINITY_ENABLED

CONTENT_UPLOAD_SERVER_AFFINITY_ENABLED_AS_INT

CONTENT_UPLOAD_SERVER_AFFINITY_ENABLED_AS_STRING

CONTENT_UPLOAD_SERVER_AFFINITY_ENABLED

CONNECTION_IMPLEMENTATION_API_LOCATION_AS_INT

CONNECTION_IMPLEMENTATION_API_LOCATION_AS_STRING

CONNECTION_IMPLEMENTATION_API_LOCATION

CONNECTION_IMPLEMENTATION_API_LOCATIONS_AS_INT

CONNECTION_IMPLEMENTATION_API_LOCATIONS_AS_STRING

CONNECTION_IMPLEMENTATION_API_LOCATIONS

CONNECTION_IMPLEMENTATION_API_URLS_AS_INT

CONNECTION_IMPLEMENTATION_API_URLS_AS_STRING

CONNECTION_IMPLEMENTATION_API_URLS

getIntValue

getStringValue

getValueTypes

toString

getInstanceFromInt

getInstanceFromString