FileNet Content Services
Java Connector v3.0

com.filenet.wcm.api
Interface Domain

All Superinterfaces:
BaseObject, ReadableMetadataObject, java.io.Serializable, ValueObject

public interface Domain
extends BaseObject, ReadableMetadataObject

Not Implemented in CS Java Connector v3.0.

A Domain represents a structure of computers and object stores that are defined by a system administrator and known to the Active Directory on the Content Services server. You can use the Content Services Java Connector's Domain object to retrieve the object stores within the domain, to retrieve properties of the domain, and to retrieve the users and groups defined for the domain.

The primary use of a Domain object within the Java Connector is to obtain access to the object stores within the domain. Calling getDomains, or its XML form, on the EntireNetwork interface returns all of the Domain objects known to the Content Services server. You can then call methods on the Domain interface to retrieve the object stores for each domain.


Field Summary
 
Fields inherited from interface com.filenet.wcm.api.BaseObject
EXPORT_DEFAULT, EXPORT_ENCODED_CONTENT, EXPORT_FULL, EXPORT_OBJECT_ID, EXPORT_OBJECT_SECURITY, IMPORT_DEFAULT, IMPORT_OBJECT_ID, IMPORT_OWNER, IMPORT_PERMISSIONS, TYPE_ACTIVE_MARKING, TYPE_ANNOTATION, TYPE_ANY, TYPE_CBR_ENGINE_TYPE, TYPE_CHOICE, TYPE_CHOICELIST, TYPE_CLASS_SUBSCRIPTION, TYPE_CLASSDEFINITION, TYPE_CLASSDESCRIPTION, TYPE_COLUMN_DEFINITION, TYPE_COMPUTER, TYPE_CONTENT_CACHE_SERVICE, TYPE_CONTENT_MGR_SERVICE, TYPE_CONTENT_REFERENCE, TYPE_CONTENT_TRANSFER, TYPE_CUSTOMOBJECT, TYPE_DOCUMENT, TYPE_DOCUMENT_CLASSIFICATION_ACTION, TYPE_DOCUMENT_LIFECYCLE_ACTION, TYPE_DOCUMENT_LIFECYCLE_POLICY, TYPE_DOCUMENTSTATE, TYPE_DOMAIN, TYPE_DYNAMIC_REFERENTIAL_CONTAINMENT_RELATIONSHIP, TYPE_ENTIRENETWORK, TYPE_EVENT, TYPE_EVENT_ACTION, TYPE_FEATURE_ADD_ON, TYPE_FILESTORE, TYPE_FOLDER, TYPE_GROUP, TYPE_INSTANCE_SUBSCRIPTION, TYPE_LINK, TYPE_LOCALIZED_STRING, TYPE_MARKING_SET, TYPE_MULTIPLEVALUES, TYPE_OBJECT_STORE, TYPE_OBJECTSET, TYPE_OBJSTORE_SERVICE, TYPE_PERMISSION, TYPE_PROPERTY_DEFINITION, TYPE_PROPERTYDESCRIPTION, TYPE_PROPERTYDESCRIPTIONS, TYPE_PUBLISH_REQUEST, TYPE_PUBLISH_TEMPLATE, TYPE_READONLY_OBJECT_SET, TYPE_REALM, TYPE_REFERENTIAL_CONTAINMENT_RELATIONSHIP, TYPE_SECURITY_POLICY, TYPE_SECURITY_TEMPLATE, TYPE_STORAGE_POLICY, TYPE_STORED_SEARCH, TYPE_STYLE_TEMPLATE, TYPE_SUBSCRIPTION, TYPE_TABLE_DEFINITION, TYPE_TRANSIENT, TYPE_USER, TYPE_VERSIONSERIES, TYPE_WORKFLOW_CLASS_SUBSCRIPTION, TYPE_WORKFLOW_INSTANCE_SUBSCRIPTION, TYPE_WORKFLOWDEFINITION, TYPE_XML_PROPERTY_MAPPING_SCRIPT
 
