com.filenet.api.engine

Class DirectoryInfo

java.lang.Object

com.filenet.api.engine.DirectoryInfo

public class DirectoryInfo
extends java.lang.Object

For Internal Use Only. Holds directory configuration data. This class has a one-to-one relationship with the DirectoryConfiguration class.

Constructor Summary

Constructors

Constructor and Description
DirectoryInfo(DirectoryServiceProvider provider, java.lang.String host, java.lang.String port, java.lang.String principal, java.lang.String credential, boolean isSSLEnabled, java.lang.String sslSocketFactory, java.lang.String userBaseDN, java.lang.String userSearchFilter, java.lang.String userShortNameAttribute, java.lang.String userDisplayNameAttribute, java.lang.String userUniqueIDAttribute, boolean userUniqueIDAttributeIsBinary, java.lang.String groupBaseDN, java.lang.String groupSearchFilter, java.lang.String groupMembershipFilter, java.lang.String groupShortNameAttribute, java.lang.String groupDisplayNameAttribute, boolean restrictMembershipToLocalRealm, java.lang.String groupUniqueIDAttribute, boolean groupUniqueIDAttributeIsBinary, boolean searchDynamicGroup, java.lang.String dynamicGroupMemberAttribute, java.lang.String dynamicGroupQueryAttribute, java.lang.String dynamicGroupObjectClass)
DirectoryInfo(DirectoryServiceProvider provider, java.lang.String host, java.lang.String port, java.lang.String principal, java.lang.String credential, boolean isSSLEnabled, java.lang.String sslSocketFactory, java.lang.String userBaseDN, java.lang.String userSearchFilter, java.lang.String userShortNameAttribute, java.lang.String userDisplayNameAttribute, java.lang.String groupBaseDN, java.lang.String groupSearchFilter, java.lang.String groupMembershipFilter, java.lang.String groupShortNameAttribute, java.lang.String groupDisplayNameAttribute) For Internal Use Only.
DirectoryInfo(DirectoryServiceProvider provider, java.lang.String host, java.lang.String port, java.lang.String principal, java.lang.String credential, boolean isSSLEnabled, java.lang.String sslSocketFactory, java.lang.String userBaseDN, java.lang.String userSearchFilter, java.lang.String userShortNameAttribute, java.lang.String userDisplayNameAttribute, java.lang.String groupBaseDN, java.lang.String groupSearchFilter, java.lang.String groupMembershipFilter, java.lang.String groupShortNameAttribute, java.lang.String groupDisplayNameAttribute, boolean restrictMembershipToLocalRealm)
DirectoryInfo(DirectoryServiceProvider provider, java.lang.String host, java.lang.String port, java.lang.String principal, java.lang.String credential, boolean isSSLEnabled, java.lang.String sslSocketFactory, java.lang.String userBaseDN, java.lang.String userSearchFilter, java.lang.String userShortNameAttribute, java.lang.String userDisplayNameAttribute, java.lang.String userUniqueIdAttribute, java.lang.String groupBaseDN, java.lang.String groupSearchFilter, java.lang.String groupMembershipFilter, java.lang.String groupShortNameAttribute, java.lang.String groupDisplayNameAttribute, java.lang.String groupUniqueIdAttribute, boolean restrictMembershipToLocalRealm)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	getADAllowEmailOrUPNShortNames() For Internal Use Only.
int	getADConnectionTimeout() For Internal Use Only.
java.lang.String	getADDNSSite() For Internal Use Only.
boolean	getADReturnNameAsDN() For Internal Use Only.
boolean	getADSearchCrossForestGroupMembership() For Internal Use Only.
java.lang.String	getCredential() For Internal Use Only.
java.lang.String	getDirectoryDisplayName() For Internal Use Only.
java.lang.String	getDirectoryType() For Internal Use Only.
java.lang.String	getDynamicGroupMemberAttribute() For Internal Use Only.
java.lang.String	getDynamicGroupObjectClass() For Internal Use Only.
java.lang.String	getDynamicGroupQueryAttribute() For Internal Use Only.
java.lang.String	getGCHost() For Internal Use Only.
java.lang.String	getGCPort() For Internal Use Only.
java.lang.String	getGCUrl() For Internal Use Only.
java.lang.String	getGroupBaseDN() For Internal Use Only.
java.lang.String	getGroupDisplayNameAttribute() For Internal Use Only.
java.lang.String	getGroupMembershipFilter() For Internal Use Only.
java.lang.String	getGroupSearchFilter() For Internal Use Only.
java.lang.String	getGroupShortNameAttribute() For Internal Use Only.
java.lang.String	getGroupUniqueIDAttribute() For Internal Use Only.
java.lang.String	getHost() For Internal Use Only.
java.lang.String	getPort() For Internal Use Only.
java.lang.String	getPrincipal() For Internal Use Only.
DirectoryServiceProvider	getProvider() For Internal Use Only.
boolean	getSearchDynamicGroup() For Internal Use Only.
java.lang.String	getSSLSocketFactory() For Internal Use Only.
java.lang.String	getUrl() For Internal Use Only.
java.lang.String	getUserBaseDN() For Internal Use Only.
java.lang.String	getUserDisplayNameAttribute() For Internal Use Only.
java.lang.String	getUserSearchFilter() For Internal Use Only.
java.lang.String	getUserShortNameAttribute() For Internal Use Only.
java.lang.String	getUserUniqueIDAttribute() For Internal Use Only.
boolean	isRestrictMembershipToConfiguredRealms() For Internal Use Only.
boolean	isSSLEnabled() For Internal Use Only.
void	setADAllowEmailOrUPNShortNames(boolean allowEmailOrUPNShortNames) For Internal Use Only.
void	setADConnectionTimeout(int connectionTimeout) For Internal Use Only.
void	setADDNSSite(java.lang.String dnsSite) For Internal Use Only.
void	setADReturnNameAsDN(boolean returnNameAsDN) For Internal Use Only.
void	setADSearchCrossForestGroupMembership(boolean searchCrossForestGroupMembership) For Internal Use Only.
void	setDirectoryDisplayName(java.lang.String dirDisplayName) For Internal Use Only.
void	setDirectoryType(java.lang.String dirType) For Internal Use Only.
void	setGCHost(java.lang.String gcHost) For Internal Use Only.
void	setGCPort(java.lang.String gcPort) For Internal Use Only.
void	setGCUrl(java.lang.String gcUrl) For Internal Use Only.
void	setProvider(DirectoryServiceProvider provider) For Internal Use Only.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DirectoryInfo

