Represents a group of parameters that define the behavior of the client API. This class is a map of ConfigurationParameter keys to Object values. Instances are initially empty; they are not pre-populated with default values.


The following tables list the members exposed by ConfigurationParameters.

Public Constructors

  Name Description
Static Public method ConfigurationParameters Overloaded. Initializes a new instance of the ConfigurationParameters class.
Top

Protected Constructors

  Name Description
Static Family method ConfigurationParameters Overloaded. Initializes a new instance of the ConfigurationParameters class.
Top

Public Methods

  Name Description
Public method Equals Determines whether the specified Object is equal to the current Object. (inherited from Object)
Public method GetHashCode Serves as a hash function for a particular type. GetHashCode is suitable for use in hashing algorithms and data structures like a hash table. (inherited from Object)
Public method Static GetInstanceFromString Returns an instance of this class using its associated String value.
Public method GetObjectData This method is exposed to satisfy the ISerializable interface.
Public method GetParameter Retrieves a configured value.

A returned value of Null indicates that no value has been explicitly configured for the requested parameter and an appropriate default value for the parameter in question is used instead.

Public method GetType Gets the Type of the current instance. (inherited from Object)
Public method LoadMap Parses a map of key/value pairs into valid ConfigurationParameter keys and Object values. The resulting configuration values are used to populate this ConfigurationParameters class.

A common usage of this method is to load a properties file into an IProperties object and call this method to parse the properties into valid configuration parameters.

Each key must be a ConfigurationParameter or a String. The key is used as-is if it is already a ConfigurationParameter; otherwise, the String is parsed for a valid ConfigurationParameter string value.

All string comparisons and lookups are case-insensitive.

If a String key does not start with "FileNet.", the key/value pair is logged at the debug level but otherwise skipped and ignored. The entire key is then used to look up the corresponding ConfigurationParameter constant; an exception is thrown if it is not found.

The value for a valid key is then parsed. If the value is already of the required type, it is used as-is; otherwise, it is transformed into one of the required types. The type of transformation depends on the parameter and type of value. An exception is thrown if the transformation fails. An exception is also thrown if the given or transformed value is invalid for the parameter.

Public method SetParameter Sets a configuration parameter. If the value of the val argument is Null, this method removes the value. Defaults are used for removed values.
Public method SetParameters Sets the configuration parameters specified in the parameters argument. Other configuration parameters are unchanged. This is equivalent to calling SetParameter(parameter, value) for each parameter with a non-null value in the parameters argument.
Public method ToString Overridden. Returns a String representation of this instance.
Top

Protected Methods

  Name Description
Family method Finalize Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (inherited from Object)
Family method MemberwiseClone Creates a shallow copy of the current Object. (inherited from Object)
Top

Explicit Interface Implementations

  Name Description
Static Private method ConfigurationParameters Overloaded. Initializes a new instance of the ConfigurationParameters class.
Top

See Also