A B C D E F G I J K L M N P R S T U V

A

activateObject(Object) - Method in class edu.amc.sakai.user.PooledLDAPConnectionFactory

Activates a PooledLDAPConnection as it is being loaned out from the pool, including: ensuring the default constraints are set and setting the active flag so that it can return itself to the pool if it falls out of scope.

ADDITIONAL_INFO_ATTR_MAPPING_KEY - Static variable in class edu.amc.sakai.user.AttributeMappingConstants

appendSingleSearchPredicate(StringBuilder, String, String) - Method in class edu.amc.sakai.user.MultipleEmailLdapAttributeMapper

applyConstraints(LDAPConnection) - Method in class edu.amc.sakai.user.SimpleLdapConnectionManager

Applies LDAPConstraints to the specified LDAPConnection.

AttributeMappingConstants - Class in edu.amc.sakai.user

A container for LDAP attribute mapping constants.

AttributeMappingConstants() - Constructor for class edu.amc.sakai.user.AttributeMappingConstants

authenticateUser(String, UserEdit, String) - Method in class edu.amc.sakai.user.JLDAPDirectoryProvider

Authenticates the specified user login by recursively searching for and binding to a DN below the configured base DN.

authenticateWithProviderFirst(String) - Method in class edu.amc.sakai.user.JLDAPDirectoryProvider

By default returns the global boolean setting configured via JLDAPDirectoryProvider.setAuthenticateWithProviderFirst(boolean).

AUTHENTICATION_ATTR_MAPPING_KEY - Static variable in class edu.amc.sakai.user.AttributeMappingConstants

Key into AttributeMappingConstants.DEFAULT_ATTR_MAPPINGS representing the logical name of a user entry's authentication (aka Sakai "AID") attribute

B

bind(int, String, byte[], LDAPConstraints) - Method in class edu.amc.sakai.user.PooledLDAPConnection

bind(int, String, byte[], LDAPResponseQueue, LDAPConstraints) - Method in class edu.amc.sakai.user.PooledLDAPConnection

bind(int, String, byte[], LDAPResponseQueue) - Method in class edu.amc.sakai.user.PooledLDAPConnection

bind(int, String, byte[]) - Method in class edu.amc.sakai.user.PooledLDAPConnection

bind(int, String, String, LDAPConstraints) - Method in class edu.amc.sakai.user.PooledLDAPConnection

bind(int, String, String) - Method in class edu.amc.sakai.user.PooledLDAPConnection

bind(String, String, LDAPConstraints) - Method in class edu.amc.sakai.user.PooledLDAPConnection

bind(String, String, Map, Object, LDAPConstraints) - Method in class edu.amc.sakai.user.PooledLDAPConnection

bind(String, String, Map, Object) - Method in class edu.amc.sakai.user.PooledLDAPConnection

bind(String, String, String[], Map, Object, LDAPConstraints) - Method in class edu.amc.sakai.user.PooledLDAPConnection

bind(String, String, String[], Map, Object) - Method in class edu.amc.sakai.user.PooledLDAPConnection

bind(String, String) - Method in class edu.amc.sakai.user.PooledLDAPConnection

C

CANDIDATE_ATTR_MAPPINGS - Static variable in class edu.amc.sakai.user.AttributeMappingConstants

Extension of DEFAULT_ATTR_MAPPINGS

CANDIDATE_ID_ATTR_MAPPING_KEY - Static variable in class edu.amc.sakai.user.AttributeMappingConstants

clearCache() - Method in class edu.amc.sakai.user.JLDAPDirectoryProvider

Resets the internal LdapUserData cache

connect(LDAPConnection) - Method in class edu.amc.sakai.user.SimpleLdapConnectionManager

Connects the specified LDAPConnection to the currently configured host and port.

ConsensusLdapConnectionLivenessValidator - Class in edu.amc.sakai.user

A "federating" LdapConnectionLivenessValidator implemenation which requires all delegates to validate a given connection.

ConsensusLdapConnectionLivenessValidator() - Constructor for class edu.amc.sakai.user.ConsensusLdapConnectionLivenessValidator

createSocket(String, int) - Method in class edu.amc.sakai.user.LDAPJSSESecureSocketFactory

Returns the socket connected to the LDAP server with the specified host name and port number.

createSocket(String, int) - Method in class edu.amc.sakai.user.LDAPSimpleSocketFactory

D

DEFAULT_ADDITIONAL_INFO_ATTR - Static variable in class edu.amc.sakai.user.AttributeMappingConstants

DEFAULT_ALLOW_AUTHENTICATION - Static variable in class edu.amc.sakai.user.JLDAPDirectoryProvider

DEFAULT_ATTR_MAPPINGS - Static variable in class edu.amc.sakai.user.AttributeMappingConstants

Default set of user entry attribute mappings.

DEFAULT_AUTHENTICATE_WITH_PROVIDER_FIRST - Static variable in class edu.amc.sakai.user.JLDAPDirectoryProvider

DEFAULT_AUTHENTICATION_ATTR - Static variable in class edu.amc.sakai.user.AttributeMappingConstants

Default value in AttributeMappingConstants.DEFAULT_ATTR_MAPPINGS representing the physical name of a user entry's authentication (aka Sakai "AID") attribute

DEFAULT_BATCH_SIZE - Static variable in class edu.amc.sakai.user.JLDAPDirectoryProvider

Default LDAP maximum number of objects to query for

DEFAULT_CANDIDATE_ID_ATTR - Static variable in class edu.amc.sakai.user.AttributeMappingConstants

DEFAULT_EMAIL_ATTR - Static variable in class edu.amc.sakai.user.AttributeMappingConstants

Default value in AttributeMappingConstants.DEFAULT_ATTR_MAPPINGS representing the physical name of a user entry's email attribute

DEFAULT_FIRST_NAME_ATTR - Static variable in class edu.amc.sakai.user.AttributeMappingConstants

Default value in AttributeMappingConstants.DEFAULT_ATTR_MAPPINGS representing the physical name of a user entry's given name attribute

DEFAULT_GROUP_MEMBERSHIP_ATTR - Static variable in class edu.amc.sakai.user.AttributeMappingConstants

Default value in AttributeMappingConstants.DEFAULT_ATTR_MAPPINGS representing the physical name of a user entry's group membership attribute

DEFAULT_HOST_NAME - Static variable in class edu.amc.sakai.user.SearchExecutingLdapConnectionLivenessValidator

DEFAULT_IS_FOLLOW_REFERRALS - Static variable in class edu.amc.sakai.user.JLDAPDirectoryProvider

Default referral following behavior

DEFAULT_IS_SEARCH_ALIASES - Static variable in class edu.amc.sakai.user.JLDAPDirectoryProvider

DEFAULT_IS_SECURE_CONNECTION - Static variable in class edu.amc.sakai.user.JLDAPDirectoryProvider

Default secure/unsecure LDAP connection creation behavior

DEFAULT_LAST_NAME_ATTR - Static variable in class edu.amc.sakai.user.AttributeMappingConstants

Default value in AttributeMappingConstants.DEFAULT_ATTR_MAPPINGS representing the physical name of a user entry's surname attribute

DEFAULT_LDAP_CONSTRAINTS - Static variable in class edu.amc.sakai.user.SearchExecutingLdapConnectionLivenessValidator

DEFAULT_LDAP_PORT - Static variable in class edu.amc.sakai.user.JLDAPDirectoryProvider

Default LDAP connection port

DEFAULT_LOGIN_ATTR - Static variable in class edu.amc.sakai.user.AttributeMappingConstants

Default value in AttributeMappingConstants.DEFAULT_ATTR_MAPPINGS representing the physical name of a user entry's login (aka Sakai "EID") attribute

DEFAULT_MAX_RESULT_SIZE - Static variable in class edu.amc.sakai.user.JLDAPDirectoryProvider

Default LDAP maximum number of objects in a result

DEFAULT_MAX_TTL - Static variable in class edu.amc.sakai.user.MaxLifetimeLdapConnectionLivenessValidator

DEFAULT_OPERATION_TIMEOUT_MILLIS - Static variable in class edu.amc.sakai.user.JLDAPDirectoryProvider

Default LDAP access timeout in milliseconds

DEFAULT_POOL_MAX_CONNS - Static variable in class edu.amc.sakai.user.JLDAPDirectoryProvider

Default LDAP maximum number of connections in the pool

DEFAULT_POOLING - Static variable in class edu.amc.sakai.user.JLDAPDirectoryProvider

Default LDAP use of connection pooling

DEFAULT_PREFERRED_FIRST_NAME_ATTR - Static variable in class edu.amc.sakai.user.AttributeMappingConstants

