org.identityconnectors.ldap

Class LdapConfiguration

java.lang.Object

org.identityconnectors.framework.spi.AbstractConfiguration

org.identityconnectors.ldap.LdapConfiguration

All Implemented Interfaces:

Configuration, StatefulConfiguration

public class LdapConfiguration
extends AbstractConfiguration
implements StatefulConfiguration

Encapsulates the LDAP connector's configuration.

Author:

Andrei Badea

Nested Class Summary

Nested classes/interfaces inherited from class org.identityconnectors.framework.spi.AbstractConfiguration

AbstractConfiguration.ConfigurationChangeCallback

Constructor Summary

Constructors

Constructor and Description
LdapConfiguration()

Method Summary

Modifier and Type	Method and Description
void	cacheServerType(LdapConstants.ServerType serverType)
boolean	equals(Object obj)
String[]	getAccountObjectClasses()
String	getAccountSearchFilter()
String	getAccountSynchronizationFilter()
String[]	getAccountUserNameAttributes()
String[]	getAttributesToSynchronize()
String	getAuthType()
String[]	getBaseContexts()
List<LdapName>	getBaseContextsAsLdapNames()
String[]	getBaseContextsToSynchronize()
List<LdapName>	getBaseContextsToSynchronizeAsLdapNames()
int	getBlockSize()
int	getChangeLogBlockSize()
String	getChangeNumberAttribute()
GuardedString	getCredentials()
String[]	getFailover()
String	getGroupMemberAttribute()
String[]	getGroupObjectClasses()
String	getGroupSearchFilter()
String	getGroupSynchronizationFilter()
String	getHost()
String[]	getModifiersNamesToFilterOut()
Set<LdapName>	getModifiersNamesToFilterOutAsLdapNames()
String[]	getObjectClassesToSynchronize()
Map<ObjectClass,ObjectClassMappingConfig>	getObjectClassMappingConfigs()
String	getPasswordAttribute()
String	getPasswordAttributeToSynchronize()
GuardedByteArray	getPasswordDecryptionInitializationVector()
GuardedByteArray	getPasswordDecryptionKey()
String	getPasswordHashAlgorithm()
int	getPort()
String	getPrincipal()
String	getReferralsHandling()
String	getResetSyncToken()
LdapConstants.ServerType	getServerType()
String	getUidAttribute()
String	getVlvSortAttribute()
int	hashCode()
boolean	isFilterWithOrInsteadOfAnd()
boolean	isGetGroupMemberId()
boolean	isMaintainLdapGroupMembership()
boolean	isMaintainPosixGroupMembership()
boolean	isReadSchema()
boolean	isRemoveLogEntryObjectClassFromFilter()
boolean	isRespectResourcePasswordPolicyChangeAfterReset()
boolean	isSsl()
boolean	isStartTLS()
boolean	isSynchronizePasswords()
boolean	isUseBlocks()
boolean	isUseDNSSRVRecord()
boolean	isUsePagedResultControl()
boolean	isUseTimestampsForSync()
void	release() Release any allocated resources.
void	setAccountObjectClasses(String... accountObjectClasses)
void	setAccountSearchFilter(String accountSearchFilter)
void	setAccountSynchronizationFilter(String accountSynchronizationFilter)
void	setAccountUserNameAttributes(String... accountUserNameAttributes)
void	setAttributesToSynchronize(String... attributesToSynchronize)
void	setAuthType(String authType)
void	setBaseContexts(String... baseContexts)
void	setBaseContextsToSynchronize(String... baseContextsToSynchronize)
void	setBlockSize(int blockSize)
void	setChangeLogBlockSize(int changeLogBlockSize)
void	setChangeNumberAttribute(String changeNumberAttribute)
void	setCredentials(GuardedString credentials)
void	setFailover(String... failover)
void	setFilterWithOrInsteadOfAnd(boolean filterWithOrInsteadOfAnd)
void	setGetGroupMemberId(boolean getGroupMemberId)
void	setGroupMemberAttribute(String groupMemberAttribute)
void	setGroupObjectClasses(String... groupObjectClasses)
void	setGroupSearchFilter(String groupSearchFilter)
void	setGroupSynchronizationFilter(String groupSynchronizationFilter)
void	setHost(String host)
void	setMaintainLdapGroupMembership(boolean maintainLdapGroupMembership)
void	setMaintainPosixGroupMembership(boolean maintainPosixGroupMembership)
void	setModifiersNamesToFilterOut(String... modifiersNamesToFilterOut)
void	setObjectClassesToSynchronize(String... objectClassesToSynchronize)
void	setPasswordAttribute(String passwordAttribute)
void	setPasswordAttributeToSynchronize(String passwordAttributeToSynchronize)
void	setPasswordDecryptionInitializationVector(GuardedByteArray passwordDecryptionInitializationVector)
void	setPasswordDecryptionKey(GuardedByteArray passwordDecryptionKey)
void	setPasswordHashAlgorithm(String passwordHashAlgorithm)
void	setPort(int port)
void	setPrincipal(String principal)
void	setReadSchema(boolean readSchema)
void	setReferralsHandling(String referral)
void	setRemoveLogEntryObjectClassFromFilter(boolean removeLogEntryObjectClassFromFilter)
void	setResetSyncToken(String resetSyncToken)
void	setRespectResourcePasswordPolicyChangeAfterReset(boolean respectResourcePasswordPolicyChangeAfterReset)
void	setSsl(boolean ssl)
void	setStartTLS(boolean startTLS)
void	setSynchronizePasswords(boolean synchronizePasswords)
void	setUidAttribute(String uidAttribute)
void	setUseBlocks(boolean useBlocks)
void	setUseDNSSRVRecord(boolean useDNSSRVRecord)
void	setUsePagedResultControl(boolean usePagedResultControl)
void	setUseTimestampsForSync(boolean useTimestampsForSync)
void	setVlvSortAttribute(String vlvSortAttribute)
void	validate() Determines if the configuration is valid.

