Provides utility classes and interfaces.

ToggleClasses

Type ClassDescription
Public classClientContext
Associates credentials with the current thread or with all of the threads in the process, depending on whether the SetThreadCredentials or the SetProcessCredentials method is called.
Public classConfiguration
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.
Public classConfigurationParameters
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 classExtendedStream
An ExtendedStream is an input stream that can retrieve content at arbitrary positions within the stream. The ExtendedStream class includes methods that can read a certain number of bytes from the stream or read an unspecified number of bytes. The stream keeps track of the last byte position that was read. You can specify a position in the input stream to get to a later or earlier position within the stream.

Although ExtendedStream supports all types of storage devices, the ability to efficiently seek within a content stream is limited to the capabilities of the underlying media, and might not be appropriate for some types of storage devices. For example, the IFileStorageArea, ICmAdvancedStorageArea file system storage device, and content that has been cached in the content cache are optimized to do native re-positioning of the input stream and, therefore, can efficiently seek within a content stream.

Public classFileNetConfigHandler
Provides for the creation of FileNet configuration objects.
Public classId
An immutable class that represents GUID values. This class can be constructed from either a String or a byte array.
Public classUserContext Obsolete.
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:

            UserContext uc = UserContext.Get();
            uc.SetLocale(reqLocale);
            

ToggleInterfaces

Type InterfaceDescription
Public interfaceIClientContextProvider
Provides methods used by the API internals to obtain credentials for each SOAP operation about to be performed. Applications provide an implementation of this interface when the credentials or locale are determined in a manner that does not fit the process-scoped or thread-scoped model represented by the ClientContext.SetProcessCredentials or SetThreadCredentials methods.
Public interfaceICmAbstractSequential
Customizable base for classes of objects that have a system-generated, unique, monotonically increasing sequence number property. ICmAbstractSequential can also be used for new classes of queue entry objects processed by a custom application.

As an abstract class definition, the class' metadata is not mutable. You must subclass this class to create a concrete root class with customizable metadata. The underlying table of the root class provides ordered rows implemented by a column sequence for every insert, which can be used to process entries strictly in the order in which they were created.

See Custom Root Classes Concepts

Public interfaceICmRecoveryBin
A container for ICmRecoveryItem objects. You can retrieve the set of ICmRecoveryItem objects contained in a recovery bin, and perform recover or purge operations on the objects.

The ICmRecoveryBin and ICmRecoveryItem classes support trash-bin functionality implemented in graphical user intefaces of client applications.

See Recovery Bin Concepts.

Public interfaceICmRecoveryItem
A representative for one or more objects that have been marked for deletion. An object marked for deletion is a recoverable object, that is, an object that still exists in the object store database and can be restored.

The recoverable objects represented by a ICmRecoveryItem object consist of an object that was originally marked for deletion by a user, plus any objects referenced by object-valued properties (OVPs) of the original object. The referenced objects are marked for deletion by a cascade-delete operation performed by the server.

In general, recoverable objects cannot be accessed directly; they can only be accessed through the ICmRecoveryItem objects that represent them. A set of recovery items can be retrieved from a ICmRecoveryBin object. By default, a recovery item inherits its permissions from the ICmRecoveryBin object that contains it.

A user can invoke either a recovery method or a delete method on a ICmRecoveryItem object. The recovery operation restores the original object that was marked for deletion and any cascade-deleted objects referenced by OVPs of the original object. The delete method, inherited from IIndependentlyPersistableObject, deletes the original object and any cascade-deleted objects. The delete method functions as a purge operation, in the sense that the deleted objects are removed them from the object store database and cannot be restored.

See Recovery Bin Concepts.