Default value in AttributeMappingConstants.DEFAULT_ATTR_MAPPINGS representing the physical name of a user entry's preferred given name attribute.

DEFAULT_SEARCH_ATTRIBUTE_NAME - Static variable in class edu.amc.sakai.user.SearchExecutingLdapConnectionLivenessValidator

DEFAULT_SEARCH_SCOPE - Static variable in class edu.amc.sakai.user.JLDAPDirectoryProvider

Default search scope for filters executed by JLDAPDirectoryProvider.searchDirectory(String, LDAPConnection, LdapEntryMapper, String[], String, int)

DEFAULT_STUDENT_NUMBER_ID_ATTR - Static variable in class edu.amc.sakai.user.AttributeMappingConstants

defaultLdapEntryMapper - Variable in class edu.amc.sakai.user.JLDAPDirectoryProvider

Defaults to an anon-inner class which handles LDAPEntry(ies) by passing them to JLDAPDirectoryProvider.mapLdapEntryOntoUserData(LDAPEntry), the result of which is returned.

deriveAddressFromEid(String) - Method in class edu.amc.sakai.user.EmailAddressDerivingLdapAttributeMapper

Calculate an email address from the given user EID.

destroy() - Method in class edu.amc.sakai.user.JLDAPDirectoryProvider

Typically called by Spring to signal bean destruction.

destroy() - Method in interface edu.amc.sakai.user.LdapConnectionManager

Shuts down an instance.

destroy() - Method in class edu.amc.sakai.user.PoolingLdapConnectionManager

Shuts down an instance.

destroy() - Method in class edu.amc.sakai.user.SimpleLdapConnectionManager

Shuts down an instance.

destroyObject(Object) - Method in class edu.amc.sakai.user.PooledLDAPConnectionFactory

Cleans up a PooledLDAPConnection that is about to be destroyed by invoking LDAPConnection.disconnect().

DISPLAY_ID_ATTR_MAPPING_KEY - Static variable in class edu.amc.sakai.user.AttributeMappingConstants

DISPLAY_ID_PROPERTY - Static variable in class edu.amc.sakai.user.JLDAPDirectoryProvider

Property of the user object to store the display ID under

DISPLAY_NAME_ATTR_MAPPING_KEY - Static variable in class edu.amc.sakai.user.AttributeMappingConstants

DISPLAY_NAME_PROPERTY - Static variable in class edu.amc.sakai.user.JLDAPDirectoryProvider

Property of the user object to store the display Name under

doUnpackEidFromAddress(String) - Method in class edu.amc.sakai.user.EmailAddressDerivingLdapAttributeMapper

Calculates a user EID from an email address, assuming the address has already passed muster with EmailAddressDerivingLdapAttributeMapper.validateAddress(String).

E

edu.amc.sakai.user - package edu.amc.sakai.user

EidDerivedEmailAddressHandler - Interface in edu.amc.sakai.user

Mixin interface for objects capable of calculating a user EID from an email address.

EidValidator - Interface in edu.amc.sakai.user

EMAIL_ATTR_MAPPING_KEY - Static variable in class edu.amc.sakai.user.AttributeMappingConstants

Key into AttributeMappingConstants.DEFAULT_ATTR_MAPPINGS representing the logical name of a user entry's email attribute

EmailAddressDerivingLdapAttributeMapper - Class in edu.amc.sakai.user

EmailAddressDerivingLdapAttributeMapper() - Constructor for class edu.amc.sakai.user.EmailAddressDerivingLdapAttributeMapper

EmptyStringUserTypeMapper - Class in edu.amc.sakai.user

Essentially a null impl, which always returns an empty String from StringUserTypeMapper.mapLdapEntryToSakaiUserType(LDAPEntry, LdapAttributeMapper).

EmptyStringUserTypeMapper() - Constructor for class edu.amc.sakai.user.EmptyStringUserTypeMapper

Initializes the cached user type String to an empty String

EntryAttributeToUserTypeMapper - Class in edu.amc.sakai.user

Maps from a user entry's attribute to a Sakai user type.

EntryAttributeToUserTypeMapper() - Constructor for class edu.amc.sakai.user.EntryAttributeToUserTypeMapper

EntryContainerRdnToUserTypeMapper - Class in edu.amc.sakai.user

Maps from a user entry's container's most-local RDN to a Sakai user type.

EntryContainerRdnToUserTypeMapper() - Constructor for class edu.amc.sakai.user.EntryContainerRdnToUserTypeMapper

escapeSearchFilterTerm(String) - Method in interface edu.amc.sakai.user.LdapAttributeMapper

Scrubs the given search filter term (i.e. a value to be matched, or not, in a search predicate) for reserved characters.

escapeSearchFilterTerm(String) - Method in class edu.amc.sakai.user.SimpleLdapAttributeMapper

F

finalize() - Method in class edu.amc.sakai.user.PooledLDAPConnection

protect against pooled connections leaking out of the pool

findUserByEmail(UserEdit, String) - Method in class edu.amc.sakai.user.JLDAPDirectoryProvider

Locates a user directory entry using an email address as a key.

findUsersByEmail(String, UserFactory) - Method in class edu.amc.sakai.user.JLDAPDirectoryProvider

Find all user objects which have this email address.

FIRST_NAME_ATTR_MAPPING_KEY - Static variable in class edu.amc.sakai.user.AttributeMappingConstants

Key into AttributeMappingConstants.DEFAULT_ATTR_MAPPINGS representing the logical name of a user entry's given name attribute

formatSearchFilter() - Method in class edu.amc.sakai.user.SearchExecutingLdapConnectionLivenessValidator

Generates an executable search filter string by injecting the result of SearchExecutingLdapConnectionLivenessValidator.generateUniqueSearchFilterTerm() into the current searchFilter.

G

generateUniqueSearchFilterTerm() - Method in class edu.amc.sakai.user.SearchExecutingLdapConnectionLivenessValidator

Generates a portion of the search filter which will (likely) uniquely identify an execution of that filter.

generateUniqueToken() - Method in class edu.amc.sakai.user.SearchExecutingLdapConnectionLivenessValidator

Just returns the current system time in millis.

getAdditionalRoles(String) - Method in class edu.amc.sakai.user.UserAttributeRoleProvider

getAddressPattern() - Method in class edu.amc.sakai.user.EmailAddressDerivingLdapAttributeMapper

Access the current email address validation pattern, as assigned by EmailAddressDerivingLdapAttributeMapper.setAddressPattern(String).

getAllAdditionalRoles() - Method in class edu.amc.sakai.user.UserAttributeRoleProvider

getAttributeMapping(String) - Method in interface edu.amc.sakai.user.LdapAttributeMapper

Map the given logical attribute name to a physical attribute name.

getAttributeMapping(String) - Method in class edu.amc.sakai.user.SimpleLdapAttributeMapper

Map the given logical attribute name to a physical attribute name.

getAttributeMappings() - Method in class edu.amc.sakai.user.JLDAPDirectoryProvider

getAttributeMappings() - Method in interface edu.amc.sakai.user.LdapAttributeMapper

Access the current directory attribute map.

getAttributeMappings() - Method in class edu.amc.sakai.user.SimpleLdapAttributeMapper

Returns a direct reference to the currently cached mappings.

getAttributeValueToSakaiUserTypeMap() - Method in class edu.amc.sakai.user.EntryAttributeToUserTypeMapper

Retrieve the current attribute value-to-Sakai user type map.

getBaseDn() - Method in class edu.amc.sakai.user.SearchExecutingLdapConnectionLivenessValidator

getBasePath() - Method in class edu.amc.sakai.user.JLDAPDirectoryProvider

getBatchSize() - Method in class edu.amc.sakai.user.JLDAPDirectoryProvider

getBatchSize() - Method in interface edu.amc.sakai.user.LdapConnectionManagerConfig

getBirthdate() - Method in class edu.amc.sakai.user.PooledLDAPConnection

getBoundConnection(String, String) - Method in interface edu.amc.sakai.user.LdapConnectionManager

Retrieve a bound LDAPConnection using the indicated credentials

getBoundConnection(String, String) - Method in class edu.amc.sakai.user.PoolingLdapConnectionManager

getBoundConnection(String, String) - Method in class edu.amc.sakai.user.SimpleLdapConnectionManager

Retrieve a bound LDAPConnection using the indicated credentials

getConfig() - Method in interface edu.amc.sakai.user.LdapConnectionManager

Retrieve the currently assigned LdapConnectionManagerConfig.

getConfig() - Method in class edu.amc.sakai.user.SimpleLdapConnectionManager

Retrieve the currently assigned LdapConnectionManagerConfig.

