Content Engine Java API: DirectoryConfiguration

All Superinterfaces:

DependentObject, EngineObject, java.io.Serializable

All Known Subinterfaces:

CmDirectoryConfigurationConnections, CmDirectoryConfigurationDomino, CmDirectoryConfigurationOID, CmDirectoryConfigurationRadiantOne, CmDirectoryConfigurationVMM, DirectoryConfigurationAD, DirectoryConfigurationAdam, DirectoryConfigurationCA, DirectoryConfigurationIBM, DirectoryConfigurationNovell, DirectoryConfigurationSunOne
```
public interface DirectoryConfiguration
extends EngineObject, DependentObject
```
Represents the base configuration object for all security providers and holds directory configuration data. The DirectoryConfiguration object is used to configure the directory service providers that are used for authorization checks within the servers.
You can create one or more DirectoryConfiguration objects for each FileNet P8 domain. For example, if you have two Active Directory forests to be accessed by the FileNet P8 domain, you must create two Active Directory-specific DirectoryConfiguration objects--one for each forest. To create an instance of the DirectoryConfiguration class, call the type-specific createInstance factory method. For example, to create an instance of an Active Directory configuration object, call Factory.DirectoryConfigurationAD.createInstance().

Metadata

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

Method Summary

Methods
Modifier and Type	Method and Description
`java.lang.String`	`get_DirectoryServerHost()` Returns the value of the DirectoryServerHost property.
`byte[]`	`get_DirectoryServerPassword()` Returns the value of the DirectoryServerPassword property.
`java.lang.Integer`	`get_DirectoryServerPort()` Returns the value of the DirectoryServerPort property.
`java.lang.String`	`get_DirectoryServerProviderClass()` Returns the value of the DirectoryServerProviderClass property.
`java.lang.String`	`get_DirectoryServerType()` Returns the value of the DirectoryServerType property.
`java.lang.String`	`get_DirectoryServerUserName()` Returns the value of the DirectoryServerUserName property.
`java.lang.String`	`get_DisplayName()` Returns the value of the DisplayName property.
`java.lang.String`	`get_GroupBaseDN()` Returns the value of the GroupBaseDN property.
`java.lang.String`	`get_GroupDisplayNameAttribute()` Returns the value of the GroupDisplayNameAttribute property.
`java.lang.String`	`get_GroupMembershipSearchFilter()` Returns the value of the GroupMembershipSearchFilter property.
`java.lang.String`	`get_GroupNameAttribute()` Returns the value of the GroupNameAttribute property.
`java.lang.String`	`get_GroupSearchFilter()` Returns the value of the GroupSearchFilter property.
`java.lang.String`	`get_GroupUniqueIDAttribute()` Returns the value of the GroupUniqueIDAttribute property.
`Id`	`get_Id()` Returns the value of the Id property.
`java.lang.Boolean`	`get_IsSSLEnabled()` Returns the value of the IsSSLEnabled property.
`java.lang.Boolean`	`get_RestrictMembershipToConfiguredRealms()` Returns the value of the RestrictMembershipToConfiguredRealms property.
`java.lang.String`	`get_UserBaseDN()` Returns the value of the UserBaseDN property.
`java.lang.String`	`get_UserDisplayNameAttribute()` Returns the value of the UserDisplayNameAttribute property.
`java.lang.String`	`get_UserNameAttribute()` Returns the value of the UserNameAttribute property.
`java.lang.String`	`get_UserSearchFilter()` Returns the value of the UserSearchFilter property.
`java.lang.String`	`get_UserUniqueIDAttribute()` Returns the value of the UserUniqueIDAttribute property.
`void`	`set_DirectoryServerHost(java.lang.String value)` Sets the value of the DirectoryServerHost property.
`void`	`set_DirectoryServerPassword(byte[] value)` Sets the value of the DirectoryServerPassword property.
`void`	`set_DirectoryServerPort(java.lang.Integer value)` Sets the value of the DirectoryServerPort property.
`void`	`set_DirectoryServerProviderClass(java.lang.String value)` Sets the value of the DirectoryServerProviderClass property.
`void`	`set_DirectoryServerUserName(java.lang.String value)` Sets the value of the DirectoryServerUserName property.
`void`	`set_DisplayName(java.lang.String value)` Sets the value of the DisplayName property.
`void`	`set_GroupBaseDN(java.lang.String value)` Sets the value of the GroupBaseDN property.
`void`	`set_GroupDisplayNameAttribute(java.lang.String value)` Sets the value of the GroupDisplayNameAttribute property.
`void`	`set_GroupMembershipSearchFilter(java.lang.String value)` Sets the value of the GroupMembershipSearchFilter property.
`void`	`set_GroupNameAttribute(java.lang.String value)` Sets the value of the GroupNameAttribute property.
`void`	`set_GroupSearchFilter(java.lang.String value)` Sets the value of the GroupSearchFilter property.
`void`	`set_GroupUniqueIDAttribute(java.lang.String value)` Sets the value of the GroupUniqueIDAttribute property.
`void`	`set_IsSSLEnabled(java.lang.Boolean value)` Sets the value of the IsSSLEnabled property.
`void`	`set_RestrictMembershipToConfiguredRealms(java.lang.Boolean value)` Sets the value of the RestrictMembershipToConfiguredRealms property.
`void`	`set_UserBaseDN(java.lang.String value)` Sets the value of the UserBaseDN property.
`void`	`set_UserDisplayNameAttribute(java.lang.String value)` Sets the value of the UserDisplayNameAttribute property.
`void`	`set_UserNameAttribute(java.lang.String value)` Sets the value of the UserNameAttribute property.
`void`	`set_UserSearchFilter(java.lang.String value)` Sets the value of the UserSearchFilter property.
`void`	`set_UserUniqueIDAttribute(java.lang.String value)` Sets the value of the UserUniqueIDAttribute property.

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