Methods inherited from class org.identityconnectors.framework.spi.AbstractConfiguration

addChangeCallback, getConnectorMessages, notifyConfigurationUpdate, setConnectorMessages

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.identityconnectors.framework.spi.Configuration

getConnectorMessages, setConnectorMessages

Constructor Detail

LdapConfiguration

public LdapConfiguration()

Method Detail

validate

public void validate()

Determines if the configuration is valid.

A valid configuration is one that is ready to be used by the connector: it is complete (all the required properties have been given values) and the property values are well-formed (are in the expected range, have the expected format, etc.)

Implementations of this method should not connect to the resource in an attempt to validate the configuration. For example, implementations should not attempt to check that a host of the specified name exists by making a connection to it. Such checks can be performed in the implementation of the TestOp.test() method.

Specified by:

validate in interface Configuration

getHost

public String getHost()

setHost

public void setHost(String host)

getPort

public int getPort()

setPort

public void setPort(int port)

isSsl

public boolean isSsl()

setSsl

public void setSsl(boolean ssl)

isStartTLS

public boolean isStartTLS()

setStartTLS

public void setStartTLS(boolean startTLS)

getFailover

public String[] getFailover()

setFailover

public void setFailover(String... failover)

getPrincipal

public String getPrincipal()

setPrincipal

public void setPrincipal(String principal)

getCredentials

public GuardedString getCredentials()

setCredentials

public void setCredentials(GuardedString credentials)

getAuthType

public String getAuthType()

setAuthType

public void setAuthType(String authType)

getBaseContexts

public String[] getBaseContexts()

setBaseContexts

public void setBaseContexts(String... baseContexts)

getReferralsHandling

public String getReferralsHandling()

setReferralsHandling

public void setReferralsHandling(String referral)

getPasswordAttribute

public String getPasswordAttribute()

setPasswordAttribute

public void setPasswordAttribute(String passwordAttribute)

getAccountObjectClasses

public String[] getAccountObjectClasses()

setAccountObjectClasses

public void setAccountObjectClasses(String... accountObjectClasses)

getAccountUserNameAttributes

public String[] getAccountUserNameAttributes()

setAccountUserNameAttributes

public void setAccountUserNameAttributes(String... accountUserNameAttributes)

getAccountSearchFilter

public String getAccountSearchFilter()

setAccountSearchFilter

public void setAccountSearchFilter(String accountSearchFilter)

getGroupSearchFilter

public String getGroupSearchFilter()

setGroupSearchFilter

public void setGroupSearchFilter(String groupSearchFilter)

getGroupObjectClasses

public String[] getGroupObjectClasses()

setGroupObjectClasses

public void setGroupObjectClasses(String... groupObjectClasses)

getGroupMemberAttribute

public String getGroupMemberAttribute()

setGroupMemberAttribute

public void setGroupMemberAttribute(String groupMemberAttribute)

isGetGroupMemberId

public boolean isGetGroupMemberId()

setGetGroupMemberId

public void setGetGroupMemberId(boolean getGroupMemberId)

isMaintainLdapGroupMembership

public boolean isMaintainLdapGroupMembership()

setMaintainLdapGroupMembership

public void setMaintainLdapGroupMembership(boolean maintainLdapGroupMembership)

isMaintainPosixGroupMembership

public boolean isMaintainPosixGroupMembership()

setMaintainPosixGroupMembership

public void setMaintainPosixGroupMembership(boolean maintainPosixGroupMembership)

getPasswordHashAlgorithm

public String getPasswordHashAlgorithm()

setPasswordHashAlgorithm

public void setPasswordHashAlgorithm(String passwordHashAlgorithm)

isRespectResourcePasswordPolicyChangeAfterReset

public boolean isRespectResourcePasswordPolicyChangeAfterReset()

setRespectResourcePasswordPolicyChangeAfterReset

public void setRespectResourcePasswordPolicyChangeAfterReset(boolean respectResourcePasswordPolicyChangeAfterReset)

