com.filenet.api.util

Class Configuration

java.lang.Object

com.filenet.api.util.Configuration

public final class Configuration
extends java.lang.Object

Represents a singleton instance of the client's configuration parameters. These parameters are used to control the behavior for various features. In the absence of any setting for a specific parameter, via configuration or programmatic action, an appropriate default is used.

Method Summary

Modifier and Type	Method and Description
static java.lang.Object	getParameter(ConfigurationParameter parameter) Retrieves a configured value.
static void	init(ConfigurationParameters parameters) Initializes and configures the client API.

Methods inherited from class java.lang.Object

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

Method Detail

init

public static void init(ConfigurationParameters parameters)

Initializes and configures the client API. Initialization is optional; if called, it may only be called once per period (a "period" being the life of the client process).

Parameters:

parameters - Configuration values to set on initialization. The API is first configured internally. The parameter values specified on this call, if any, override the values from the internal initialization and configuration.

Throws:

API_INITIALIZED - if the API has previously been initialized.

getParameter

public static java.lang.Object getParameter(ConfigurationParameter parameter)

Retrieves a configured value.

A return value of null indicates that no value has been explicitly configured for the requested parameter and an appropriate default value for the parameter is used instead.

Parameters:

parameter - The parameter for the value to retrieve. See ConfigurationParameter.

Returns:

The Object associated with the requested parameter value. If no value has been configured for the requested parameter, this method returns null.