Method Summary
 FeatureAddOn createFeatureAddOn(java.lang.String name, int featureAddOnType, java.lang.String XMLmanifest, java.lang.String pre, java.lang.String post, java.lang.String scriptType, java.lang.String[] predecessors)
          

Not Implemented in CS Java Connector v3.0.

 FeatureAddOns getFeatureAddOns()
          

Not Implemented in CS Java Connector v3.0.

 Groups getGroups()
          

Not Implemented in CS Java Connector v3.0.

 java.lang.String getGroupsXML()
          

Not Implemented in CS Java Connector v3.0.

 ObjectStores getObjectStores()
          

Not Implemented in CS Java Connector v3.0.

 java.lang.String getObjectStoresXML(java.lang.String[] propNames)
          

Not Implemented in CS Java Connector v3.0.

 Users getUsers()
          

Not Implemented in CS Java Connector v3.0.

 java.lang.String getUsersXML()
          

Not Implemented in CS Java Connector v3.0.

 
Methods inherited from interface com.filenet.wcm.api.BaseObject
equals, exportObject, getClassId, getId, getName, getObjectStoreId, getObjectType, getSession, hashCode, thisBaseObject
 
Methods inherited from interface com.filenet.wcm.api.ReadableMetadataObject
getProperties, getProperties, getPropertiesXML, getPropertyBinaryValue, getPropertyBooleanValue, getPropertyDateValue, getPropertyDoubleValue, getPropertyIntValue, getPropertyStringValue, getPropertyValue, getPropertyValuesValue, refresh, refresh
 

Method Detail

getObjectStores

public ObjectStores getObjectStores()

Not Implemented in CS Java Connector v3.0.

Returns an ObjectStores collection whose elements represent the ObjectStore objects in this domain to which the current user has access. (The current user is identified in the Session object.)

This method checks the caller's permission to access each object store but does not login to each object store. Therefore, this method returns and caches only the object store properties that are available without performing a login (for example, Name, DisplayName, DatabaseServerName, and Domain properties). (Note that the getObjectStoresXML method can return all available object store properties.)

Returns:
An ObjectStores collection.

getObjectStoresXML

public java.lang.String getObjectStoresXML(java.lang.String[] propNames)

Not Implemented in CS Java Connector v3.0.

Returns a String that contains an XML representation of this domain's object stores (and their properties, specified as symbolic names) to which the current user has access. (The current user is identified in the Session object.)

If the propNames array is empty or null, this method returns all properties for the object stores to which the current user has access. If the array includes properties that do not exist for the object stores, those properties are ignored (no exception is thrown).

Parameters:
propNames - A String array whose elements specify the symbolic names of the properties to return. (If you pass in a null, you must first explicitly cast it to a String[] to avoid a compilation error.)

Returns:
A String containing an XML representation of the requested properties for the object stores in the domain. For documentation that describes the XML schema used to generate the string, refer to Schemas in the FileNet P8 Developer's Roadmap.

getGroups

public Groups getGroups()

Not Implemented in CS Java Connector v3.0.

Returns a collection of Group objects whose elements represent the groups in the Active Directory for this domain.

Returns:
A collection of Group objects.

getUsers

public Users getUsers()

Not Implemented in CS Java Connector v3.0.

Returns a collection of User objects whose elements represent users in the Active Directory for this domain.

Returns:
A Users collection.

getUsersXML

public java.lang.String getUsersXML()

Not Implemented in CS Java Connector v3.0.

Returns a String in XML representing the users in the Active Directory domain.

Returns:
An XML String representing the users in the Active Directory domain. For documentation that describes the XML schema used to generate the string, refer to Schemas in the FileNet P8 Developer's Roadmap.

getGroupsXML

public java.lang.String getGroupsXML()

Not Implemented in CS Java Connector v3.0.

Returns a String in XML representing the groups in the Active Directory domain.

Returns:
An XML String representing the groups in the Active Directory domain. For documentation that describes the XML schema used to generate the string, refer to Schemas in the FileNet P8 Developer's Roadmap.