public DirectoryInfo(DirectoryServiceProvider provider,
             java.lang.String host,
             java.lang.String port,
             java.lang.String principal,
             java.lang.String credential,
             boolean isSSLEnabled,
             java.lang.String sslSocketFactory,
             java.lang.String userBaseDN,
             java.lang.String userSearchFilter,
             java.lang.String userShortNameAttribute,
             java.lang.String userDisplayNameAttribute,
             java.lang.String groupBaseDN,
             java.lang.String groupSearchFilter,
             java.lang.String groupMembershipFilter,
             java.lang.String groupShortNameAttribute,
             java.lang.String groupDisplayNameAttribute)

For Internal Use Only. Constructs a new instance of the DirectoryInfo class with the specified property values.

Parameters:

provider -

host -

port -

principal -

credential -

isSSLEnabled -

sslSocketFactory -

userBaseDN -

userSearchFilter -

userShortNameAttribute -

userDisplayNameAttribute -

groupBaseDN -

groupSearchFilter -

groupMembershipFilter -

groupShortNameAttribute -

groupDisplayNameAttribute -

DirectoryInfo

public DirectoryInfo(DirectoryServiceProvider provider,
             java.lang.String host,
             java.lang.String port,
             java.lang.String principal,
             java.lang.String credential,
             boolean isSSLEnabled,
             java.lang.String sslSocketFactory,
             java.lang.String userBaseDN,
             java.lang.String userSearchFilter,
             java.lang.String userShortNameAttribute,
             java.lang.String userDisplayNameAttribute,
             java.lang.String groupBaseDN,
             java.lang.String groupSearchFilter,
             java.lang.String groupMembershipFilter,
             java.lang.String groupShortNameAttribute,
             java.lang.String groupDisplayNameAttribute,
             boolean restrictMembershipToLocalRealm)

DirectoryInfo

public DirectoryInfo(DirectoryServiceProvider provider,
             java.lang.String host,
             java.lang.String port,
             java.lang.String principal,
             java.lang.String credential,
             boolean isSSLEnabled,
             java.lang.String sslSocketFactory,
             java.lang.String userBaseDN,
             java.lang.String userSearchFilter,
             java.lang.String userShortNameAttribute,
             java.lang.String userDisplayNameAttribute,
             java.lang.String userUniqueIdAttribute,
             java.lang.String groupBaseDN,
             java.lang.String groupSearchFilter,
             java.lang.String groupMembershipFilter,
             java.lang.String groupShortNameAttribute,
             java.lang.String groupDisplayNameAttribute,
             java.lang.String groupUniqueIdAttribute,
             boolean restrictMembershipToLocalRealm)

