DirectoryConfigurationAD

All Superinterfaces:

DependentObject, DirectoryConfiguration, EngineObject, java.io.Serializable
```
public interface DirectoryConfigurationAD
extends DirectoryConfiguration, DependentObject
```
Represents the configuration object for the Active Directory security provider. You must create a configuration object for each Active Directory forest that is accessed by the FileNet P8 domain. For example, if you have two Active Directory forests to be accessed by the FileNet P8 domain, you need to create two Active Directory-specific DirectoryConfiguration objects--one for each forest. To create an instance of the DirectoryConfigurationAD class, call Factory.DirectoryConfigurationAD.createInstance(). The group of type-specific directory configuration objects is contained in the DirectoryConfigurationADList collection object.
The Active Directory security provider supports the following high-availability failover features: failover by virtual IP, failover by host list, and failover by domain-name or multiple IP addresses.

Metadata

Auditable: false
AllowsInstances: true
AllowsSubClasses: false
ClassDefinitionName: None
IsDependent: true
IsHidden: false
Searchable: false
StorageType: Domain
SuperclassName: DirectoryConfiguration

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`java.lang.Boolean`	`get_AllowEmailOrUPNShortNames()` Returns the value of the AllowEmailOrUPNShortNames property.
`java.lang.Integer`	`get_ConnectionTimeout()` Returns the value of the ConnectionTimeout property.
`java.lang.String`	`get_GCHost()` Returns the value of the GCHost property.
`java.lang.String`	`get_GCPort()` Returns the value of the GCPort property.
`java.lang.Boolean`	`get_ReturnNameAsDN()` Returns the value of the ReturnNameAsDN property.
`java.lang.Boolean`	`get_SearchCrossForestGroupMembership()` Returns the value of the SearchCrossForestGroupMembership property.
`java.lang.Boolean`	`get_UseTokenGroups()` Returns the value of the UseTokenGroups property.
`void`	`set_AllowEmailOrUPNShortNames(java.lang.Boolean value)` Sets the value of the AllowEmailOrUPNShortNames property.
`void`	`set_ConnectionTimeout(java.lang.Integer value)` Sets the value of the ConnectionTimeout property.
`void`	`set_GCHost(java.lang.String value)` Sets the value of the GCHost property.
`void`	`set_GCPort(java.lang.String value)` Sets the value of the GCPort property.
`void`	`set_ReturnNameAsDN(java.lang.Boolean value)` Sets the value of the ReturnNameAsDN property.
`void`	`set_SearchCrossForestGroupMembership(java.lang.Boolean value)` Sets the value of the SearchCrossForestGroupMembership property.
`void`	`set_UseTokenGroups(java.lang.Boolean value)` Sets the value of the UseTokenGroups property.

Methods inherited from interface com.filenet.api.admin.DirectoryConfiguration
get_AuthenticationRealmName, get_DirectoryServerHost, get_DirectoryServerPassword, get_DirectoryServerPort, get_DirectoryServerProviderClass, get_DirectoryServerType, get_DirectoryServerUserName, get_DisplayName, get_ExcludeFromAuthenticatedUsers, get_GroupBaseDN, get_GroupDisplayNameAttribute, get_GroupMembershipSearchFilter, get_GroupNameAttribute, get_GroupSearchFilter, get_GroupUniqueIDAttribute, get_Id, get_IsSSLEnabled, get_PrincipalCategory, get_RestrictMembershipToConfiguredRealms, get_SymbolicName, get_UserBaseDN, get_UserDisplayNameAttribute, get_UserNameAttribute, get_UserSearchFilter, get_UserUniqueIDAttribute, set_AuthenticationRealmName, set_DirectoryServerHost, set_DirectoryServerPassword, set_DirectoryServerPort, set_DirectoryServerProviderClass, set_DirectoryServerUserName, set_DisplayName, set_ExcludeFromAuthenticatedUsers, set_GroupBaseDN, set_GroupDisplayNameAttribute, set_GroupMembershipSearchFilter, set_GroupNameAttribute, set_GroupSearchFilter, set_GroupUniqueIDAttribute, set_IsSSLEnabled, set_PrincipalCategory, set_RestrictMembershipToConfiguredRealms, set_SymbolicName, set_UserBaseDN, set_UserDisplayNameAttribute, set_UserNameAttribute, set_UserSearchFilter, set_UserUniqueIDAttribute