isUseBlocks

public boolean isUseBlocks()

setUseBlocks

public void setUseBlocks(boolean useBlocks)

getBlockSize

public int getBlockSize()

setBlockSize

public void setBlockSize(int blockSize)

isUsePagedResultControl

public boolean isUsePagedResultControl()

setUsePagedResultControl

public void setUsePagedResultControl(boolean usePagedResultControl)

getVlvSortAttribute

public String getVlvSortAttribute()

setVlvSortAttribute

public void setVlvSortAttribute(String vlvSortAttribute)

getUidAttribute

public String getUidAttribute()

setUidAttribute

public void setUidAttribute(String uidAttribute)

isReadSchema

public boolean isReadSchema()

setReadSchema

public void setReadSchema(boolean readSchema)

isUseDNSSRVRecord

public boolean isUseDNSSRVRecord()

setUseDNSSRVRecord

public void setUseDNSSRVRecord(boolean useDNSSRVRecord)

getResetSyncToken

public String getResetSyncToken()

setResetSyncToken

public void setResetSyncToken(String resetSyncToken)

getBaseContextsToSynchronize

public String[] getBaseContextsToSynchronize()

setBaseContextsToSynchronize

public void setBaseContextsToSynchronize(String... baseContextsToSynchronize)

getObjectClassesToSynchronize

public String[] getObjectClassesToSynchronize()

setObjectClassesToSynchronize

public void setObjectClassesToSynchronize(String... objectClassesToSynchronize)

getAttributesToSynchronize

public String[] getAttributesToSynchronize()

setAttributesToSynchronize

public void setAttributesToSynchronize(String... attributesToSynchronize)

getModifiersNamesToFilterOut

public String[] getModifiersNamesToFilterOut()

setModifiersNamesToFilterOut

public void setModifiersNamesToFilterOut(String... modifiersNamesToFilterOut)

getAccountSynchronizationFilter

public String getAccountSynchronizationFilter()

setAccountSynchronizationFilter

public void setAccountSynchronizationFilter(String accountSynchronizationFilter)

getGroupSynchronizationFilter

public String getGroupSynchronizationFilter()

setGroupSynchronizationFilter

public void setGroupSynchronizationFilter(String groupSynchronizationFilter)

getChangeLogBlockSize

public int getChangeLogBlockSize()

setChangeLogBlockSize

public void setChangeLogBlockSize(int changeLogBlockSize)

getChangeNumberAttribute

public String getChangeNumberAttribute()

setChangeNumberAttribute

public void setChangeNumberAttribute(String changeNumberAttribute)

isUseTimestampsForSync

public boolean isUseTimestampsForSync()

setUseTimestampsForSync

public void setUseTimestampsForSync(boolean useTimestampsForSync)

isFilterWithOrInsteadOfAnd

public boolean isFilterWithOrInsteadOfAnd()

setFilterWithOrInsteadOfAnd

public void setFilterWithOrInsteadOfAnd(boolean filterWithOrInsteadOfAnd)

isRemoveLogEntryObjectClassFromFilter

public boolean isRemoveLogEntryObjectClassFromFilter()

setRemoveLogEntryObjectClassFromFilter

public void setRemoveLogEntryObjectClassFromFilter(boolean removeLogEntryObjectClassFromFilter)

isSynchronizePasswords

public boolean isSynchronizePasswords()

setSynchronizePasswords

public void setSynchronizePasswords(boolean synchronizePasswords)

getPasswordAttributeToSynchronize

public String getPasswordAttributeToSynchronize()

setPasswordAttributeToSynchronize

public void setPasswordAttributeToSynchronize(String passwordAttributeToSynchronize)

getPasswordDecryptionKey

public GuardedByteArray getPasswordDecryptionKey()

setPasswordDecryptionKey

public void setPasswordDecryptionKey(GuardedByteArray passwordDecryptionKey)

getPasswordDecryptionInitializationVector

public GuardedByteArray getPasswordDecryptionInitializationVector()

setPasswordDecryptionInitializationVector

public void setPasswordDecryptionInitializationVector(GuardedByteArray passwordDecryptionInitializationVector)

getBaseContextsAsLdapNames

public List<LdapName> getBaseContextsAsLdapNames()

getBaseContextsToSynchronizeAsLdapNames

public List<LdapName> getBaseContextsToSynchronizeAsLdapNames()

getModifiersNamesToFilterOutAsLdapNames

public Set<LdapName> getModifiersNamesToFilterOutAsLdapNames()

getObjectClassMappingConfigs

public Map<ObjectClass,ObjectClassMappingConfig> getObjectClassMappingConfigs()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

cacheServerType

public void cacheServerType(LdapConstants.ServerType serverType)

getServerType

public LdapConstants.ServerType getServerType()

release

public void release()

Description copied from interface: StatefulConfiguration

Release any allocated resources.

Specified by:

release in interface StatefulConfiguration