getConnection() - Method in interface edu.amc.sakai.user.LdapConnectionManager

Retrieve an LDAPConnection -- the connection may already be bound depending on the configuration

getConnection() - Method in class edu.amc.sakai.user.PoolingLdapConnectionManager

Retrieve an LDAPConnection -- the connection may already be bound depending on the configuration

getConnection() - Method in class edu.amc.sakai.user.SimpleLdapConnectionManager

Retrieve an LDAPConnection -- the connection may already be bound depending on the configuration

getConnectionLivenessValidator() - Method in class edu.amc.sakai.user.PooledLDAPConnectionFactory

Access the strategy for verifying LDAPConnection liveness.

getConnectionManager() - Method in class edu.amc.sakai.user.PooledLDAPConnection

getConnectionManager() - Method in class edu.amc.sakai.user.PooledLDAPConnectionFactory

Gives the LdapConnectionMananger that the Factory is using to configure its PooledLDAPConnections.

getConnectTimeout() - Method in class edu.amc.sakai.user.LDAPJSSESecureSocketFactory

getConnectTimeout() - Method in class edu.amc.sakai.user.LDAPSimpleSocketFactory

getDefaultAddressDomain() - Method in class edu.amc.sakai.user.EmailAddressDerivingLdapAttributeMapper

See EmailAddressDerivingLdapAttributeMapper.setDefaultAddressDomain(String)

getDefaultSakaiUserType() - Method in class edu.amc.sakai.user.EntryAttributeToUserTypeMapper

Retrieve the default Sakai user type, which will be returned from EntryAttributeToUserTypeMapper.mapLdapEntryToSakaiUserType(LDAPEntry, LdapAttributeMapper) if no mapping was found and EntryAttributeToUserTypeMapper.isReturnLiteralAttributeValueIfNoMapping() is false

getDelegates() - Method in class edu.amc.sakai.user.ConsensusLdapConnectionLivenessValidator

Assign the list of LdapConnectionLivenessValidators to consult when validating any given connection.

getDisplayId(User) - Method in class edu.amc.sakai.user.JLDAPDirectoryProvider

getDisplayName(User) - Method in class edu.amc.sakai.user.JLDAPDirectoryProvider

getDisplayName(String) - Method in class edu.amc.sakai.user.UserAttributeRoleProvider

getEid() - Method in class edu.amc.sakai.user.LdapUserData

getEidBlacklist() - Method in class edu.amc.sakai.user.RegexpBlacklistEidValidator

Access the String representation of blacklisted User EID regexps configured on this object.

getEidValidator() - Method in class edu.amc.sakai.user.JLDAPDirectoryProvider

Access the service used to verify EIDs prior to executing searches on those values.

getEmail() - Method in class edu.amc.sakai.user.LdapUserData

getFactory() - Method in class edu.amc.sakai.user.PoolingLdapConnectionManager

getFindUserByAidFilter(String) - Method in interface edu.amc.sakai.user.LdapAttributeMapper

Output a filter string for searching the directory with the specified user aid as a key.

getFindUserByAidFilter(String) - Method in class edu.amc.sakai.user.SimpleLdapAttributeMapper

getFindUserByCrossAttributeSearchFilter(String) - Method in interface edu.amc.sakai.user.LdapAttributeMapper

Builds a filter to perform a wildcard search for criteria in uid, email, first name or last name In order to minimise hitting the limits of searches, this only performs a wildcard match on anything after the supplied criteria.

getFindUserByCrossAttributeSearchFilter(String) - Method in class edu.amc.sakai.user.SimpleLdapAttributeMapper

getFindUserByEidFilter(String) - Method in interface edu.amc.sakai.user.LdapAttributeMapper

Output a filter string for searching the directory with the specified user eid as a key.

getFindUserByEidFilter(String) - Method in class edu.amc.sakai.user.SimpleLdapAttributeMapper

Builds a filter of the form <login-attr>=<eid>

getFindUserByEmailFilter(String) - Method in interface edu.amc.sakai.user.LdapAttributeMapper

Output a filter string for searching the directory with the specified email address as a key.

getFindUserByEmailFilter(String) - Method in class edu.amc.sakai.user.MultipleEmailLdapAttributeMapper

getFindUserByEmailFilter(String) - Method in class edu.amc.sakai.user.SimpleLdapAttributeMapper

Builds a filter of the form <email-attr>=<emailAddr>

getFirstName() - Method in class edu.amc.sakai.user.LdapUserData

getHost() - Method in class edu.amc.sakai.user.PooledLDAPConnectionFactory

Get the host to connect to.

getHostName() - Method in class edu.amc.sakai.user.SearchExecutingLdapConnectionLivenessValidator

getKeystoreLocation() - Method in class edu.amc.sakai.user.JLDAPDirectoryProvider

getKeystoreLocation() - Method in interface edu.amc.sakai.user.LdapConnectionManagerConfig

getKeystorePassword() - Method in class edu.amc.sakai.user.JLDAPDirectoryProvider

getKeystorePassword() - Method in interface edu.amc.sakai.user.LdapConnectionManagerConfig

getLastName() - Method in class edu.amc.sakai.user.LdapUserData

getLdapAttributeMapper() - Method in class edu.amc.sakai.user.JLDAPDirectoryProvider

Access the currently assigned LdapAttributeMapper delegate.

getLdapConnectionManager() - Method in class edu.amc.sakai.user.JLDAPDirectoryProvider

Access the currently assigned LdapConnectionManager delegate.

getLdapHost() - Method in class edu.amc.sakai.user.JLDAPDirectoryProvider

getLdapHost() - Method in interface edu.amc.sakai.user.LdapConnectionManagerConfig

getLdapPassword() - Method in class edu.amc.sakai.user.JLDAPDirectoryProvider

getLdapPassword() - Method in interface edu.amc.sakai.user.LdapConnectionManagerConfig

getLdapPort() - Method in class edu.amc.sakai.user.JLDAPDirectoryProvider

getLdapPort() - Method in interface edu.amc.sakai.user.LdapConnectionManagerConfig

getLdapUser() - Method in class edu.amc.sakai.user.JLDAPDirectoryProvider

getLdapUser() - Method in interface edu.amc.sakai.user.LdapConnectionManagerConfig

getLocalhostName() - Method in class edu.amc.sakai.user.SearchExecutingLdapConnectionLivenessValidator

Returns localhost's name as reported by InetAddress#getLocalHost()#toString().

getLogicalAttributeName() - Method in class edu.amc.sakai.user.EntryAttributeToUserTypeMapper

Access the key to a physical attribute name which will be used to resolve Sakai user types.

getManyUsersInOneSearch(Set<String>) - Method in interface edu.amc.sakai.user.LdapAttributeMapper

Builds a filter to a uid search against many users at once For reference, the LDAP search filter is of the form: "(|(uid=sample.user)(uid=john.doe)(uid=jane.smith))"

getManyUsersInOneSearch(Set<String>) - Method in class edu.amc.sakai.user.SimpleLdapAttributeMapper

getMaxObjectsToQueryFor() - Method in class edu.amc.sakai.user.JLDAPDirectoryProvider

getMaxObjectsToQueryFor() - Method in interface edu.amc.sakai.user.LdapConnectionManagerConfig

Deprecated.

LdapConnectionManagerConfig.getBatchSize()

getMaxResultSize() - Method in class edu.amc.sakai.user.JLDAPDirectoryProvider

getMaxResultSize() - Method in interface edu.amc.sakai.user.LdapConnectionManagerConfig

getMaxTtl() - Method in class edu.amc.sakai.user.MaxLifetimeLdapConnectionLivenessValidator

Get the max connection lifetime, in millis.

getMemoryService() - Method in class edu.amc.sakai.user.JLDAPDirectoryProvider

getOperationTimeout() - Method in class edu.amc.sakai.user.JLDAPDirectoryProvider

getOperationTimeout() - Method in interface edu.amc.sakai.user.LdapConnectionManagerConfig

getPoolMaxConns() - Method in class edu.amc.sakai.user.JLDAPDirectoryProvider

getPoolMaxConns() - Method in interface edu.amc.sakai.user.LdapConnectionManagerConfig

getPreferredFirstName() - Method in class edu.amc.sakai.user.LdapUserData

getProperties() - Method in class edu.amc.sakai.user.LdapUserData

getRdnToSakaiUserTypeMap() - Method in class edu.amc.sakai.user.EntryContainerRdnToUserTypeMapper

EntryContainerRdnToUserTypeMapper.mapRdn(String,String)

getRegexpFlags() - Method in class edu.amc.sakai.user.RegexpBlacklistEidValidator

Access the configured set of Pattern matching flags.