getFeatureAddOns

public FeatureAddOns getFeatureAddOns()

Not Implemented in CS Java Connector v3.0.

Returns a collection of FeatureAddOn objects that are registered in this FileNet P8 domain. You can iterate through the returned collection and select the add-on you wish to install on your FileNet P8 system. To install an add-on, call installFeatureAddOn in the ObjectStore interface.

Returns:
A FeatureAddOns collection.

createFeatureAddOn

public FeatureAddOn createFeatureAddOn(java.lang.String name,
                                       int featureAddOnType,
                                       java.lang.String XMLmanifest,
                                       java.lang.String pre,
                                       java.lang.String post,
                                       java.lang.String scriptType,
                                       java.lang.String[] predecessors)

Not Implemented in CS Java Connector v3.0.

Creates a FeatureAddOn object that meets the criteria specified in the input parameters. A feature add-on is an extension to the FileNet P8 base software such as Publishing or third-party extensions. To successfully execute this method, the caller must have permissions to modify all properties (Permission.RIGHT_WRITE) and create child objects (Permission.RIGHT_CREATE_CHILD) on the domain.

This method creates an object that represents the feature add-on and registers the feature add-on in the FileNet P8 Global Configuration Data (GCD) file. In addition, this method moves the XML and/or script files associated with this feature add-on to the SYSINIT directory (./sysconfig/sysinit/AddOns) on the GCD server. To install the feature add-on into an object store, call the installFeatureAddOn method on the ObjectStore interface.

When creating the FeatureAddOn object, you specify its name and type. You can specify the type as "optional" or as "recommended". For descriptions of these types, refer to the FeatureAddOn interface description.

You also specify the XML manifest for the objects associated with this feature add-on. The manifest is an XML string created by the FileNet P8 Enterprise Manager export function, and interpreted by the import function. The XML manifest contains the XML representation of objects associated with the feature add-on.

You may want to customize the import of this FeatureAddOn object at the time it is installed into an object store. You can specify zero or more import scripts to associate with the FeatureAddOn object, in which language (VBScript or JavaScript) a script is written, and if the script is to be executed before or after the import of the FeatureAddOn object takes place. If you do not specify a script, the object as defined within the manifest is imported into the object store with no additional pre- or post-processing performed. Otherwise, scripts are executed at the appropriate time (pre- or post-import, as specified) when the FeatureAddOn object is imported into the object store.

You can also specify predecessors, which are prerequisite add-ons that must be installed prior to installation of this feature add-on. Specifying a predecessor that is not already installed on the object store causes an error to be generated.

Note that once the FeatureAddOn object is installed, you cannot modify its properties. For example, if you create the FeatureAddOn object as a recommended type, you cannot later change its type to optional, nor can you modify the script type or change its predecessors.

Parameters:
name - A String that specifies the name of the feature add-on. A value for this parameter is required.

featureAddOnType - An integer that represents the feature add-on type. Valid values are 1 (recommended) and 2 (optional). Use constants provided in the FeatureAddOn interface to specify the value.

XMLmanifest - A String that contains the XML representation of the objects associated with this feature add-on. A value for this parameter is required.

pre - A String that contains the script to be executed prior to importing the XML manifest for this feature add-on. Can be null if there is no requirement for a pre-import script.

post - A String that contains the script to be executed after importing the XML manifest for this feature add-on. Can be null if there is no requirement for a post-import script.

scriptType - A String that specifies the language type of the script specified in the pre (PreImportScript) or post (PostImportScript) parameters. Valid values are "VBScript" or "JavaScript" or null. Use constants provided in the FeatureAddOn interface. If not specified, "VBScript" is assumed. If both pre- and post-import scripts are specified, the script type applies to both.

predecessors - An array of String objects, each element of which is the name of a prerequisite FeatureAddOn object to this FeatureAddOn object. Can be null if this feature add-on has no prerequisites.

Returns:
A FeatureAddOn object.

FileNet Content Services
Java Connector v3.0