Represents a collection of resources and services sharing the same Global Configuration Database (GCD). The GCD defines a common set of attributes that control functional characteristics of the collection of resources and services for this domain. The GCD defines domain resources, such as sites (and their related virtual servers and server instances), object store databases, full-text index areas, file storage areas, content cache areas, add-ons, marking sets, and so on. The FileNet P8 domain is also associated with one or more security realms for authenticating users.

Although you can programmatically create a domain, it is not typical to do so. (For a code sample, see "Getting Started Procedures" in the IBM FileNet P8 Content Engine .NET and Java API Developer’s Guide.) In a more typical scenario, you can retrieve a persisted Domain object by calling the GetInstance or FetchInstance method on the Factory.Domain class. You can also retrieve the Domain property of an ObjectStore object.


The following tables list the members exposed by IDomain.

Public Properties

 NameDescription
Public propertyAddOnsSpecifies the add-ons (including upgrade add-ons) registered with a domain.
Public propertyContentCacheAreasA collection of all ContentCacheArea objects associated with the FileNet P8 domain.
Public propertyDefaultSiteIdentifies the default geographical site associated with the FileNet P8 domain. The value of this property is initialized to "Initial Site" when the Content Engine server is initialized and the GCD is created. Initial Site is a system-generated instance of the Site class that holds the Virtual Server (and thus, Server Instance) of the current application server instance. A user with system administrator rights can subsequently assign a different site to be the default, if desired.

If you do not specify a site when creating a site-related object (such as an ObjectStore object), the created object's Site property is set to the value of the DefaultSite property.

Public propertyDirectoryConfigurationsA DirectoryConfigurationList object that specifies the collection of directory server configurations for a given FileNet P8 domain. This collection represents the type-specific directory server configurations for the supported directory servers (Microsoft Active Directory, IBM Tivoli, Novell eDirectory, and SunOne) that will be queried by the Content Engine server when authorizing user and group names for login.
Public propertyDITARenditionEngineConnectionsContains a reference to the DITARenditionEngineConnectionSet object that lists the DITA Rendition Engine connections for this domain.
Public propertyEncryptionAlgorithmA string identifying the algorithm used to encrypt data using the Domain object's public key. The value of this property specifies how to perform the encryption operation using the retrieved key, and takes the form of a Java™ Cryptography Extension (JCE) transform string, for example, RSA/NONE/PKCS1PADDING.
Public propertyExternalRepositoriesSpecifies an ExternalRepositorySet object containing the set collection of ExternalRepository objects associated with this domain.
Public propertyFixedContentDevicesSpecifies the collection of fixed content devices defined for a domain.
Public propertyIdA representation of the Globally Unique Identifier (GUID), a unique 128-bit number, that is assigned to this Content Engine object when the object is created. When converted to a string, the Id property is typically depicted as 32 hexadecimal characters enclosed by brackets in the following format: {xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx}. For example, {3F2504E0-4F89-11D3-9A0C-0305E82C3301}.

For IUser and IGroup classes, the Id property takes the value of the Security Identifier (SID) rather than the 128-bit GUID. The string representation of the SID is in this example format: S-1-5-21-1559522492-2815155736-3711640725-55269. When Active Directory is used as the directory service for IBM FileNet P8, IUser.Id and IGroup.Id always return the current SID for the principal, even if this user or group has only historical SIDs populating the Active Directory server.

For a given property representation, the Id property has the following characteristics:

  • PropertyDescription.Id is equal to PropertyTemplate.Id, which is equal to PropertyDefinition.PrimaryId.
  • PropertyDefinition.Id is not equal to PropertyDefinition.PrimaryId.
  • PropertyDefinition.Id is not equal to PropertyDescription.Id.

For a newly created document object, you can override the Id property of its associated VersionSeries object before you save or check in the document for the first time.

Public propertyIsolatedRegionsAn IsolatedRegionSet object containing the list of isolated regions (IsolatedRegion instances) available in this P8 domain.
Public propertyMarkingSetsSpecifies a collection of MarkingSet objects.
Public propertyNameThe name for this object.

For most classes, this property is read-only and returns the value of the designated name property for the object, or its ID if there is no name property. If ClassDescription.NamePropertyIndex has a value, this property contains the value of the designated name property. If there is no designated name property value, and the object has an Id property, this property contains the string value of the Id property. If neither of these conditions is satisfied, this property contains an empty string.

For a ComponentRelationship object, this property is read/write and specifies the name of the object.

Public propertyObjectStoresReturns the collection of ObjectStore objects associated with a given FileNet P8 domain.
Public propertyObjectStoreSchemaDB2Specifies the default SQL script to use when creating object stores within a DB2 database.

You can customize the supplied default schema script and then submit your customized script when you call the Factory.ObjectStore.CreateInstance(domain, admins, users, schemaScript) method. Typical modifications to the default script include the distribution of the various tables, indexes, and Large Object (LOB) columns across different tablespaces. For more information, see "Working with Object Stores" in the Content Engine Java and .NET API Developer's Guide.

Public propertyObjectStoreSchemaMSSQLSpecifies the default SQL script to use when creating object store within a Microsoft SQL Server database.

You can customize the supplied default schema script and then submit your customized script when you call the Factory.ObjectStore.CreateInstance(domain, admins, users, schemaScript) method. Typical modifications to the default script include the distribution of the various tables, indexes, and Large Object (LOB) columns across different tablespaces. For more information, see "Working with Object Stores" in the Content Engine Java and .NET API Developer's Guide.

Public propertyObjectStoreSchemaOracleSpecifies the default SQL script to use when creating object store within an Oracle database.

You can customize the supplied default schema script and then submit your customized script when you call the Factory.ObjectStore.CreateInstance(domain, admins, users, schemaScript) method. Typical modifications to the default script include the distribution of the various tables, indexes, and Large Object (LOB) columns across different tablespaces. For more information, see "Working with Object Stores" in the Content Engine Java and .NET API Developer's Guide.

Public propertyPEConnectionPointsA PEConnectionPointSet object containing the list of connection points (PEConnectionPoint instances) available in this P8 domain.
Public propertyPermissionDescriptionsA list of descriptions of permissions applicable to objects of the described class.
Public propertyPermissionsManages the discretionary permissions assigned to the object.
Public propertyPublicKeyReturns the public key used for encrypting/signing data (such as passwords and other sensitive properties) sent in requests to the domain. For more information, see the Encryption class.
Public propertyRenditionEngineConnectionsContains a reference to the RenditionEngineConnectionSet object that lists the Rendition Engine connections for this domain.
Public propertyReplicationGroupsThis property is not supported.
Public propertySitesA collection of Site objects for this domain. Each element of the collection represents a geographical area in the domain.
Public propertySubsystemConfigurationsA list of subsystem configuration objects that reflect parameters of the configured subsystems.
Public propertyVerityDomainConfigurationThe Verity configuration attributes that affect the entire domain, and may not be changed on a server by server instance.
Top

See Also