Methods inherited from interface com.filenet.api.core.EngineObject
get_ClassDescription, getClassName, getConnection, getProperties, getSuperClasses

- Method Detail
  - get_SearchCrossForestGroupMembership
```
java.lang.Boolean get_SearchCrossForestGroupMembership()
```
    Returns the value of the SearchCrossForestGroupMembership property. For more information, see SearchCrossForestGroupMembership Property.
  - set_SearchCrossForestGroupMembership
```
void set_SearchCrossForestGroupMembership(java.lang.Boolean value)
```
    Sets the value of the SearchCrossForestGroupMembership property. For more information, see SearchCrossForestGroupMembership Property.
  - get_ReturnNameAsDN
```
java.lang.Boolean get_ReturnNameAsDN()
```
    Returns the value of the ReturnNameAsDN property. For more information, see ReturnNameAsDN Property.
  - set_ReturnNameAsDN
```
void set_ReturnNameAsDN(java.lang.Boolean value)
```
    Sets the value of the ReturnNameAsDN property. For more information, see ReturnNameAsDN Property.
  - get_ConnectionTimeout
```
java.lang.Integer get_ConnectionTimeout()
```
    Returns the value of the ConnectionTimeout property. For more information, see ConnectionTimeout Property.
  - set_ConnectionTimeout
```
void set_ConnectionTimeout(java.lang.Integer value)
```
    Sets the value of the ConnectionTimeout property. For more information, see ConnectionTimeout Property.
  - get_AllowEmailOrUPNShortNames
```
java.lang.Boolean get_AllowEmailOrUPNShortNames()
```
    Returns the value of the AllowEmailOrUPNShortNames property. For more information, see AllowEmailOrUPNShortNames Property.
  - set_AllowEmailOrUPNShortNames
```
void set_AllowEmailOrUPNShortNames(java.lang.Boolean value)
```
    Sets the value of the AllowEmailOrUPNShortNames property. For more information, see AllowEmailOrUPNShortNames Property.
  - get_GCHost
```
java.lang.String get_GCHost()
```
    Returns the value of the GCHost property. For more information, see GCHost Property.
  - set_GCHost
```
void set_GCHost(java.lang.String value)
```
    Sets the value of the GCHost property. For more information, see GCHost Property.
  - get_GCPort
```
java.lang.String get_GCPort()
```
    Returns the value of the GCPort property. For more information, see GCPort Property.
  - set_GCPort
```
void set_GCPort(java.lang.String value)
```
    Sets the value of the GCPort property. For more information, see GCPort Property.
  - get_UseTokenGroups
```
java.lang.Boolean get_UseTokenGroups()
```
    Returns the value of the UseTokenGroups property. For more information, see UseTokenGroups Property.
  - set_UseTokenGroups
```
void set_UseTokenGroups(java.lang.Boolean value)
```
    Sets the value of the UseTokenGroups property. For more information, see UseTokenGroups Property.

Methods inherited from interface com.filenet.api.admin.DirectoryConfiguration

Methods inherited from interface com.filenet.api.core.EngineObject

get_SearchCrossForestGroupMembership

set_SearchCrossForestGroupMembership

get_ReturnNameAsDN

set_ReturnNameAsDN

get_ConnectionTimeout

set_ConnectionTimeout

get_AllowEmailOrUPNShortNames

set_AllowEmailOrUPNShortNames

get_GCHost

set_GCHost

get_GCPort

set_GCPort

get_UseTokenGroups

set_UseTokenGroups