Package com.filenet.api.admin

Provides classes and interfaces that are used in the administration of a FileNet P8 Content Engine Server.

See:
          Description

Interface Summary
AddOn Represents a product extension to the core FileNet P8 Content Engine components.
AddOnInstallationRecord Represents a record that contains information pertaining to the installation of an add-on.
AsyncProcessingConfiguration Represents configuration data for asynchronous processing of events.
AsyncUpgradeQueueItem For internal use only.
AuditDefinition Represents a definition that specifies audit-event parameters.
CenteraFixedContentDevice Represents the description of an EMC Centera fixed content device.
CenteraSiteSettings Represents the configuration settings that can be overridden for the EMC Centera fixed content devices on the specified site.
CFSImportAgentConfiguration Configures the importer component of Content Federation Service (CFS).
CFSSiteSettings For a particular FileNet P8 site, configures the Content Federation Service (CFS).
Choice Represents a single choice item in a choice list that can be assigned to a property, or represents a group node for a nested collection of choice items within a choice list.
ChoiceList Represents a choice list in an object store.
ClassDefinition Represents the class definition (mutable class metadata) of non-versionable, non-subscribable classes.
CmDirectoryConfigurationOID Configuration object for Oracle Directory Server security provider.
CMODApplicationGroup Represents an IBM® Content Manager OnDemand (CMOD) application group that can be configured for content federation.
CMODFixedContentDevice Represents the description of an IBM® Content Manager OnDemand (CMOD) external fixed content storage device.
CmTivoliManagementClass A management class that represents a specific retention setting for an IBM® Tivoli® Storage Manager (TSM) server.
CodeModule Represents a user-implemented Java event handler that executes when an Action-based object's events are raised.
ColumnDefinition Represents the description of a column in a Content Engine database table.
ContentCacheArea Represents a file storage area that stores duplicates of the document content most frequently requested, and permits those duplicates to be accessed in lieu of the originals in order to enhance the document retrieval performance of local servers.
ContentCacheConfiguration Defines the configuration for a content cache.
ContentConfiguration Configures the Content Management Subsystem.
DatabaseStorageArea Represents a storage area for content elements stored in the database.
DirectoryConfiguration Represents the base configuration object for all security providers and holds directory configuration data.
DirectoryConfigurationAD Represents the configuration object for the Active Directory security provider.
DirectoryConfigurationAdam Represents the configuration object for an ADAM or AD LDS security provider.
DirectoryConfigurationCA This interface is not supported.
DirectoryConfigurationIBM Represents the configuration object for an IBM Tivoli security provider.
DirectoryConfigurationNovell Represents the configuration object for a Novell eDirectory security provider.
DirectoryConfigurationSunOne Represents the configuration object for a SunOne security provider.
DITARenditionEngineConnection Represents site-specific connection data for a DITA Rendition Engine that is referenced by a publishing configuration.
DocumentClassDefinition Represents the class definition (mutable class metadata) of the Document class and its subclasses.
DocumentClassificationQueueItem Represents a pending (queued) document auto-classification request.
EventClassDefinition Represents the class definition (mutable class metadata) of event classes whose instances can be subscribed to or audited.
EventQueueItem Represents a pending (queued) execution of an asynchronous event action, or an asynchronous event queue item that remains unprocessed because its retry count is zero.
FileStorageArea Represents a storage area for content elements stored in the file system.
FixedContentDevice Represents the base, abstract class for all classes relating to fixed content devices.
FixedStorageArea Represents a storage area for content elements stored in a fixed content device.
GenericFixedContentDevice Represents the description of a generic fixed content device.
IICEFixedContentDevice Represents an external fixed content device accessible via an instance of IBM Content Integrator (formerly known as Information Integrator Content Edition or IICE).
ImageServicesClassDescription Represents the description of an Image Services document class.
ImageServicesImportAgentConfiguration Represents configuration data for an Image Services import operation.
ImageServicesPropertyDescription Represents the description of an Image Services document class property.
ImageServicesSiteSettings Represents the configuration settings that can be overridden for the Image Services fixed content devices on the specified site.
IMFixedContentDevice Represents the description of a FileNet Image Services fixed content device.
IndexArea Represents the disk storage location and data necessary to perform full-text indexing for content-based retrieval.
IndexJob Initiates and tracks the status of a full text indexing operation.
IndexJobClassItem Identifies the class to be full text indexed.
IndexJobCollectionItem Identifies a Verity collection to be full text indexed.
IndexJobItem Indicates a particular item that is being full text indexed.
IndexJobSingleItem Identifies an object to be full text indexed.
IsolatedRegion Contains all of the connection information necessary to access the Process Engine isolated region.
LocalizedString Provides a means of support for locale-specific display names and descriptive text used by a class definition or property template.
PEConnectionPoint Routes Process Engine requests to an isolated region (IsolatedRegion instance).
PropertyDefinition Represents the base class for all property definition classes.
PropertyDefinitionBinary Represents the definition of a property that holds a binary value.
PropertyDefinitionBoolean Represents the definition of a property that holds a Boolean value.
PropertyDefinitionDateTime Represents the definition of a property that holds a DateTime value.
PropertyDefinitionFloat64 Represents the definition of a property that holds a Double (Float64) value.
PropertyDefinitionId Represents the definition of a property that holds a GUID string value.
PropertyDefinitionInteger32 Represents the definition of a property that holds an integer value.
PropertyDefinitionObject Represents the definition of a property that holds a Content Engine object value.
PropertyDefinitionString Represents the definition of a property that holds a string value.
PropertyTemplate Represents the base class for all property template classes.
PropertyTemplateBinary Represents a property template for creating PropertyDefinitionBinary objects, which you can add to class definitions to create user-defined properties for holding binary values.
PropertyTemplateBoolean Represents a property template for creating PropertyDefinitionBoolean objects, which you can add to class definitions to create user-defined properties for holding Boolean values.
PropertyTemplateDateTime Represents a property template for creating PropertyDefinitionDateTime objects, which you can add to class definitions to create user-defined properties for holding DateTime values.
PropertyTemplateFloat64 Represents a property template for creating PropertyDefinitionFloat64 objects, which you can add to class definitions to create user-defined properties for holding Double (Float64) values.
PropertyTemplateId Represents a property template for creating PropertyDefinitionId objects, which you can add to class definitions to create user-defined properties for holding GUID string values.
PropertyTemplateInteger32 Represents a property template for creating PropertyDefinitionInteger32 objects, which you can add to class definitions to create user-defined properties for holding integer values.
PropertyTemplateObject Represents a property template for creating PropertyDefinitionObject objects, which you can add to class definitions to create user-defined properties for holding Content Engine object values.
PropertyTemplateString Represents a property template for creating PropertyDefinitionString objects, which you can add to class definitions to create user-defined properties for holding string values.
PublishingConfiguration References the configuration data for a publishing operation.
QueueItem This class is the base class for all queue-related classes.
RenditionEngineConnection Represents site-specific connection data for a Rendition Engine that is referenced by a publishing configuration.
ReplicableClassDefinition Represents the class definition (mutable class metadata) of classes of which an object instance can be replicated.
ReplicationConfiguration Represents configuration settings for the replication components of a server.
SecurityPropagationQueueItem Represents a pending (queued) execution of an asynchronous security propagation action on a target object.
ServerCacheConfiguration Defines configuration options for all server caches that do not have object store-specific characteristics.
ServerInstance Represents a single instance of a Java Virtual Machine (JVM) running in an application server.
Site Identifies a geographical area within a FileNet P8 domain.
SiteSettings Represents an abstract, dependent object that provides site-specific, configuration value overrides.
SnapLockFixedContentDevice Represents the description of a NetApp SnapLock fixed content device.
StorageArea Represents the physical storage location where content will be stored.
StoragePolicy Represents a subset of available storage areas that are deemed equivalent based on common, user-specified criteria.
SubscribableClassDefinition Represents the class definition (mutable class metadata) of classes whose instances can be the target of a subscription and can be audited.
SubsystemConfiguration Represents a configuration object related to a particular subsystem or functional area that can be configured relative to a server hierarchy.
TableDefinition Represents the description of a Content Engine database table.
TivoliFixedContentDevice Represents the description of an IBM® Tivoli Storage Manager (TSM) fixed content device.
TraceLoggingConfiguration Configures and enables trace logging on the Content Engine host for the supported subsystems.
UpgradeAddOn Specifies how to upgrade a set of existing add-ons to a new set of add-ons.
VerityCollection Identifies the full text indexing information used for a particular base class and all of its subclasses.
VerityDomainConfiguration Contains the Verity configuration properties that are common to all servers in a domain.
VerityIndexArea Contains information about an index area that is specific to the Verity content-based retrieval engine.
VerityServerConfiguration Contains the Verity configuration data (properties) for a server instance.
VersionableClassDefinition Represents the parent of the DocumentClassDefinition class, which holds the class definition of a Document class and its subclasses.
VirtualServer Represents a logical entity for managing a group of server instances.
XMLPropertyMappingScript Represents the definition of a Document subclass for defining XML property mapping scripts.
 

Class Summary
ContentValidationRequest Represents a data object to be used with the batch form of StorageArea.validateContent.
 

Package com.filenet.api.admin Description

Provides classes and interfaces that are used in the administration of a FileNet P8 Content Engine Server. These classes are used to configure servers and content storage devices within a geographical site, to configure full text indexing and directory service access parameters, and to perform related tasks. This package also contains the classes used to author custom metadata (the class and property definitions that define application-specific metadata). Most of the administration classes reside in the FileNet P8 domain's Global Configuration Data (GCD) database, outside of any object store (although the metadata authoring objects are defined within an object store).



© Copyright IBM Corporation 2006, 2009. All rights reserved.