com.filenet.api.engine
Class RealmInfo

java.lang.Object
  extended by com.filenet.api.engine.RealmInfo

public class RealmInfo
extends java.lang.Object

For Internal Use Only. Contains realm information. Each FileNet P8 realm has a corresponding RealmInfo object.


Constructor Summary
RealmInfo(java.lang.String realmName, 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 restrictMembershipToConfiguredRealms, java.lang.String groupUniqueIDAttribute, boolean groupUniqueIDAttributeIsBinary, boolean searchDynamicGroup, java.lang.String dynamicGroupMemberAttribute, java.lang.String dynamicGroupQueryAttribute, java.lang.String dynamicGroupObjectClass)
           
RealmInfo(java.lang.String realmName, 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.
RealmInfo(java.lang.String realmName, 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 restrictMembershipToConfiguredRealms)
           
 
Method Summary
 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 getDynamicGroupMemberAttribute()
          For Internal Use Only.
 java.lang.String getDynamicGroupObjectClass()
          For Internal Use Only.
 java.util.ArrayList getDynamicGroupObjectClassList()
          For Internal Use Only.
 java.lang.String getDynamicGroupQueryAttribute()
          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.
 boolean getGroupUniqueIDAttributeIsBinary()
          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.
 java.lang.String getRealmName()
          For Internal Use Only.
 boolean getSearchDynamicGroup()
          For Internal Use Only.
 java.lang.String getSSLSocketFactory()
          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 getUserUniqueIDAttributeIsBinary()
          For Internal Use Only.
 boolean isRestrictMembershipToConfiguredRealms()
          For Internal Use Only.
 boolean isSSLEnabled()
          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 setProvider(DirectoryServiceProvider provider)
          For Internal Use Only.
 void setRealmName(java.lang.String realmName)
          For Internal Use Only.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

RealmInfo

public RealmInfo(java.lang.String realmName,
                 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 RealmInfo class with the specified property values.

Parameters:
realmName -
provider -
host -
port -
principal -
credential -
isSSLEnabled -
sslSocketFactory -
userBaseDN -
userSearchFilter -
userShortNameAttribute -
userDisplayNameAttribute -
groupBaseDN -
groupSearchFilter -
groupMembershipFilter -
groupShortNameAttribute -
groupDisplayNameAttribute -

RealmInfo

public RealmInfo(java.lang.String realmName,
                 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 restrictMembershipToConfiguredRealms)

RealmInfo

public RealmInfo(java.lang.String realmName,
                 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 restrictMembershipToConfiguredRealms,
                 java.lang.String groupUniqueIDAttribute,
                 boolean groupUniqueIDAttributeIsBinary,
                 boolean searchDynamicGroup,
                 java.lang.String dynamicGroupMemberAttribute,
                 java.lang.String dynamicGroupQueryAttribute,
                 java.lang.String dynamicGroupObjectClass)
Method Detail

getRealmName

public java.lang.String getRealmName()
For Internal Use Only. Returns the name of the realm in Distinguished Name (DN) format.


setRealmName

public void setRealmName(java.lang.String realmName)
For Internal Use Only. Sets the Distinguished Name (DN) of the given realm.

Parameters:
realmName -

getProvider

public DirectoryServiceProvider getProvider()
For Internal Use Only. Returns the DirectoryServiceProvider instance.


setProvider

public void setProvider(DirectoryServiceProvider provider)
For Internal Use Only. Sets the DirectoryServiceProvider for a given realm. The DirectoryServiceProvider object communicates with the directory server via LDAP or some other form of API.

Parameters:
provider -

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.


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, the Java standard SSL socket factory class is used.


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.


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 -

getADReturnNameAsDN

public boolean getADReturnNameAsDN()
For Internal Use Only. Retrieves the value of the ReturnNameAsDN property for the Active Directory Server.


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 -

getADSearchCrossForestGroupMembership

public boolean getADSearchCrossForestGroupMembership()
For Internal Use Only. Retrieves the value of the SearchCrossForestGroupMembership property for the Active Directory server.


setADSearchCrossForestGroupMembership

public void setADSearchCrossForestGroupMembership(boolean searchCrossForestGroupMembership)
For Internal Use Only. Sets the value of the SearchCrossForestGroupMembership property for the Active Directory server.

Parameters:
searchCrossForestGroupMembership -

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.

Parameters:
dnsSite -

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.


getGroupUniqueIDAttributeIsBinary

public boolean getGroupUniqueIDAttributeIsBinary()
For Internal Use Only. Retrieves the value of the GroupUniqueIDAttributeIsBinary property.


getUserUniqueIDAttribute

public java.lang.String getUserUniqueIDAttribute()
For Internal Use Only. Retrieves the value of the UserUniqueIDAttribute property.


getUserUniqueIDAttributeIsBinary

public boolean getUserUniqueIDAttributeIsBinary()
For Internal Use Only. Retrieves the value of the UserUniqueIDAttributeIsBinary 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.


getDynamicGroupObjectClassList

public java.util.ArrayList getDynamicGroupObjectClassList()
For Internal Use Only. Retrieves a list of DynamicGroupObjectClass. DynamicGroupObjectClass is passed in to the constructor as a comma-separated string.


isRestrictMembershipToConfiguredRealms

public boolean isRestrictMembershipToConfiguredRealms()
For Internal Use Only. Retrieves the value of the getRestrictMembershipToLocalRealm property.



© Copyright IBM Corporation 2006, 2009. All rights reserved.