DirectoryInfo

public DirectoryInfo(DirectoryServiceProvider provider,
             java.lang.String host,
             java.lang.String port,
             java.lang.String principal,
             java.lang.String credential,
             boolean isSSLEnabled,
             java.lang.String sslSocketFactory,
             java.lang.String userBaseDN,
             java.lang.String userSearchFilter,
             java.lang.String userShortNameAttribute,
             java.lang.String userDisplayNameAttribute,
             java.lang.String userUniqueIDAttribute,
             boolean userUniqueIDAttributeIsBinary,
             java.lang.String groupBaseDN,
             java.lang.String groupSearchFilter,
             java.lang.String groupMembershipFilter,
             java.lang.String groupShortNameAttribute,
             java.lang.String groupDisplayNameAttribute,
             boolean restrictMembershipToLocalRealm,
             java.lang.String groupUniqueIDAttribute,
             boolean groupUniqueIDAttributeIsBinary,
             boolean searchDynamicGroup,
             java.lang.String dynamicGroupMemberAttribute,
             java.lang.String dynamicGroupQueryAttribute,
             java.lang.String dynamicGroupObjectClass)

Method Detail

setProvider

public void setProvider(DirectoryServiceProvider provider)

For Internal Use Only. Sets the DirectoryServiceProvider. The DirectoryServiceProvider object communicates with the directory server via LDAP or some other form of API.

Parameters:

provider -

getProvider

public DirectoryServiceProvider getProvider()

For Internal Use Only. Returns the DirectoryServiceProvider instance associated with a given realm.

getHost

public java.lang.String getHost()

For Internal Use Only. Returns the host name of the directory server.

getPort

public java.lang.String getPort()

For Internal Use Only. Returns the port number of the directory server.

getUrl

public java.lang.String getUrl()

For Internal Use Only. Returns LDAP url of the directory server.

getPrincipal

public java.lang.String getPrincipal()

For Internal Use Only. Returns the principal used for the LDAP connection to the directory server.

getCredential

public java.lang.String getCredential()

For Internal Use Only. Returns the principal's password used for the LDAP connection to the directory server.

isSSLEnabled

public boolean isSSLEnabled()

For Internal Use Only. Returns a boolean value indicating whether Secure Sockets Layer (SSL) is enabled for the LDAP connection.

getSSLSocketFactory

public java.lang.String getSSLSocketFactory()

For Internal Use Only. Returns the SSL socket factory fully-qualified class name. If null is returned, DirectoryServerProvider objects will use JDK standard SSL socket factory.

getUserBaseDN

public java.lang.String getUserBaseDN()

For Internal Use Only. Retrieves the value of the UserBaseDN property.

getUserSearchFilter

public java.lang.String getUserSearchFilter()

For Internal Use Only. Retrieves the value of the UserSearchFilter property.

getUserShortNameAttribute

public java.lang.String getUserShortNameAttribute()

For Internal Use Only. Returns the LDAP attribute name mapped to the ShortName property on the Content Engine User object.

getUserDisplayNameAttribute

public java.lang.String getUserDisplayNameAttribute()

For Internal Use Only. Retrieves the LDAP attribute name mapped to the DisplayName property on the Content Engine User object.

getGroupBaseDN

public java.lang.String getGroupBaseDN()

For Internal Use Only. Retrieves the value of the GroupBaseDN property.

getGroupSearchFilter

public java.lang.String getGroupSearchFilter()

For Internal Use Only. Retrieves the value of the GroupSearchFilter property.

getGroupMembershipFilter

public java.lang.String getGroupMembershipFilter()

For Internal Use Only. Retrieves the value of the GroupMembershipSearchFilter property.

getGroupShortNameAttribute

public java.lang.String getGroupShortNameAttribute()

For Internal Use Only. Returns the LDAP attribute name mapped to the ShortName property on the Content Engine Group object.

getGroupDisplayNameAttribute

public java.lang.String getGroupDisplayNameAttribute()

For Internal Use Only. Returns the LDAP attribute name mapped to the DisplayName property on the Content Engine Group object.

getADConnectionTimeout

public int getADConnectionTimeout()

For Internal Use Only. Returns the value in milliseconds of the LDAP ConnectionTimeout property for the Active Directory server.

getADReturnNameAsDN

public boolean getADReturnNameAsDN()

For Internal Use Only. Retrieves the value of the ReturnNameAsDN property for the Active Directory Server.

getADSearchCrossForestGroupMembership

public boolean getADSearchCrossForestGroupMembership()