- Method Detail
  - get_Id
```
Id get_Id()
```
    Returns the value of the Id property. For more information, see Id Property.
  - get_DisplayName
```
java.lang.String get_DisplayName()
```
    Returns the value of the DisplayName property. For more information, see DisplayName Property.
  - set_DisplayName
```
void set_DisplayName(java.lang.String value)
```
    Sets the value of the DisplayName property. For more information, see DisplayName Property.
  - get_DirectoryServerType
```
java.lang.String get_DirectoryServerType()
```
    Returns the value of the DirectoryServerType property. For more information, see DirectoryServerType Property.
  - get_DirectoryServerProviderClass
```
java.lang.String get_DirectoryServerProviderClass()
```
    Returns the value of the DirectoryServerProviderClass property. For more information, see DirectoryServerProviderClass Property.
  - set_DirectoryServerProviderClass
```
void set_DirectoryServerProviderClass(java.lang.String value)
```
    Sets the value of the DirectoryServerProviderClass property. For more information, see DirectoryServerProviderClass Property.
  - get_DirectoryServerHost
```
java.lang.String get_DirectoryServerHost()
```
    Returns the value of the DirectoryServerHost property. For more information, see DirectoryServerHost Property.
  - set_DirectoryServerHost
```
void set_DirectoryServerHost(java.lang.String value)
```
    Sets the value of the DirectoryServerHost property. For more information, see DirectoryServerHost Property.
  - get_DirectoryServerPort
```
java.lang.Integer get_DirectoryServerPort()
```
    Returns the value of the DirectoryServerPort property. For more information, see DirectoryServerPort Property.
  - set_DirectoryServerPort
```
void set_DirectoryServerPort(java.lang.Integer value)
```
    Sets the value of the DirectoryServerPort property. For more information, see DirectoryServerPort Property.
  - get_DirectoryServerUserName
```
java.lang.String get_DirectoryServerUserName()
```
    Returns the value of the DirectoryServerUserName property. For more information, see DirectoryServerUserName Property.
  - set_DirectoryServerUserName
```
void set_DirectoryServerUserName(java.lang.String value)
```
    Sets the value of the DirectoryServerUserName property. For more information, see DirectoryServerUserName Property.
  - get_DirectoryServerPassword
```
byte[] get_DirectoryServerPassword()
```
    Returns the value of the DirectoryServerPassword property. For more information, see DirectoryServerPassword Property.
  - set_DirectoryServerPassword
```
void set_DirectoryServerPassword(byte[] value)
```
    Sets the value of the DirectoryServerPassword property. For more information, see DirectoryServerPassword Property.
  - get_UserBaseDN
```
java.lang.String get_UserBaseDN()
```
    Returns the value of the UserBaseDN property. For more information, see UserBaseDN Property.
  - set_UserBaseDN
```
void set_UserBaseDN(java.lang.String value)
```
    Sets the value of the UserBaseDN property. For more information, see UserBaseDN Property.
  - get_UserSearchFilter
```
java.lang.String get_UserSearchFilter()
```
    Returns the value of the UserSearchFilter property. For more information, see UserSearchFilter Property.
  - set_UserSearchFilter
```
void set_UserSearchFilter(java.lang.String value)
```
    Sets the value of the UserSearchFilter property. For more information, see UserSearchFilter Property.
  - get_UserDisplayNameAttribute
```
java.lang.String get_UserDisplayNameAttribute()
```
    Returns the value of the UserDisplayNameAttribute property. For more information, see UserDisplayNameAttribute Property.
  - set_UserDisplayNameAttribute
```
void set_UserDisplayNameAttribute(java.lang.String value)
```
    Sets the value of the UserDisplayNameAttribute property. For more information, see UserDisplayNameAttribute Property.
  - get_GroupBaseDN
```
java.lang.String get_GroupBaseDN()
```
    Returns the value of the GroupBaseDN property. For more information, see GroupBaseDN Property.
  - set_GroupBaseDN
```
void set_GroupBaseDN(java.lang.String value)
```
    Sets the value of the GroupBaseDN property. For more information, see GroupBaseDN Property.
  - get_GroupSearchFilter
```
java.lang.String get_GroupSearchFilter()
```
    Returns the value of the GroupSearchFilter property. For more information, see GroupSearchFilter Property.
  - set_GroupSearchFilter