getReverseAttributeMap() - Method in class edu.amc.sakai.user.SimpleLdapAttributeMapper

getReverseAttributeMappings(String) - Method in class edu.amc.sakai.user.SimpleLdapAttributeMapper

Access the configured logical names associated with the given physical attribute name.

getSearchableEmailAttributes() - Method in class edu.amc.sakai.user.MultipleEmailLdapAttributeMapper

Access the list of logical attribute names searched when locating a user entry by email address.

getSearchAttributeName() - Method in class edu.amc.sakai.user.SearchExecutingLdapConnectionLivenessValidator

getSearchConstraints() - Method in class edu.amc.sakai.user.SearchExecutingLdapConnectionLivenessValidator

getSearchFilter() - Method in class edu.amc.sakai.user.SearchExecutingLdapConnectionLivenessValidator

getSearchResultAttributes() - Method in interface edu.amc.sakai.user.LdapAttributeMapper

Access the standard attributes returned from any given directory search.

getSearchResultAttributes() - Method in class edu.amc.sakai.user.SimpleLdapAttributeMapper

Implemented to return the current values of {link #getAttributeMappings().values() as a String array.

getSearchScope() - Method in class edu.amc.sakai.user.JLDAPDirectoryProvider

Access the configured search scope for all filters executed by JLDAPDirectoryProvider.searchDirectory(String, LDAPConnection, LdapEntryMapper, String[], String, int).

getSearchStamp() - Method in class edu.amc.sakai.user.SearchExecutingLdapConnectionLivenessValidator

getSecureSocketFactory() - Method in class edu.amc.sakai.user.JLDAPDirectoryProvider

Assign a LDAPSocketFactory appropriate for your environment, e.g.

getSecureSocketFactory() - Method in interface edu.amc.sakai.user.LdapConnectionManagerConfig

Assign a LDAPSocketFactory appropriate for your environment, e.g.

getServerConfigService() - Method in class edu.amc.sakai.user.SearchExecutingLdapConnectionLivenessValidator

getSocketFactory() - Method in class edu.amc.sakai.user.JLDAPDirectoryProvider

The socket factory to be used when creating insecure connections.

getSocketFactory() - Method in interface edu.amc.sakai.user.LdapConnectionManagerConfig

The socket factory to be used when creating insecure connections.

getType() - Method in class edu.amc.sakai.user.LdapUserData

getUser(UserEdit) - Method in class edu.amc.sakai.user.JLDAPDirectoryProvider

Effectively the same as getUserByEid(edit, edit.getEid()).

getUserBindDn(LdapUserData) - Method in interface edu.amc.sakai.user.LdapAttributeMapper

Determine the DN to which to bind when executing an authentication attempt for the given user.

getUserBindDn(LdapUserData) - Method in class edu.amc.sakai.user.SimpleLdapAttributeMapper

getUserbyAid(String, UserEdit) - Method in class edu.amc.sakai.user.JLDAPDirectoryProvider

getUserByAid(String, LDAPConnection) - Method in class edu.amc.sakai.user.JLDAPDirectoryProvider

getUserByEid(UserEdit, String, LDAPConnection) - Method in class edu.amc.sakai.user.JLDAPDirectoryProvider

Finds a user record using an eid as an index.

getUserByEid(String, LDAPConnection) - Method in class edu.amc.sakai.user.JLDAPDirectoryProvider

Finds a user record using an eid as an index.

getUserDataDn(LdapUserData) - Method in class edu.amc.sakai.user.SimpleLdapAttributeMapper

getUsers(Collection<UserEdit>) - Method in class edu.amc.sakai.user.JLDAPDirectoryProvider

Similar to iterating over users passing each element to JLDAPDirectoryProvider.getUser(UserEdit), removing the UserEdit if that method returns false.

getUserType() - Method in class edu.amc.sakai.user.StringUserTypeMapper

Access the user type String to be returned from any invocation of StringUserTypeMapper.mapLdapEntryToSakaiUserType(LDAPEntry, LdapAttributeMapper).

getUserTypeAttribute(LDAPEntry, LdapAttributeMapper) - Method in class edu.amc.sakai.user.EntryAttributeToUserTypeMapper

Extracts the LDAPAttribute which represents the LDAPEntry's group membership.

getUserTypeMapper() - Method in class edu.amc.sakai.user.SimpleLdapAttributeMapper

Access the strategy for calculating the Sakai user type given a LDAPEntry

getValueMappings() - Method in class edu.amc.sakai.user.SimpleLdapAttributeMapper

GROUP_MEMBERSHIP_ATTR_MAPPING_KEY - Static variable in class edu.amc.sakai.user.AttributeMappingConstants

Key into AttributeMappingConstants.DEFAULT_ATTR_MAPPINGS representing the logical name of a user entry's group membership attribute

I

init() - Method in class edu.amc.sakai.user.JLDAPDirectoryProvider

Typically invoked by Spring to complete bean initialization.

init() - Method in interface edu.amc.sakai.user.LdapAttributeMapper

Complete internal configuration.

init() - Method in interface edu.amc.sakai.user.LdapConnectionManager

Initializes an instance for use, typically by digesting the contents of the assigned LdapConnectionManagerConfig.

init() - Method in class edu.amc.sakai.user.PoolingLdapConnectionManager

Initializes an instance for use, typically by digesting the contents of the assigned LdapConnectionManagerConfig.

init() - Method in class edu.amc.sakai.user.SearchExecutingLdapConnectionLivenessValidator

Invoke prior to testing any connections.

init() - Method in class edu.amc.sakai.user.SimpleLdapAttributeMapper

Completes configuration of this instance.

init() - Method in class edu.amc.sakai.user.SimpleLdapCandidateAttributeMapper

Completes configuration of this instance.

init() - Method in class edu.amc.sakai.user.SimpleLdapConnectionManager

Initializes an instance for use, typically by digesting the contents of the assigned LdapConnectionManagerConfig.

init() - Method in class edu.amc.sakai.user.UserAttributeRoleProvider

initKeystoreLocation() - Method in class edu.amc.sakai.user.SimpleLdapConnectionManager

Caches a keystore location as a system property.

initKeystorePassword() - Method in class edu.amc.sakai.user.SimpleLdapConnectionManager

Caches a keystore password as a system property.

initLdapAttributeMapper() - Method in class edu.amc.sakai.user.JLDAPDirectoryProvider

Lazily "injects" a LdapAttributeMapper if one has not been assigned already.

initLdapConnectionManager() - Method in class edu.amc.sakai.user.JLDAPDirectoryProvider

Lazily "injects" a LdapConnectionManager if one has not been assigned already.

InvalidEmailAddressException - Exception in edu.amc.sakai.user

InvalidEmailAddressException() - Constructor for exception edu.amc.sakai.user.InvalidEmailAddressException

InvalidEmailAddressException(String) - Constructor for exception edu.amc.sakai.user.InvalidEmailAddressException

InvalidEmailAddressException(String, Throwable) - Constructor for exception edu.amc.sakai.user.InvalidEmailAddressException

InvalidEmailAddressException(Throwable) - Constructor for exception edu.amc.sakai.user.InvalidEmailAddressException

isActive() - Method in class edu.amc.sakai.user.PooledLDAPConnection

isAllowAuthentication() - Method in class edu.amc.sakai.user.JLDAPDirectoryProvider

Access the current global authentication "on/off" switch.

isAuthenticateWithProviderFirst() - Method in class edu.amc.sakai.user.JLDAPDirectoryProvider

Access the configured global return value for JLDAPDirectoryProvider.authenticateWithProviderFirst(String).

isAutoBind() - Method in class edu.amc.sakai.user.JLDAPDirectoryProvider

Access the LDAP auto-bind configuration

isAutoBind() - Method in interface edu.amc.sakai.user.LdapConnectionManagerConfig

Access the LDAP auto-bind configuration

isBindAttempted() - Method in class edu.amc.sakai.user.PooledLDAPConnection

isBlackListedEid(String) - Method in class edu.amc.sakai.user.RegexpBlacklistEidValidator

Encapsulates the logic for actually checking a user EID against the configured blacklist.

isConnectionAlive(LDAPConnection) - Method in class edu.amc.sakai.user.ConsensusLdapConnectionLivenessValidator

Tests the given LDAPConnection with each registered LdapConnectionLivenessValidator until one such delegate returns false>, in which case this method also returns false.

isConnectionAlive(LDAPConnection) - Method in interface edu.amc.sakai.user.LdapConnectionLivenessValidator

isConnectionAlive(LDAPConnection) - Method in class edu.amc.sakai.user.MaxLifetimeLdapConnectionLivenessValidator

Tests if the allowable lifetime of the given connection has already elapsed.

isConnectionAlive(LDAPConnection) - Method in class edu.amc.sakai.user.NativeLdapConnectionLivenessValidator

isConnectionAlive(LDAPConnection) - Method in class edu.amc.sakai.user.SearchExecutingLdapConnectionLivenessValidator

isFollowReferrals() - Method in class edu.amc.sakai.user.JLDAPDirectoryProvider

Access LDAP referral following configuration

isFollowReferrals() - Method in interface edu.amc.sakai.user.LdapConnectionManagerConfig

Access LDAP referral following configuration

isMinimallyValidEid(String) - Method in class edu.amc.sakai.user.RegexpBlacklistEidValidator

As implemented requires that the given ID be non-null and non-whitespace.

isPooling() - Method in class edu.amc.sakai.user.JLDAPDirectoryProvider

Access the LDAP pooling configuration

isPooling() - Method in interface edu.amc.sakai.user.LdapConnectionManagerConfig

Access the LDAP pooling configuration

isRecurseRdnIfNoMapping() - Method in class edu.amc.sakai.user.EntryContainerRdnToUserTypeMapper

EntryContainerRdnToUserTypeMapper.mapRdn(String,String)

isReturnLiteralAttributeValueIfNoMapping() - Method in class edu.amc.sakai.user.EntryAttributeToUserTypeMapper

Check the behavior when attribute values cannot be mapped to a Sakai user type.

isReturnLiteralRdnValueIfNoMapping() - Method in class edu.amc.sakai.user.EntryContainerRdnToUserTypeMapper

EntryContainerRdnToUserTypeMapper.mapRdn(String,String)

isSearchableEid(String) - Method in interface edu.amc.sakai.user.EidValidator

isSearchableEid(String) - Method in class edu.amc.sakai.user.JLDAPDirectoryProvider

Consults the cached EidValidator to determine if the given User EID is searchable.

isSearchableEid(String) - Method in class edu.amc.sakai.user.RegexpBlacklistEidValidator

Requires minimally valid and non-blacklisted EIDs.

isSearchAliases() - Method in class edu.amc.sakai.user.JLDAPDirectoryProvider

isSecureConnection() - Method in class edu.amc.sakai.user.JLDAPDirectoryProvider

If true, connect to LDAP over a secure protocol.

isSecureConnection() - Method in interface edu.amc.sakai.user.LdapConnectionManagerConfig

If true, connect to LDAP over a secure protocol.

isTlsSocketFactory() - Method in class edu.amc.sakai.user.SimpleLdapConnectionManager

J

JLDAPDirectoryProvider - Class in edu.amc.sakai.user

An implementation of a Sakai UserDirectoryProvider that authenticates/retrieves users from a LDAP directory.

JLDAPDirectoryProvider() - Constructor for class edu.amc.sakai.user.JLDAPDirectoryProvider

K

KEYSTORE_LOCATION_SYS_PROP_KEY - Static variable in class edu.amc.sakai.user.SimpleLdapConnectionManager

KEYSTORE_PASSWORD_SYS_PROP_KEY - Static variable in class edu.amc.sakai.user.SimpleLdapConnectionManager

L

LAST_NAME_ATTR_MAPPING_KEY - Static variable in class edu.amc.sakai.user.AttributeMappingConstants

Key into AttributeMappingConstants.DEFAULT_ATTR_MAPPINGS representing the logical name of a user entry's surname attribute

LdapAttributeMapper - Interface in edu.amc.sakai.user

Implementations handle mappings between logical and physical directory attribute names and between directory entries and Sakai domain and framework objects.

LdapConnectionLivenessValidator - Interface in edu.amc.sakai.user

Pluggable strategy for verifying LDAPConnection "liveness".

LdapConnectionManager - Interface in edu.amc.sakai.user

Implementations manage LDAPConnection allocation.

LdapConnectionManagerConfig - Interface in edu.amc.sakai.user

Bean interface for collecting LdapConnectionManager configuration.

LdapEntryMapper - Interface in edu.amc.sakai.user

Similar to org.springframework.jdbc.core.RowMapper, but for LDAPSearchResults rather than ResultSets.

LDAPJSSESecureSocketFactory - Class in edu.amc.sakai.user

Represents a socket factory that creates secure socket connections to LDAP servers using JSSE technology.

LDAPJSSESecureSocketFactory() - Constructor for class edu.amc.sakai.user.LDAPJSSESecureSocketFactory

Constructs an LDAPSecureSocketFactory object using the default provider for a JSSE SSLSocketFactory.

LDAPJSSESecureSocketFactory(SSLSocketFactory) - Constructor for class edu.amc.sakai.user.LDAPJSSESecureSocketFactory

Constructs an LDAPSocketFactory object using the SSLSocketFactory specified.

LDAPSimpleSocketFactory - Class in edu.amc.sakai.user

This simple socket factory sets a connect timeout on any sockets it creates.

LDAPSimpleSocketFactory() - Constructor for class edu.amc.sakai.user.LDAPSimpleSocketFactory

LdapUserData - Class in edu.amc.sakai.user

Snapshot of a user directory entry, typically used for cache entries in JLDAPDirectoryProvider

LdapUserData() - Constructor for class edu.amc.sakai.user.LdapUserData

LOGIN_ATTR_MAPPING_KEY - Static variable in class edu.amc.sakai.user.AttributeMappingConstants

Key into AttributeMappingConstants.DEFAULT_ATTR_MAPPINGS representing the logical name of a user entry's login (aka Sakai "EID") attribute

lookupUserBindDn(String, LDAPConnection) - Method in class edu.amc.sakai.user.JLDAPDirectoryProvider

Search the directory for a DN corresponding to a user's EID.

M

makeObject() - Method in class edu.amc.sakai.user.PooledLDAPConnectionFactory

Constructs a new PooledLDAPConnection object, including: passing it the connection manager so it can return itself to the pool if it falls out of scope, setting a default set of constraints, connecting to the server, initiating TLS if needed.

mapLdapAttributeOntoUserData(LDAPAttribute, LdapUserData, Collection<String>) - Method in class edu.amc.sakai.user.SimpleLdapAttributeMapper

Map the given LDAPAttribute onto the given LdapUserData.

mapLdapAttributeOntoUserData(LDAPAttribute, LdapUserData, String) - Method in class edu.amc.sakai.user.SimpleLdapAttributeMapper

A delegate of SimpleLdapAttributeMapper.mapLdapAttributeOntoUserData(LDAPAttribute, LdapUserData, Collection) that allows for discrete handling of each logical attribute name associated with the given LDAPAttribute

mapLdapEntry(LDAPEntry, int) - Method in interface edu.amc.sakai.user.LdapEntryMapper

Map the given LDAPEntry onto some Object.

mapLdapEntryOntoUserData(LDAPEntry, LdapUserData) - Method in class edu.amc.sakai.user.EmailAddressDerivingLdapAttributeMapper

mapLdapEntryOntoUserData(LDAPEntry) - Method in class edu.amc.sakai.user.JLDAPDirectoryProvider

Maps attributes from the specified LDAPEntry onto a newly instantiated LdapUserData.

mapLdapEntryOntoUserData(LDAPEntry, LdapUserData) - Method in interface edu.amc.sakai.user.LdapAttributeMapper

Maps attribites from the specified LDAPEntry onto a LdapUserData.

mapLdapEntryOntoUserData(LDAPEntry, LdapUserData) - Method in class edu.amc.sakai.user.SimpleLdapAttributeMapper

Performs LDAPEntry-to- attribute mappings.

mapLdapEntryToSakaiUserType(LDAPEntry, LdapAttributeMapper) - Method in class edu.amc.sakai.user.EntryAttributeToUserTypeMapper

Maps the attribute values associated with the specified LDAPEntry to a Sakai user type.

mapLdapEntryToSakaiUserType(LDAPEntry, LdapAttributeMapper) - Method in class edu.amc.sakai.user.EntryContainerRdnToUserTypeMapper

Returns the user type associated with a matching RDN encountered when iterating through the specified LDAPEntry's containing DN's RDNs.

mapLdapEntryToSakaiUserType(LDAPEntry) - Method in class edu.amc.sakai.user.SimpleLdapAttributeMapper

Passes the given LDAPEntry and a reference to this SimpleLdapAttributeMapper to UserTypeMapper.mapLdapEntryToSakaiUserType(LDAPEntry, LdapAttributeMapper).

mapLdapEntryToSakaiUserType(LDAPEntry, LdapAttributeMapper) - Method in class edu.amc.sakai.user.StringUserTypeMapper

Always returns the value set by StringUserTypeMapper.setUserType(String).

mapLdapEntryToSakaiUserType(LDAPEntry, LdapAttributeMapper) - Method in interface edu.amc.sakai.user.UserTypeMapper

Calculate a Sakai user type given a LDAPEntry and a LdapAttributeMapper.

mapRdn(String, String) - Method in class edu.amc.sakai.user.EntryContainerRdnToUserTypeMapper

Applies the current mapping configuration to the recieved RDN value.

mapUserDataOntoUserEdit(LdapUserData, UserEdit) - Method in class edu.amc.sakai.user.JLDAPDirectoryProvider

Maps attribites from the specified LdapUserData onto a UserEdit.

mapUserDataOntoUserEdit(LdapUserData, UserEdit) - Method in interface edu.amc.sakai.user.LdapAttributeMapper

Maps attribites from the specified LdapUserData onto a UserEdit.

mapUserDataOntoUserEdit(LdapUserData, UserEdit) - Method in class edu.amc.sakai.user.SimpleLdapAttributeMapper

Straightforward LdapUserData to UserEdit field-to-field mapping, including properties.

mapUserDataOntoUserEdit(LdapUserData, UserEdit) - Method in class edu.amc.sakai.user.SimpleLdapCandidateAttributeMapper

Straightforward LdapUserData to UserEdit field-to-field mapping, including properties.

mapUserTypeAttributeValue(String) - Method in class edu.amc.sakai.user.EntryAttributeToUserTypeMapper

Effectively the same as getAttributeValueToSakaiUserTypeMap().get(attrValue).

mapUserTypeAttributeValues(String[]) - Method in class edu.amc.sakai.user.EntryAttributeToUserTypeMapper

Maps the given list of attribute values to a single Sakai user type by passing each received String value, in order, to EntryAttributeToUserTypeMapper.mapUserTypeAttributeValue(String).

MaxLifetimeLdapConnectionLivenessValidator - Class in edu.amc.sakai.user

MaxLifetimeLdapConnectionLivenessValidator() - Constructor for class edu.amc.sakai.user.MaxLifetimeLdapConnectionLivenessValidator

MultipleEmailLdapAttributeMapper - Class in edu.amc.sakai.user

Adds support for finding users by email address where users may have email addresses stored across multiple LDAP attributes.

MultipleEmailLdapAttributeMapper() - Constructor for class edu.amc.sakai.user.MultipleEmailLdapAttributeMapper

N

NativeLdapConnectionLivenessValidator - Class in edu.amc.sakai.user

NativeLdapConnectionLivenessValidator() - Constructor for class edu.amc.sakai.user.NativeLdapConnectionLivenessValidator

newConnection() - Method in class edu.amc.sakai.user.PooledLDAPConnectionFactory

newConnection() - Method in class edu.amc.sakai.user.SimpleLdapConnectionManager

newDefaultConnectionLivenessValidator() - Method in class edu.amc.sakai.user.PooledLDAPConnectionFactory

As implemented, will return a new NativeLdapConnectionLivenessValidator.

newDefaultLdapAttributeMapper() - Method in class edu.amc.sakai.user.JLDAPDirectoryProvider

Factory method for default LdapAttributeMapper instances.

newDefaultLdapConnectionManager() - Method in class edu.amc.sakai.user.JLDAPDirectoryProvider

Factory method for default LdapConnectionManager instances.

newLdapUserData() - Method in class edu.amc.sakai.user.JLDAPDirectoryProvider

Instantiates a LdapUserData.

newUnformattedSearchFilter() - Method in class edu.amc.sakai.user.SearchExecutingLdapConnectionLivenessValidator

P

passivateObject(Object) - Method in class edu.amc.sakai.user.PooledLDAPConnectionFactory

Passivates a PooledLDAPConnection as it is being returned to the pool, including: clearing the active flag so that it won't attempt to return itself to the pool.

PooledLDAPConnection - Class in edu.amc.sakai.user

Extension of standard LDAPConnection that attempts to return objects to the pool if someone just drops them out of scope.

PooledLDAPConnection() - Constructor for class edu.amc.sakai.user.PooledLDAPConnection

PooledLDAPConnectionFactory - Class in edu.amc.sakai.user

An object factory for managing PooledLDAPConnections within the commons-pool library.

PooledLDAPConnectionFactory() - Constructor for class edu.amc.sakai.user.PooledLDAPConnectionFactory

PoolingLdapConnectionManager - Class in edu.amc.sakai.user

Allocates connected, constrained, bound and optionally secure LDAPConnections.

PoolingLdapConnectionManager() - Constructor for class edu.amc.sakai.user.PoolingLdapConnectionManager

postConnect(LDAPConnection) - Method in class edu.amc.sakai.user.SimpleLdapConnectionManager

PREFERRED_FIRST_NAME_ATTR_MAPPING_KEY - Static variable in class edu.amc.sakai.user.AttributeMappingConstants

Key into AttributeMappingConstants.DEFAULT_ATTR_MAPPINGS representing the logical name of a user entry's preferred given name attribute

R

RegexpBlacklistEidValidator - Class in edu.amc.sakai.user

Implements User EID "validation" by checking for matches in a configurable blacklist, entries in which are treated as regular expressions.

RegexpBlacklistEidValidator() - Constructor for class edu.amc.sakai.user.RegexpBlacklistEidValidator

returnConnection(LDAPConnection) - Method in interface edu.amc.sakai.user.LdapConnectionManager

Return an LDAPConnection.

returnConnection(LDAPConnection) - Method in class edu.amc.sakai.user.PoolingLdapConnectionManager

Return an LDAPConnection.

returnConnection(LDAPConnection) - Method in class edu.amc.sakai.user.SimpleLdapConnectionManager

Return an LDAPConnection.

reverseAttributeMap(Map<String, String>) - Method in class edu.amc.sakai.user.SimpleLdapAttributeMapper

Creates a reverse lookup map of a given attribute map's values.

S

scrubSearchBaseDn(String) - Method in class edu.amc.sakai.user.JLDAPDirectoryProvider

Responsible for pre-processing base DNs passed to #searchDirectory(String, LDAPConnection, String[], String, int).

scrubSearchResultPhysicalAttributeNames(String[]) - Method in class edu.amc.sakai.user.JLDAPDirectoryProvider

Responsible for pre-processing search result attribute names passed to #searchDirectory(String, LDAPConnection, String[], String, int).

searchDirectory(String, LDAPConnection, LdapEntryMapper, String[], String, int) - Method in class edu.amc.sakai.user.JLDAPDirectoryProvider

Execute a directory search using the specified filter and connection.

searchDirectoryForSingleEntry(String, LDAPConnection, LdapEntryMapper, String[], String) - Method in class edu.amc.sakai.user.JLDAPDirectoryProvider

Searches the directory for at most one entry matching the specified filter.

SearchExecutingLdapConnectionLivenessValidator - Class in edu.amc.sakai.user

Tests LDAPConnection liveness by executing a search filter and verifying that the result contains at least one entry.

SearchExecutingLdapConnectionLivenessValidator() - Constructor for class edu.amc.sakai.user.SearchExecutingLdapConnectionLivenessValidator

searchExternalUsers(String, int, int, UserFactory) - Method in class edu.amc.sakai.user.JLDAPDirectoryProvider

Search for externally provided users that match this criteria in eid, email, first or last name.

setActive(boolean) - Method in class edu.amc.sakai.user.PooledLDAPConnection

setAdditionalInfoLength(int) - Method in class edu.amc.sakai.user.SimpleLdapCandidateAttributeMapper

setAddressPattern(String) - Method in class edu.amc.sakai.user.EmailAddressDerivingLdapAttributeMapper

Assign the Pattern against which strings passed to EmailAddressDerivingLdapAttributeMapper.unpackEidFromAddress(String) must validate in order to be processed by EmailAddressDerivingLdapAttributeMapper.doUnpackEidFromAddress(String)

setAllowAuthentication(boolean) - Method in class edu.amc.sakai.user.JLDAPDirectoryProvider

Access the current global authentication "on/off" switch.

setAttributeMappings(Map<String, String>) - Method in class edu.amc.sakai.user.JLDAPDirectoryProvider

setAttributeMappings(Map<String, String>) - Method in interface edu.amc.sakai.user.LdapAttributeMapper

Assign the directory attribute map.

setAttributeMappings(Map<String, String>) - Method in class edu.amc.sakai.user.SimpleLdapAttributeMapper

Caches the given Map reference and takes a snapshot of the values therein for future use by SimpleLdapAttributeMapper.getSearchResultAttributes().

setAttributeMappings(Map<String, String>) - Method in class edu.amc.sakai.user.SimpleLdapCandidateAttributeMapper

Caches the given Map reference and takes a snapshot of the values therein for future use by SimpleLdapAttributeMapper.getSearchResultAttributes().

setAttributeValueToSakaiUserTypeMap(Map<String, String>) - Method in class edu.amc.sakai.user.EntryAttributeToUserTypeMapper

Assign the attribute value-to-Sakai user type map.

setAuthenticateAllowed(boolean) - Method in class edu.amc.sakai.user.JLDAPDirectoryProvider

An alias of JLDAPDirectoryProvider.setAllowAuthentication(boolean) for backward compatibility with existing customized deployments of this provider which had already implemented this feature.

setAuthenticateWithProviderFirst(boolean) - Method in class edu.amc.sakai.user.JLDAPDirectoryProvider

Configure the global return value of JLDAPDirectoryProvider.authenticateWithProviderFirst(String).

setAutoBind(boolean) - Method in class edu.amc.sakai.user.JLDAPDirectoryProvider

Configure the LDAP auto-bind configuration param autoBind if true connection allocation (LdapConnectionManager.getConnection()) will include a bind attempt

setAutoBind(boolean) - Method in interface edu.amc.sakai.user.LdapConnectionManagerConfig

Configure the LDAP auto-bind configuration param autoBind if true connection allocation (LdapConnectionManager.getConnection()) will include a bind attempt

setBaseDn(String) - Method in class edu.amc.sakai.user.SearchExecutingLdapConnectionLivenessValidator

setBasePath(String) - Method in class edu.amc.sakai.user.JLDAPDirectoryProvider

setBatchSize(int) - Method in class edu.amc.sakai.user.JLDAPDirectoryProvider

setBatchSize(int) - Method in interface edu.amc.sakai.user.LdapConnectionManagerConfig

setBindAttempted(boolean) - Method in class edu.amc.sakai.user.PooledLDAPConnection

setCandidateIdLength(int) - Method in class edu.amc.sakai.user.SimpleLdapCandidateAttributeMapper

setConfig(LdapConnectionManagerConfig) - Method in interface edu.amc.sakai.user.LdapConnectionManager

Assign the LDAPConnection management configuration.

setConfig(LdapConnectionManagerConfig) - Method in class edu.amc.sakai.user.SimpleLdapConnectionManager

Assign the LDAPConnection management configuration.

setConnectionLivenessValidator(LdapConnectionLivenessValidator) - Method in class edu.amc.sakai.user.PooledLDAPConnectionFactory

Assign a strategy for verifying LDAPConnection liveness.

setConnectionManager(LdapConnectionManager) - Method in class edu.amc.sakai.user.PooledLDAPConnection

setConnectionManager(LdapConnectionManager) - Method in class edu.amc.sakai.user.PooledLDAPConnectionFactory

Sets the LdapConnectionManager that the Factory will use to configure and manage its PooledLDAPConnections.

setConnectTimeout(int) - Method in class edu.amc.sakai.user.LDAPJSSESecureSocketFactory

setConnectTimeout(int) - Method in class edu.amc.sakai.user.LDAPSimpleSocketFactory

setDefaultAddressDomain(String) - Method in class edu.amc.sakai.user.EmailAddressDerivingLdapAttributeMapper

Assign the domain to be used when deriving email addresses from user EIDs.

setDefaultSakaiUserType(String) - Method in class edu.amc.sakai.user.EntryAttributeToUserTypeMapper

Assign the default Sakai user type.

setDelegates(List<LdapConnectionLivenessValidator>) - Method in class edu.amc.sakai.user.ConsensusLdapConnectionLivenessValidator

Assign the list of LdapConnectionLivenessValidators to consult when validating any given connection.

setEid(String) - Method in class edu.amc.sakai.user.LdapUserData

setEidBlacklist(Collection<String>) - Method in class edu.amc.sakai.user.RegexpBlacklistEidValidator

Converts the given collection of Strings into a collection of s and caches the latter for evaluation by isSearchableEid(String).

setEidValidator(EidValidator) - Method in class edu.amc.sakai.user.JLDAPDirectoryProvider

Assign the service used to verify EIDs prior to executing searches on those values.

setEmail(String) - Method in class edu.amc.sakai.user.LdapUserData

setEnableAid(boolean) - Method in class edu.amc.sakai.user.JLDAPDirectoryProvider

setEnableAid(boolean) - Method in interface edu.amc.sakai.user.LdapConnectionManagerConfig

setEncryption(ValueEncryptionUtilities) - Method in class edu.amc.sakai.user.SimpleLdapCandidateAttributeMapper

setFactory(PooledLDAPConnectionFactory) - Method in class edu.amc.sakai.user.PoolingLdapConnectionManager

setFirstName(String) - Method in class edu.amc.sakai.user.LdapUserData

setFollowReferrals(boolean) - Method in class edu.amc.sakai.user.JLDAPDirectoryProvider

Configures LDAP referral following

setFollowReferrals(boolean) - Method in interface edu.amc.sakai.user.LdapConnectionManagerConfig

Configures LDAP referral following

setHostName(String) - Method in class edu.amc.sakai.user.SearchExecutingLdapConnectionLivenessValidator

Assign the host name to be appended to (semi) invocation-unique search terms.

setKeystoreLocation(String) - Method in class edu.amc.sakai.user.JLDAPDirectoryProvider

setKeystoreLocation(String) - Method in interface edu.amc.sakai.user.LdapConnectionManagerConfig

setKeystorePassword(String) - Method in class edu.amc.sakai.user.JLDAPDirectoryProvider

setKeystorePassword(String) - Method in interface edu.amc.sakai.user.LdapConnectionManagerConfig

setLastName(String) - Method in class edu.amc.sakai.user.LdapUserData

setLdapAttributeMapper(LdapAttributeMapper) - Method in class edu.amc.sakai.user.JLDAPDirectoryProvider

Assign the LdapAttributeMapper delegate.

setLdapConnectionManager(LdapConnectionManager) - Method in class edu.amc.sakai.user.JLDAPDirectoryProvider

Assign the LdapConnectionManager delegate.

setLdapHost(String) - Method in class edu.amc.sakai.user.JLDAPDirectoryProvider

setLdapHost(String) - Method in interface edu.amc.sakai.user.LdapConnectionManagerConfig

setLdapPassword(String) - Method in class edu.amc.sakai.user.JLDAPDirectoryProvider

setLdapPassword(String) - Method in interface edu.amc.sakai.user.LdapConnectionManagerConfig

setLdapPort(int) - Method in class edu.amc.sakai.user.JLDAPDirectoryProvider

setLdapPort(int) - Method in interface edu.amc.sakai.user.LdapConnectionManagerConfig

setLdapUser(String) - Method in class edu.amc.sakai.user.JLDAPDirectoryProvider

setLdapUser(String) - Method in interface edu.amc.sakai.user.LdapConnectionManagerConfig

setLogicalAttributeName(String) - Method in class edu.amc.sakai.user.EntryAttributeToUserTypeMapper

Assign the key to a physical attribute name which will be used to resolve Sakai user types.

setMaxObjectsToQueryFor(int) - Method in class edu.amc.sakai.user.JLDAPDirectoryProvider

setMaxObjectsToQueryFor(int) - Method in interface edu.amc.sakai.user.LdapConnectionManagerConfig

Deprecated.

LdapConnectionManagerConfig.setBatchSize(int)

setMaxResultSize(int) - Method in class edu.amc.sakai.user.JLDAPDirectoryProvider

setMaxResultSize(int) - Method in interface edu.amc.sakai.user.LdapConnectionManagerConfig

setMaxTtl(long) - Method in class edu.amc.sakai.user.MaxLifetimeLdapConnectionLivenessValidator

Assign the max connection lifetime, in millis.

setMemoryService(MemoryService) - Method in class edu.amc.sakai.user.JLDAPDirectoryProvider

setOperationTimeout(int) - Method in class edu.amc.sakai.user.JLDAPDirectoryProvider

setOperationTimeout(int) - Method in interface edu.amc.sakai.user.LdapConnectionManagerConfig

setPool(ObjectPool) - Method in class edu.amc.sakai.user.PoolingLdapConnectionManager

Assign a pool implementation.

setPooling(boolean) - Method in class edu.amc.sakai.user.JLDAPDirectoryProvider

Configure the LDAP connection pooling configuration param pooling if true connections will be maintained in a connection pool.

setPooling(boolean) - Method in interface edu.amc.sakai.user.LdapConnectionManagerConfig

Configure the LDAP connection pooling configuration param pooling if true connections will be maintained in a connection pool.

setPoolMaxConns(int) - Method in class edu.amc.sakai.user.JLDAPDirectoryProvider

setPoolMaxConns(int) - Method in interface edu.amc.sakai.user.LdapConnectionManagerConfig

setPreferredFirstName(String) - Method in class edu.amc.sakai.user.LdapUserData

setProperties(Properties) - Method in class edu.amc.sakai.user.LdapUserData

setProperty(String, String) - Method in class edu.amc.sakai.user.LdapUserData

Assign a single property to the user, possibly overwriting and existing entry.

setRdnToSakaiUserTypeMap(Map<String, String>) - Method in class edu.amc.sakai.user.EntryContainerRdnToUserTypeMapper

EntryContainerRdnToUserTypeMapper.mapRdn(String,String)

setRecurseRdnIfNoMapping(boolean) - Method in class edu.amc.sakai.user.EntryContainerRdnToUserTypeMapper

EntryContainerRdnToUserTypeMapper.mapRdn(String,String)

setRegexpFlags(int) - Method in class edu.amc.sakai.user.RegexpBlacklistEidValidator

Assign a bitmask for Pattern matching behaviors.

setReturnLiteralAttributeValueIfNoMapping(boolean) - Method in class edu.amc.sakai.user.EntryAttributeToUserTypeMapper

Assign the behavior for calculating Sakai user types when attribute values fail to map.

setReturnLiteralRdnIfNoMapping(boolean) - Method in class edu.amc.sakai.user.EntryContainerRdnToUserTypeMapper

EntryContainerRdnToUserTypeMapper.mapRdn(String,String)

setSearchableEmailAttributes(List<String>) - Method in class edu.amc.sakai.user.MultipleEmailLdapAttributeMapper

Assign the list of logical attribute names to search when locating a user entry by email address.

setSearchAliases(boolean) - Method in class edu.amc.sakai.user.JLDAPDirectoryProvider

setSearchAttributeName(String) - Method in class edu.amc.sakai.user.SearchExecutingLdapConnectionLivenessValidator

setSearchConstraints(LDAPSearchConstraints) - Method in class edu.amc.sakai.user.SearchExecutingLdapConnectionLivenessValidator

setSearchFilter(String) - Method in class edu.amc.sakai.user.SearchExecutingLdapConnectionLivenessValidator

setSearchScope(int) - Method in class edu.amc.sakai.user.JLDAPDirectoryProvider

Set the configured search scope for all filters executed by JLDAPDirectoryProvider.searchDirectory(String, LDAPConnection, LdapEntryMapper, String[], String, int).

setSearchStamp(String) - Method in class edu.amc.sakai.user.SearchExecutingLdapConnectionLivenessValidator

setSecureConnection(boolean) - Method in class edu.amc.sakai.user.JLDAPDirectoryProvider

Set to true if LDAP connections should occur over a secure protocol.

setSecureConnection(boolean) - Method in interface edu.amc.sakai.user.LdapConnectionManagerConfig

Set to true if LDAP connections should occur over a secure protocol.

setSecureSocketFactory(LDAPSocketFactory) - Method in class edu.amc.sakai.user.JLDAPDirectoryProvider

setSecureSocketFactory(LDAPSocketFactory) - Method in interface edu.amc.sakai.user.LdapConnectionManagerConfig

setServerConfigService(ServerConfigurationService) - Method in class edu.amc.sakai.user.SearchExecutingLdapConnectionLivenessValidator

setServerConfigurationService(ServerConfigurationService) - Method in class edu.amc.sakai.user.SimpleLdapCandidateAttributeMapper

setSocketFactory(LDAPSocketFactory) - Method in class edu.amc.sakai.user.JLDAPDirectoryProvider

setSocketFactory(LDAPSocketFactory) - Method in interface edu.amc.sakai.user.LdapConnectionManagerConfig

setStatusAttribute(String) - Method in class edu.amc.sakai.user.UserAttributeRoleProvider

setStatusRoles(Map<String, Set<String>>) - Method in class edu.amc.sakai.user.UserAttributeRoleProvider

setStudentNumberLength(int) - Method in class edu.amc.sakai.user.SimpleLdapCandidateAttributeMapper

setType(String) - Method in class edu.amc.sakai.user.LdapUserData

setUserDataDn(LDAPEntry, LdapUserData) - Method in class edu.amc.sakai.user.SimpleLdapAttributeMapper

setUserDirectoryService(UserDirectoryService) - Method in class edu.amc.sakai.user.UserAttributeRoleProvider

setUserType(String) - Method in class edu.amc.sakai.user.EmptyStringUserTypeMapper

Overridden to log a warn message but otherwise do nothing.

setUserType(String) - Method in class edu.amc.sakai.user.StringUserTypeMapper

Set the user type String to be returned from any invocation of StringUserTypeMapper.mapLdapEntryToSakaiUserType(LDAPEntry, LdapAttributeMapper).

setUserTypeMapper(UserTypeMapper) - Method in class edu.amc.sakai.user.SimpleLdapAttributeMapper

Assign the strategy for calculating the Sakai user type given a LDAPEntry

setValueMappings(Map<String, MessageFormat>) - Method in class edu.amc.sakai.user.SimpleLdapAttributeMapper

SimpleLdapAttributeMapper - Class in edu.amc.sakai.user

Implements LDAP attribute mappings and filter generations using an attribute map keyed by constants in AttributeMappingConstants.

SimpleLdapAttributeMapper() - Constructor for class edu.amc.sakai.user.SimpleLdapAttributeMapper

SimpleLdapCandidateAttributeMapper - Class in edu.amc.sakai.user

Extension for SimpleLdapAttributeMapper.

SimpleLdapCandidateAttributeMapper() - Constructor for class edu.amc.sakai.user.SimpleLdapCandidateAttributeMapper

SimpleLdapConnectionManager - Class in edu.amc.sakai.user

Allocates connected, constrained, and optionally bound and secure LDAPConnections

SimpleLdapConnectionManager() - Constructor for class edu.amc.sakai.user.SimpleLdapConnectionManager

StringUserTypeMapper - Class in edu.amc.sakai.user

Very simple UserTypeMapper which generates the same String value for any users.

StringUserTypeMapper() - Constructor for class edu.amc.sakai.user.StringUserTypeMapper

Leaves the cached user type String initialized to null

StringUserTypeMapper(String) - Constructor for class edu.amc.sakai.user.StringUserTypeMapper

Sets the cached user type to the given String.

STUDENT_NUMBER_ATTR_MAPPING_KEY - Static variable in class edu.amc.sakai.user.AttributeMappingConstants

SYSTEM_PROP_ENCRYPT_NUMERIC_ID - Static variable in class edu.amc.sakai.user.AttributeMappingConstants

T

toString() - Method in class edu.amc.sakai.user.LdapUserData

Output a multi-line String representation of this LdapUserData instance.

U

unpackEidFromAddress(String) - Method in interface edu.amc.sakai.user.EidDerivedEmailAddressHandler

Extract a user EID from the given email address.

unpackEidFromAddress(String) - Method in class edu.amc.sakai.user.EmailAddressDerivingLdapAttributeMapper

Returns EmailAddressDerivingLdapAttributeMapper.doUnpackEidFromAddress(String) if the given email/code> string validates against EmailAddressDerivingLdapAttributeMapper.validateAddress(String).

usePreferredFirstName(LdapUserData) - Method in class edu.amc.sakai.user.SimpleLdapAttributeMapper

Determines if a user has a preferredFirstName set and if so, returns it for use.

USER_DN_PROPERTY - Static variable in class edu.amc.sakai.user.AttributeMappingConstants

Key into LdapUserData properties linking to the user's directory DN value.

UserAttributeRoleProvider - Class in edu.amc.sakai.user

This just uses attributes set on the user by the LDAP provider to determine role membership.

UserAttributeRoleProvider() - Constructor for class edu.amc.sakai.user.UserAttributeRoleProvider

userExists(String) - Method in class edu.amc.sakai.user.JLDAPDirectoryProvider

Effectively the same as getUserByEid(null,eid).

UserTypeMapper - Interface in edu.amc.sakai.user

Represents a pluggable strategy for calculating a Sakai user type given a user's directory entry

V

validateAddress(String) - Method in class edu.amc.sakai.user.EmailAddressDerivingLdapAttributeMapper

Validate the given string against the Pattern configured by EmailAddressDerivingLdapAttributeMapper.setAddressPattern(String).

validateObject(Object) - Method in class edu.amc.sakai.user.PooledLDAPConnectionFactory

Validates a PooledLDAPConnection by checking if the connection is alive and ensuring it is properly bound as the autoBind user.

A B C D E F G I J K L M N P R S T U V