For Internal Use Only. Retrieves the value of the SearchCrossForestGroupMembership property for the Active Directory server.

getADAllowEmailOrUPNShortNames

public boolean getADAllowEmailOrUPNShortNames()

For Internal Use Only. Retrieves the value of the AllowEmailOrUPNShortNames property for the Active Directory server.

setADConnectionTimeout

public void setADConnectionTimeout(int connectionTimeout)

For Internal Use Only. Sets the value in milliseconds of the LDAP ConnectionTimeout property for the Active Directory server.

Parameters:

connectionTimeout -

setADReturnNameAsDN

public void setADReturnNameAsDN(boolean returnNameAsDN)

For Internal Use Only. Sets the value of the LDAP ReturnNameAsDN property for the Active Directory server.

Parameters:

returnNameAsDN -

setADSearchCrossForestGroupMembership

public void setADSearchCrossForestGroupMembership(boolean searchCrossForestGroupMembership)

For Internal Use Only. Sets the value of the SearchCrossForestGroupMembership property for the Active Directory server.

Parameters:

searchCrossForestGroupMembership -

setADAllowEmailOrUPNShortNames

public void setADAllowEmailOrUPNShortNames(boolean allowEmailOrUPNShortNames)

For Internal Use Only. Sets the value of the AllowEmailOrUPNShortNames property for the Active Directory server.

Parameters:

allowEmailOrUPNShortNames -

getADDNSSite

public java.lang.String getADDNSSite()

For Internal Use Only. Retrieves the value of the ActiveDirectorySiteDNS property under the Active Directory container.

setADDNSSite

public void setADDNSSite(java.lang.String dnsSite)

For Internal Use Only. Sets the value of the ActiveDirectorySiteDNS property under the Active Directory container.

getGCHost

public java.lang.String getGCHost()

For Internal Use Only. Returns the value of the GCHost property under the Active Directory container.

setGCHost

public void setGCHost(java.lang.String gcHost)

For Internal Use Only. Sets the value of the GCHost property under the Active Directory container.

Parameters:

gcHost -

getGCPort

public java.lang.String getGCPort()

For Internal Use Only. Returns the value of the GCPort property under the Active Directory container.

setGCPort

public void setGCPort(java.lang.String gcPort)

For Internal Use Only. Sets the value of the GCPort property under the Active Directory container.

Parameters:

gcPort -

getGCUrl

public java.lang.String getGCUrl()

For Internal Use Only. Returns the value of the GCUrl property under the Active Directory container.

setGCUrl

public void setGCUrl(java.lang.String gcUrl)

For Internal Use Only. Sets the value of the GCUrl property under the Active Directory container.

Parameters:

gcUrl -

getDynamicGroupQueryAttribute

public java.lang.String getDynamicGroupQueryAttribute()

For Internal Use Only. Retrieves the value of the DynamicGroupMembershipQueryAttribute property.

getDynamicGroupMemberAttribute

public java.lang.String getDynamicGroupMemberAttribute()

For Internal Use Only. Retrieves the value of the DynamicGroupMembershipReturnAttribute property.

getGroupUniqueIDAttribute

public java.lang.String getGroupUniqueIDAttribute()

For Internal Use Only. Retrieves the value of the GroupUniqueIDAttribute property.

getUserUniqueIDAttribute

public java.lang.String getUserUniqueIDAttribute()

For Internal Use Only. Retrieves the value of the UserUniqueIDAttribute property.

getSearchDynamicGroup

public boolean getSearchDynamicGroup()

For Internal Use Only. Retrieves the value of the SearchDynamicGroup property.

getDynamicGroupObjectClass

public java.lang.String getDynamicGroupObjectClass()

For Internal Use Only. Retrieves the value of the DynamicGroupObjectClass property.

isRestrictMembershipToConfiguredRealms

public boolean isRestrictMembershipToConfiguredRealms()

For Internal Use Only. Retrieves the value of the getRestrictMembershipToLocalRealm property.

getDirectoryDisplayName

public java.lang.String getDirectoryDisplayName()

For Internal Use Only. Returns the value of the DirectoryDisplayName property.

setDirectoryDisplayName

public void setDirectoryDisplayName(java.lang.String dirDisplayName)

For Internal Use Only. Sets the value of the DirectoryDisplayName property.

Parameters:

dirDisplayName -

getDirectoryType

public java.lang.String getDirectoryType()

For Internal Use Only. Returns the value of the DirectoryType property.

setDirectoryType

public void setDirectoryType(java.lang.String dirType)

For Internal Use Only. Sets the value of the DirectoryType property.

Parameters:

dirType -