```
void set_GroupSearchFilter(java.lang.String value)
```
    Sets the value of the GroupSearchFilter property. For more information, see GroupSearchFilter Property.
  - get_GroupDisplayNameAttribute
```
java.lang.String get_GroupDisplayNameAttribute()
```
    Returns the value of the GroupDisplayNameAttribute property. For more information, see GroupDisplayNameAttribute Property.
  - set_GroupDisplayNameAttribute
```
void set_GroupDisplayNameAttribute(java.lang.String value)
```
    Sets the value of the GroupDisplayNameAttribute property. For more information, see GroupDisplayNameAttribute Property.
  - get_GroupMembershipSearchFilter
```
java.lang.String get_GroupMembershipSearchFilter()
```
    Returns the value of the GroupMembershipSearchFilter property. For more information, see GroupMembershipSearchFilter Property.
  - set_GroupMembershipSearchFilter
```
void set_GroupMembershipSearchFilter(java.lang.String value)
```
    Sets the value of the GroupMembershipSearchFilter property. For more information, see GroupMembershipSearchFilter Property.
  - get_UserNameAttribute
```
java.lang.String get_UserNameAttribute()
```
    Returns the value of the UserNameAttribute property. For more information, see UserNameAttribute Property.
  - set_UserNameAttribute
```
void set_UserNameAttribute(java.lang.String value)
```
    Sets the value of the UserNameAttribute property. For more information, see UserNameAttribute Property.
  - get_GroupNameAttribute
```
java.lang.String get_GroupNameAttribute()
```
    Returns the value of the GroupNameAttribute property. For more information, see GroupNameAttribute Property.
  - set_GroupNameAttribute
```
void set_GroupNameAttribute(java.lang.String value)
```
    Sets the value of the GroupNameAttribute property. For more information, see GroupNameAttribute Property.
  - get_IsSSLEnabled
```
java.lang.Boolean get_IsSSLEnabled()
```
    Returns the value of the IsSSLEnabled property. For more information, see IsSSLEnabled Property.
  - set_IsSSLEnabled
```
void set_IsSSLEnabled(java.lang.Boolean value)
```
    Sets the value of the IsSSLEnabled property. For more information, see IsSSLEnabled Property.
  - get_RestrictMembershipToConfiguredRealms
```
java.lang.Boolean get_RestrictMembershipToConfiguredRealms()
```
    Returns the value of the RestrictMembershipToConfiguredRealms property. For more information, see RestrictMembershipToConfiguredRealms Property.
  - set_RestrictMembershipToConfiguredRealms
```
void set_RestrictMembershipToConfiguredRealms(java.lang.Boolean value)
```
    Sets the value of the RestrictMembershipToConfiguredRealms property. For more information, see RestrictMembershipToConfiguredRealms Property.
  - get_UserUniqueIDAttribute
```
java.lang.String get_UserUniqueIDAttribute()
```
    Returns the value of the UserUniqueIDAttribute property. For more information, see UserUniqueIDAttribute Property.
  - set_UserUniqueIDAttribute
```
void set_UserUniqueIDAttribute(java.lang.String value)
```
    Sets the value of the UserUniqueIDAttribute property. For more information, see UserUniqueIDAttribute Property.
  - get_GroupUniqueIDAttribute
```
java.lang.String get_GroupUniqueIDAttribute()
```
    Returns the value of the GroupUniqueIDAttribute property. For more information, see GroupUniqueIDAttribute Property.
  - set_GroupUniqueIDAttribute
```
void set_GroupUniqueIDAttribute(java.lang.String value)
```
    Sets the value of the GroupUniqueIDAttribute property. For more information, see GroupUniqueIDAttribute Property.

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

get_Id

get_DisplayName

set_DisplayName

get_DirectoryServerType

get_DirectoryServerProviderClass

set_DirectoryServerProviderClass

get_DirectoryServerHost

set_DirectoryServerHost

get_DirectoryServerPort

set_DirectoryServerPort

get_DirectoryServerUserName

set_DirectoryServerUserName

get_DirectoryServerPassword

set_DirectoryServerPassword

get_UserBaseDN

set_UserBaseDN

get_UserSearchFilter

set_UserSearchFilter

get_UserDisplayNameAttribute

set_UserDisplayNameAttribute

get_GroupBaseDN

set_GroupBaseDN

get_GroupSearchFilter

set_GroupSearchFilter

get_GroupDisplayNameAttribute

set_GroupDisplayNameAttribute

get_GroupMembershipSearchFilter

set_GroupMembershipSearchFilter

get_UserNameAttribute

set_UserNameAttribute

get_GroupNameAttribute

set_GroupNameAttribute

get_IsSSLEnabled

set_IsSSLEnabled

get_RestrictMembershipToConfiguredRealms

set_RestrictMembershipToConfiguredRealms

get_UserUniqueIDAttribute

set_UserUniqueIDAttribute

get_GroupUniqueIDAttribute

set_GroupUniqueIDAttribute