Provides utility classes and interfaces.


Classes

  Class Description
Public class Configuration 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 value is used. This is a static class (Module in Visual Basic)static classModule and so cannot be inherited or instantiated.
Public class ConfigurationParameters 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.
Public class Encryption Used to encrypt sensitive properties, such as passwords, that are sent to the Content Engine server. The encryption is done using the public key retrieved from the Domain object associated with the object containing the sensitive property. Once the property is received on the server, it is decrypted with the domain's private key, then encrypted with the Content Engine master key prior to being persisted. Thus, this mechanism is intended to encrypt values only during transmission to the server, where they are immediately decrypted.

Static methods are available for encrypting bytes, chars, and Strings. Note that the use of the method that encrypts Strings is discouraged, as Strings are immutable, so the sensitive data can remain in memory, posing a security risk, or it can be inadvertently written to disk as a result of exception handling or logging activity. Any char or byte array passed to an encrypt method is overwritten once the encryption has been performed. If the application needs to use the sensitive data after encryption, which should be an unusual case, it must make a copy prior to encryption.

chars and Strings are UTF-8 encoded prior to being encrypted.

Public class FileNetConfigHandler Provides for the creation of FileNet configuration objects.
Public class Id An immutable class that represents GUID values. This class can be constructed from either a String or a byte array.
Public class UserContext Required for setting the security token that will be used for all connections in the current thread or process.

A call to either SetThreadSecurityToken or SetProcessSecurityToken is required to communicate with the Content Engine server. When a SecurityToken is specified, a request to the server is limited, through authorization access control, to the operations that have been granted to the specified principal. Correspondingly, if a locale is specified, the server attempts to return localizable messages, such as exception text, according to the language code specified by the locale.

As noted above, UserContext operations are performed on a per-thread or per-process basis. When working with multiple locales, for example when servicing requests via a thread pool, you must explicitly call SetLocale at the beginning of each new thread (request). The following code snippet illustrates the call to make at the startup phase of every request, where reqLocale is the locale (System.Globalization.CultureInfo) to be used for this request:

 Copy Code
            UserContext uc = UserContext.Get();
            uc.SetLocale(reqLocale);
            
Public class Win32  

Structures

  Structure Description
Public structure CERT_PUBLIC_KEY_INFO  
Public structure PUB_KEY_BLOB_HEADERS