Index (sakai-unboundid-provider 22.1 API)

A C D E F G I L M N O P R S T U V
All Classes All Packages

A

appendSingleSearchPredicate(StringBuilder, String, String) - Method in class org.sakaiproject.unboundid.MultipleEmailLdapAttributeMapper
AttributeMappingConstants - Class in org.sakaiproject.unboundid: A container for LDAP attribute mapping constants.
AttributeMappingConstants() - Constructor for class org.sakaiproject.unboundid.AttributeMappingConstants
authenticateUser(String, UserEdit, String) - Method in class org.sakaiproject.unboundid.UnboundidDirectoryProvider: Authenticates the specified user login by recursively searching for and binding to a DN below the configured base DN.
authenticateWithProviderFirst(String) - Method in class org.sakaiproject.unboundid.UnboundidDirectoryProvider: By default returns the global boolean setting configured via UnboundidDirectoryProvider.setAuthenticateWithProviderFirst(boolean).
AUTHENTICATION_ATTR_MAPPING_KEY - Static variable in class org.sakaiproject.unboundid.AttributeMappingConstants: Key into AttributeMappingConstants.DEFAULT_ATTR_MAPPINGS representing the logical name of a user entry's authentication (aka Sakai "AID") attribute

C

clearCache() - Method in class org.sakaiproject.unboundid.UnboundidDirectoryProvider: Resets the internal LdapUserData cache
createConnectionPool() - Method in class org.sakaiproject.unboundid.UnboundidDirectoryProvider: Create the LDAP connection pool

D

DEFAULT_ALLOW_AUTHENTICATION - Static variable in class org.sakaiproject.unboundid.UnboundidDirectoryProvider
DEFAULT_ALLOW_AUTHENTICATION_ADMIN - Static variable in class org.sakaiproject.unboundid.UnboundidDirectoryProvider
DEFAULT_ALLOW_AUTHENTICATION_EXTERNAL - Static variable in class org.sakaiproject.unboundid.UnboundidDirectoryProvider
DEFAULT_ALLOW_GET_EXTERNAL - Static variable in class org.sakaiproject.unboundid.UnboundidDirectoryProvider
DEFAULT_ALLOW_SEARCH_EXTERNAL - Static variable in class org.sakaiproject.unboundid.UnboundidDirectoryProvider
DEFAULT_ATTR_MAPPINGS - Static variable in class org.sakaiproject.unboundid.AttributeMappingConstants: Default set of user entry attribute mappings.
DEFAULT_AUTHENTICATE_WITH_PROVIDER_FIRST - Static variable in class org.sakaiproject.unboundid.UnboundidDirectoryProvider
DEFAULT_AUTHENTICATION_ATTR - Static variable in class org.sakaiproject.unboundid.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 org.sakaiproject.unboundid.UnboundidDirectoryProvider: Default LDAP maximum number of objects to query for
DEFAULT_EMAIL_ATTR - Static variable in class org.sakaiproject.unboundid.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 org.sakaiproject.unboundid.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 org.sakaiproject.unboundid.AttributeMappingConstants: Default value in AttributeMappingConstants.DEFAULT_ATTR_MAPPINGS representing the physical name of a user entry's group membership attribute
DEFAULT_HEALTH_CHECK_INTERVAL_MILLIS - Static variable in class org.sakaiproject.unboundid.UnboundidDirectoryProvider
DEFAULT_IS_FOLLOW_REFERRALS - Static variable in class org.sakaiproject.unboundid.UnboundidDirectoryProvider: Default referral following behavior
DEFAULT_IS_SEARCH_ALIASES - Static variable in class org.sakaiproject.unboundid.UnboundidDirectoryProvider
DEFAULT_IS_SECURE_CONNECTION - Static variable in class org.sakaiproject.unboundid.UnboundidDirectoryProvider: Default secure/unsecure LDAP connection creation behavior
DEFAULT_LAST_NAME_ATTR - Static variable in class org.sakaiproject.unboundid.AttributeMappingConstants: Default value in AttributeMappingConstants.DEFAULT_ATTR_MAPPINGS representing the physical name of a user entry's surname attribute
DEFAULT_LDAP_PORT - Static variable in class org.sakaiproject.unboundid.UnboundidDirectoryProvider: Default LDAP connection port
DEFAULT_LOGIN_ATTR - Static variable in class org.sakaiproject.unboundid.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 org.sakaiproject.unboundid.UnboundidDirectoryProvider: Default LDAP maximum number of objects in a result
DEFAULT_OPERATION_TIMEOUT_MILLIS - Static variable in class org.sakaiproject.unboundid.UnboundidDirectoryProvider: Default LDAP access timeout in milliseconds
DEFAULT_POOL_MAX_CONNS - Static variable in class org.sakaiproject.unboundid.UnboundidDirectoryProvider: Default LDAP maximum number of connections in the pool
DEFAULT_PREFERRED_FIRST_NAME_ATTR - Static variable in class org.sakaiproject.unboundid.AttributeMappingConstants: Default value in AttributeMappingConstants.DEFAULT_ATTR_MAPPINGS representing the physical name of a user entry's preferred given name attribute.
DEFAULT_RETRY_FAILED_OPERATIONS_DUE_TO_INVALID_CONNECTIONS - Static variable in class org.sakaiproject.unboundid.UnboundidDirectoryProvider
DEFAULT_SEARCH_SCOPE - Static variable in class org.sakaiproject.unboundid.UnboundidDirectoryProvider: Default search scope for filters executed by #searchDirectory(String, LDAPConnection, LdapEntryMapper, String[], String, int)
defaultLdapEntryMapper - Variable in class org.sakaiproject.unboundid.UnboundidDirectoryProvider: Defaults to an anon-inner class which handles LDAPEntry(ies) by passing them to UnboundidDirectoryProvider.mapLdapEntryOntoUserData(LDAPEntry), the result of which is returned.
deriveAddressFromEid(String) - Method in class org.sakaiproject.unboundid.EmailAddressDerivingLdapAttributeMapper: Calculate an email address from the given user EID.
destroy() - Method in class org.sakaiproject.unboundid.UnboundidDirectoryProvider: Typically called by Spring to signal bean destruction.
DISPLAY_ID_ATTR_MAPPING_KEY - Static variable in class org.sakaiproject.unboundid.AttributeMappingConstants
DISPLAY_ID_PROPERTY - Static variable in class org.sakaiproject.unboundid.UnboundidDirectoryProvider: Property of the user object to store the display ID under
DISPLAY_NAME_ATTR_MAPPING_KEY - Static variable in class org.sakaiproject.unboundid.AttributeMappingConstants
DISPLAY_NAME_PROPERTY - Static variable in class org.sakaiproject.unboundid.UnboundidDirectoryProvider: Property of the user object to store the display Name under
doUnpackEidFromAddress(String) - Method in class org.sakaiproject.unboundid.EmailAddressDerivingLdapAttributeMapper: Calculates a user EID from an email address, assuming the address has already passed muster with EmailAddressDerivingLdapAttributeMapper.validateAddress(String).

E

EidDerivedEmailAddressHandler - Interface in org.sakaiproject.unboundid: Mixin interface for objects capable of calculating a user EID from an email address.
EidValidator - Interface in org.sakaiproject.unboundid
EMAIL_ATTR_MAPPING_KEY - Static variable in class org.sakaiproject.unboundid.AttributeMappingConstants: Key into AttributeMappingConstants.DEFAULT_ATTR_MAPPINGS representing the logical name of a user entry's email attribute
EmailAddressDerivingLdapAttributeMapper - Class in org.sakaiproject.unboundid
EmailAddressDerivingLdapAttributeMapper() - Constructor for class org.sakaiproject.unboundid.EmailAddressDerivingLdapAttributeMapper
EmptyStringUserTypeMapper - Class in org.sakaiproject.unboundid: Essentially a null impl, which always returns an empty String from StringUserTypeMapper.mapLdapEntryToSakaiUserType(LDAPEntry, LdapAttributeMapper).
EmptyStringUserTypeMapper() - Constructor for class org.sakaiproject.unboundid.EmptyStringUserTypeMapper: Initializes the cached user type String to an empty String
EntryAttributeToUserTypeMapper - Class in org.sakaiproject.unboundid: Maps from a user entry's attribute to a Sakai user type.
EntryAttributeToUserTypeMapper() - Constructor for class org.sakaiproject.unboundid.EntryAttributeToUserTypeMapper
EntryContainerRdnToUserTypeMapper - Class in org.sakaiproject.unboundid: Maps from a user entry's container's most-local RDN to a Sakai user type.
EntryContainerRdnToUserTypeMapper() - Constructor for class org.sakaiproject.unboundid.EntryContainerRdnToUserTypeMapper
escapeSearchFilterTerm(String) - Method in interface org.sakaiproject.unboundid.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 org.sakaiproject.unboundid.SimpleLdapAttributeMapper

F

findUserByEmail(UserEdit, String) - Method in class org.sakaiproject.unboundid.UnboundidDirectoryProvider: Locates a user directory entry using an email address as a key.
findUsersByEmail(String, UserFactory) - Method in class org.sakaiproject.unboundid.UnboundidDirectoryProvider: Find all user objects which have this email address.
FIRST_NAME_ATTR_MAPPING_KEY - Static variable in class org.sakaiproject.unboundid.AttributeMappingConstants: Key into AttributeMappingConstants.DEFAULT_ATTR_MAPPINGS representing the logical name of a user entry's given name attribute

G

getAdditionalRoles(String) - Method in class org.sakaiproject.unboundid.UserAttributeRoleProvider
getAddressPattern() - Method in class org.sakaiproject.unboundid.EmailAddressDerivingLdapAttributeMapper: Access the current email address validation pattern, as assigned by EmailAddressDerivingLdapAttributeMapper.setAddressPattern(String).
getAllAdditionalRoles() - Method in class org.sakaiproject.unboundid.UserAttributeRoleProvider
getAttributeMapping(String) - Method in interface org.sakaiproject.unboundid.LdapAttributeMapper: Map the given logical attribute name to a physical attribute name.
getAttributeMapping(String) - Method in class org.sakaiproject.unboundid.SimpleLdapAttributeMapper: Map the given logical attribute name to a physical attribute name.
getAttributeMappings() - Method in interface org.sakaiproject.unboundid.LdapAttributeMapper: Access the current directory attribute map.
getAttributeMappings() - Method in class org.sakaiproject.unboundid.SimpleLdapAttributeMapper: Returns a direct reference to the currently cached mappings.
getAttributeMappings() - Method in class org.sakaiproject.unboundid.UnboundidDirectoryProvider
getAttributeValueToSakaiUserTypeMap() - Method in class org.sakaiproject.unboundid.EntryAttributeToUserTypeMapper: Retrieve the current attribute value-to-Sakai user type map.
getBasePath() - Method in class org.sakaiproject.unboundid.UnboundidDirectoryProvider
getBatchSize() - Method in interface org.sakaiproject.unboundid.LdapConnectionManagerConfig
getBatchSize() - Method in class org.sakaiproject.unboundid.UnboundidDirectoryProvider
getDefaultAddressDomain() - Method in class org.sakaiproject.unboundid.EmailAddressDerivingLdapAttributeMapper: See EmailAddressDerivingLdapAttributeMapper.setDefaultAddressDomain(String)
getDefaultSakaiUserType() - Method in class org.sakaiproject.unboundid.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
getDisplayId(User) - Method in class org.sakaiproject.unboundid.UnboundidDirectoryProvider
getDisplayName(String) - Method in class org.sakaiproject.unboundid.UserAttributeRoleProvider
getDisplayName(User) - Method in class org.sakaiproject.unboundid.UnboundidDirectoryProvider
getEid() - Method in class org.sakaiproject.unboundid.LdapUserData
getEidBlacklist() - Method in class org.sakaiproject.unboundid.RegexpBlacklistEidValidator: Access the String representation of blacklisted User EID regexps configured on this object.
getEidValidator() - Method in class org.sakaiproject.unboundid.UnboundidDirectoryProvider: Access the service used to verify EIDs prior to executing searches on those values.
getEmail() - Method in class org.sakaiproject.unboundid.LdapUserData
getFindUserByAidFilter(String) - Method in interface org.sakaiproject.unboundid.LdapAttributeMapper: Output a filter string for searching the directory with the specified user aid as a key.
getFindUserByAidFilter(String) - Method in class org.sakaiproject.unboundid.SimpleLdapAttributeMapper
getFindUserByCrossAttributeSearchFilter(String) - Method in interface org.sakaiproject.unboundid.LdapAttributeMapper: Builds a filter to perform a wildcard search for criteria in uid, email, first name or last name
getFindUserByCrossAttributeSearchFilter(String) - Method in class org.sakaiproject.unboundid.SimpleLdapAttributeMapper
getFindUserByEidFilter(String) - Method in interface org.sakaiproject.unboundid.LdapAttributeMapper: Output a filter string for searching the directory with the specified user eid as a key.
getFindUserByEidFilter(String) - Method in class org.sakaiproject.unboundid.SimpleLdapAttributeMapper: Builds a filter of the form <login-attr>=<eid>
getFindUserByEmailFilter(String) - Method in interface org.sakaiproject.unboundid.LdapAttributeMapper: Output a filter string for searching the directory with the specified email address as a key.
getFindUserByEmailFilter(String) - Method in class org.sakaiproject.unboundid.MultipleEmailLdapAttributeMapper
getFindUserByEmailFilter(String) - Method in class org.sakaiproject.unboundid.SimpleLdapAttributeMapper: Builds a filter of the form <email-attr>=<emailAddr>
getFirstName() - Method in class org.sakaiproject.unboundid.LdapUserData
getHealthCheckIntervalMillis() - Method in class org.sakaiproject.unboundid.UnboundidDirectoryProvider
getHealthCheckMappings() - Method in class org.sakaiproject.unboundid.UnboundidDirectoryProvider
getLastName() - Method in class org.sakaiproject.unboundid.LdapUserData
getLdapAttributeMapper() - Method in class org.sakaiproject.unboundid.UnboundidDirectoryProvider: Access the currently assigned LdapAttributeMapper delegate.
getLdapHost() - Method in interface org.sakaiproject.unboundid.LdapConnectionManagerConfig
getLdapHost() - Method in class org.sakaiproject.unboundid.UnboundidDirectoryProvider
getLdapPassword() - Method in interface org.sakaiproject.unboundid.LdapConnectionManagerConfig
getLdapPassword() - Method in class org.sakaiproject.unboundid.UnboundidDirectoryProvider
getLdapPort() - Method in interface org.sakaiproject.unboundid.LdapConnectionManagerConfig
getLdapPort() - Method in class org.sakaiproject.unboundid.UnboundidDirectoryProvider
getLdapUser() - Method in interface org.sakaiproject.unboundid.LdapConnectionManagerConfig
getLdapUser() - Method in class org.sakaiproject.unboundid.UnboundidDirectoryProvider
getLogicalAttributeName() - Method in class org.sakaiproject.unboundid.EntryAttributeToUserTypeMapper: Access the key to a physical attribute name which will be used to resolve Sakai user types.
getManyUsersInOneSearch(Set<String>) - Method in interface org.sakaiproject.unboundid.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 org.sakaiproject.unboundid.SimpleLdapAttributeMapper
getMaxObjectsToQueryFor() - Method in class org.sakaiproject.unboundid.UnboundidDirectoryProvider
getMaxResultSize() - Method in interface org.sakaiproject.unboundid.LdapConnectionManagerConfig
getMaxResultSize() - Method in class org.sakaiproject.unboundid.UnboundidDirectoryProvider
getOperationTimeout() - Method in interface org.sakaiproject.unboundid.LdapConnectionManagerConfig
getOperationTimeout() - Method in class org.sakaiproject.unboundid.UnboundidDirectoryProvider
getPoolMaxConns() - Method in interface org.sakaiproject.unboundid.LdapConnectionManagerConfig
getPoolMaxConns() - Method in class org.sakaiproject.unboundid.UnboundidDirectoryProvider
getPreferredFirstName() - Method in class org.sakaiproject.unboundid.LdapUserData
getProperties() - Method in class org.sakaiproject.unboundid.LdapUserData
getRdnToSakaiUserTypeMap() - Method in class org.sakaiproject.unboundid.EntryContainerRdnToUserTypeMapper: {@see #mapRdn(String,String)}
getRegexpFlags() - Method in class org.sakaiproject.unboundid.RegexpBlacklistEidValidator: Access the configured set of Pattern matching flags.
getRetryFailedOperationsDueToInvalidConnections() - Method in class org.sakaiproject.unboundid.UnboundidDirectoryProvider
getReverseAttributeMap() - Method in class org.sakaiproject.unboundid.SimpleLdapAttributeMapper
getReverseAttributeMappings(String) - Method in class org.sakaiproject.unboundid.SimpleLdapAttributeMapper: Access the configured logical names associated with the given physical attribute name.
getSearchableEmailAttributes() - Method in class org.sakaiproject.unboundid.MultipleEmailLdapAttributeMapper: Access the list of logical attribute names searched when locating a user entry by email address.
getSearchResultAttributes() - Method in interface org.sakaiproject.unboundid.LdapAttributeMapper: Access the standard attributes returned from any given directory search.
getSearchResultAttributes() - Method in class org.sakaiproject.unboundid.SimpleLdapAttributeMapper: Implemented to return the current values of {link {@link #getAttributeMappings().values()} as a String array.
getSearchScope() - Method in class org.sakaiproject.unboundid.UnboundidDirectoryProvider: Access the configured search scope for all filters executed by #searchDirectory(String, LDAPConnection, LdapEntryMapper, String[], String, int).
getType() - Method in class org.sakaiproject.unboundid.LdapUserData
getUser(UserEdit) - Method in class org.sakaiproject.unboundid.UnboundidDirectoryProvider: Effectively the same as getUserByEid(edit, edit.getEid()).
getUserBindDn(LdapUserData) - Method in interface org.sakaiproject.unboundid.LdapAttributeMapper: Determine the DN to which to bind when executing an authentication attempt for the given user.
getUserBindDn(LdapUserData) - Method in class org.sakaiproject.unboundid.SimpleLdapAttributeMapper
getUserbyAid(String, UserEdit) - Method in class org.sakaiproject.unboundid.UnboundidDirectoryProvider
getUserByAid(String) - Method in class org.sakaiproject.unboundid.UnboundidDirectoryProvider
getUserByEid(String) - Method in class org.sakaiproject.unboundid.UnboundidDirectoryProvider: Finds a user record using an eid as an index.
getUserByEid(UserEdit, String) - Method in class org.sakaiproject.unboundid.UnboundidDirectoryProvider: Finds a user record using an eid as an index.
getUserDataDn(LdapUserData) - Method in class org.sakaiproject.unboundid.SimpleLdapAttributeMapper
getUsers(Collection<UserEdit>) - Method in class org.sakaiproject.unboundid.UnboundidDirectoryProvider: Similar to iterating over users passing each element to UnboundidDirectoryProvider.getUser(UserEdit), removing the UserEdit if that method returns false.
getUserType() - Method in class org.sakaiproject.unboundid.StringUserTypeMapper: Access the user type String to be returned from any invocation of StringUserTypeMapper.mapLdapEntryToSakaiUserType(LDAPEntry, LdapAttributeMapper).
getUserTypeAttribute(LDAPEntry, LdapAttributeMapper) - Method in class org.sakaiproject.unboundid.EntryAttributeToUserTypeMapper: Extracts the LDAPAttribute which represents the LDAPEntry's group membership.
getUserTypeMapper() - Method in class org.sakaiproject.unboundid.SimpleLdapAttributeMapper: Access the strategy for calculating the Sakai user type given a LDAPEntry
getValueMappings() - Method in class org.sakaiproject.unboundid.SimpleLdapAttributeMapper
GROUP_MEMBERSHIP_ATTR_MAPPING_KEY - Static variable in class org.sakaiproject.unboundid.AttributeMappingConstants: Key into AttributeMappingConstants.DEFAULT_ATTR_MAPPINGS representing the logical name of a user entry's group membership attribute

I

init() - Method in interface org.sakaiproject.unboundid.LdapAttributeMapper: Complete internal configuration.
init() - Method in class org.sakaiproject.unboundid.SimpleLdapAttributeMapper: Completes configuration of this instance.
init() - Method in class org.sakaiproject.unboundid.UnboundidDirectoryProvider: Typically invoked by Spring to complete bean initialization.
init() - Method in class org.sakaiproject.unboundid.UserAttributeRoleProvider
initLdapAttributeMapper() - Method in class org.sakaiproject.unboundid.UnboundidDirectoryProvider: Lazily "injects" a LdapAttributeMapper if one has not been assigned already.
InvalidEmailAddressException - Exception in org.sakaiproject.unboundid
InvalidEmailAddressException() - Constructor for exception org.sakaiproject.unboundid.InvalidEmailAddressException
InvalidEmailAddressException(String) - Constructor for exception org.sakaiproject.unboundid.InvalidEmailAddressException
InvalidEmailAddressException(String, Throwable) - Constructor for exception org.sakaiproject.unboundid.InvalidEmailAddressException
InvalidEmailAddressException(Throwable) - Constructor for exception org.sakaiproject.unboundid.InvalidEmailAddressException
isAllowAuthentication() - Method in class org.sakaiproject.unboundid.UnboundidDirectoryProvider: Access the current global authentication "on/off" switch.
isAuthenticateWithProviderFirst() - Method in class org.sakaiproject.unboundid.UnboundidDirectoryProvider: Access the configured global return value for UnboundidDirectoryProvider.authenticateWithProviderFirst(String).
isAutoBind() - Method in interface org.sakaiproject.unboundid.LdapConnectionManagerConfig: Access the LDAP auto-bind configuration
isAutoBind() - Method in class org.sakaiproject.unboundid.UnboundidDirectoryProvider: Access the LDAP auto-bind configuration
isBlackListedEid(String) - Method in class org.sakaiproject.unboundid.RegexpBlacklistEidValidator: Encapsulates the logic for actually checking a user EID against the configured blacklist.
isFollowReferrals() - Method in interface org.sakaiproject.unboundid.LdapConnectionManagerConfig: Access LDAP referral following configuration
isFollowReferrals() - Method in class org.sakaiproject.unboundid.UnboundidDirectoryProvider: Access LDAP referral following configuration
isMinimallyValidEid(String) - Method in class org.sakaiproject.unboundid.RegexpBlacklistEidValidator: As implemented requires that the given ID be non-null and non-whitespace.
isRecurseRdnIfNoMapping() - Method in class org.sakaiproject.unboundid.EntryContainerRdnToUserTypeMapper: {@see mapRdn(String,String)}
isReturnLiteralAttributeValueIfNoMapping() - Method in class org.sakaiproject.unboundid.EntryAttributeToUserTypeMapper: Check the behavior when attribute values cannot be mapped to a Sakai user type.
isReturnLiteralRdnValueIfNoMapping() - Method in class org.sakaiproject.unboundid.EntryContainerRdnToUserTypeMapper: {@see mapRdn(String,String)}
isSearchableEid(String) - Method in interface org.sakaiproject.unboundid.EidValidator
isSearchableEid(String) - Method in class org.sakaiproject.unboundid.RegexpBlacklistEidValidator: Requires minimally valid and non-blacklisted EIDs.
isSearchableEid(String) - Method in class org.sakaiproject.unboundid.UnboundidDirectoryProvider: Consults the cached EidValidator to determine if the given User EID is searchable.
isSearchAliases() - Method in class org.sakaiproject.unboundid.UnboundidDirectoryProvider
isSecureConnection() - Method in interface org.sakaiproject.unboundid.LdapConnectionManagerConfig: If true, connect to LDAP over a secure protocol.
isSecureConnection() - Method in class org.sakaiproject.unboundid.UnboundidDirectoryProvider: If true, connect to LDAP over a secure protocol.

L

LAST_NAME_ATTR_MAPPING_KEY - Static variable in class org.sakaiproject.unboundid.AttributeMappingConstants: Key into AttributeMappingConstants.DEFAULT_ATTR_MAPPINGS representing the logical name of a user entry's surname attribute
LdapAttributeMapper - Interface in org.sakaiproject.unboundid: Implementations handle mappings between logical and physical directory attribute names and between directory entries and Sakai domain and framework objects.
LdapConnectionManagerConfig - Interface in org.sakaiproject.unboundid: Bean interface for collecting LdapConnectionManager configuration.
LdapEntryMapper - Interface in org.sakaiproject.unboundid: Similar to org.springframework.jdbc.core.RowMapper, but for LDAPSearchResults rather than ResultSets.
LdapUserData - Class in org.sakaiproject.unboundid: Snapshot of a user directory entry, typically used for cache entries in UnboundidDirectoryProvider
LdapUserData() - Constructor for class org.sakaiproject.unboundid.LdapUserData
LOGIN_ATTR_MAPPING_KEY - Static variable in class org.sakaiproject.unboundid.AttributeMappingConstants: Key into AttributeMappingConstants.DEFAULT_ATTR_MAPPINGS representing the logical name of a user entry's login (aka Sakai "EID") attribute
lookupUserBindDn(String) - Method in class org.sakaiproject.unboundid.UnboundidDirectoryProvider: Search the directory for a DN corresponding to a user's EID.

M

mapLdapAttributeOntoUserData(LDAPAttribute, LdapUserData, String) - Method in class org.sakaiproject.unboundid.SimpleLdapAttributeMapper: A delegate of SimpleLdapAttributeMapper.mapLdapAttributeOntoUserData(LDAPAttribute, LdapUserData, Collection) that allows for discrete handling of each logical attribute name associated with the given LDAPAttribute
mapLdapAttributeOntoUserData(LDAPAttribute, LdapUserData, Collection<String>) - Method in class org.sakaiproject.unboundid.SimpleLdapAttributeMapper: Map the given LDAPAttribute onto the given LdapUserData.
mapLdapEntry(LDAPEntry, int) - Method in interface org.sakaiproject.unboundid.LdapEntryMapper: Map the given LDAPEntry onto some Object.
mapLdapEntryOntoUserData(LDAPEntry) - Method in class org.sakaiproject.unboundid.UnboundidDirectoryProvider: Maps attributes from the specified LDAPEntry onto a newly instantiated LdapUserData.
mapLdapEntryOntoUserData(LDAPEntry, LdapUserData) - Method in class org.sakaiproject.unboundid.EmailAddressDerivingLdapAttributeMapper
mapLdapEntryOntoUserData(LDAPEntry, LdapUserData) - Method in interface org.sakaiproject.unboundid.LdapAttributeMapper: Maps attribites from the specified LDAPEntry onto a LdapUserData.
mapLdapEntryOntoUserData(LDAPEntry, LdapUserData) - Method in class org.sakaiproject.unboundid.SimpleLdapAttributeMapper: Performs LDAPEntry-to- attribute mappings.
mapLdapEntryToSakaiUserType(LDAPEntry) - Method in class org.sakaiproject.unboundid.SimpleLdapAttributeMapper: Passes the given LDAPEntry and a reference to this SimpleLdapAttributeMapper to UserTypeMapper.mapLdapEntryToSakaiUserType(LDAPEntry, LdapAttributeMapper).
mapLdapEntryToSakaiUserType(LDAPEntry, LdapAttributeMapper) - Method in class org.sakaiproject.unboundid.EntryAttributeToUserTypeMapper: Maps the attribute values associated with the specified LDAPEntry to a Sakai user type.
mapLdapEntryToSakaiUserType(LDAPEntry, LdapAttributeMapper) - Method in class org.sakaiproject.unboundid.EntryContainerRdnToUserTypeMapper: Returns the user type associated with a matching RDN encountered when iterating through the specified LDAPEntry's containing DN's RDNs.
mapLdapEntryToSakaiUserType(LDAPEntry, LdapAttributeMapper) - Method in class org.sakaiproject.unboundid.StringUserTypeMapper: Always returns the value set by StringUserTypeMapper.setUserType(String).
mapLdapEntryToSakaiUserType(LDAPEntry, LdapAttributeMapper) - Method in interface org.sakaiproject.unboundid.UserTypeMapper: Calculate a Sakai user type given a LDAPEntry and a LdapAttributeMapper.
mapRdn(String) - Method in class org.sakaiproject.unboundid.EntryContainerRdnToUserTypeMapper: Applies the current mapping configuration to the recieved RDN value.
mapUserDataOntoUserEdit(LdapUserData, UserEdit) - Method in interface org.sakaiproject.unboundid.LdapAttributeMapper: Maps attribites from the specified LdapUserData onto a UserEdit.
mapUserDataOntoUserEdit(LdapUserData, UserEdit) - Method in class org.sakaiproject.unboundid.SimpleLdapAttributeMapper: Straightforward LdapUserData to UserEdit field-to-field mapping, including properties.
mapUserDataOntoUserEdit(LdapUserData, UserEdit) - Method in class org.sakaiproject.unboundid.UnboundidDirectoryProvider: Maps attribites from the specified LdapUserData onto a UserEdit.
mapUserTypeAttributeValue(String) - Method in class org.sakaiproject.unboundid.EntryAttributeToUserTypeMapper: Effectively the same as getAttributeValueToSakaiUserTypeMap().get(attrValue).
mapUserTypeAttributeValues(String[]) - Method in class org.sakaiproject.unboundid.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).
MultipleEmailLdapAttributeMapper - Class in org.sakaiproject.unboundid: Adds support for finding users by email address where users may have email addresses stored across multiple LDAP attributes.
MultipleEmailLdapAttributeMapper() - Constructor for class org.sakaiproject.unboundid.MultipleEmailLdapAttributeMapper





N

newDefaultLdapAttributeMapper() - Method in class org.sakaiproject.unboundid.UnboundidDirectoryProvider

Factory method for default LdapAttributeMapper instances.

newLdapUserData() - Method in class org.sakaiproject.unboundid.UnboundidDirectoryProvider

Instantiates a LdapUserData.





O

org.sakaiproject.unboundid - package org.sakaiproject.unboundid
 




P

PREFERRED_FIRST_NAME_ATTR_MAPPING_KEY - Static variable in class org.sakaiproject.unboundid.AttributeMappingConstants

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





R

RegexpBlacklistEidValidator - Class in org.sakaiproject.unboundid

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

RegexpBlacklistEidValidator() - Constructor for class org.sakaiproject.unboundid.RegexpBlacklistEidValidator
 
reverseAttributeMap(Map<String, String>) - Method in class org.sakaiproject.unboundid.SimpleLdapAttributeMapper

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





S

scrubSearchBaseDn(String) - Method in class org.sakaiproject.unboundid.UnboundidDirectoryProvider

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

scrubSearchResultPhysicalAttributeNames(String[]) - Method in class org.sakaiproject.unboundid.UnboundidDirectoryProvider

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

searchDirectory(String, LdapEntryMapper, String[], String, int) - Method in class org.sakaiproject.unboundid.UnboundidDirectoryProvider

Execute a directory search using the specified filter
 and connection.

searchDirectoryForSingleEntry(String, LdapEntryMapper, String[], String) - Method in class org.sakaiproject.unboundid.UnboundidDirectoryProvider

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

searchExternalUsers(String, int, int, UserFactory) - Method in class org.sakaiproject.unboundid.UnboundidDirectoryProvider

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

setAddressPattern(String) - Method in class org.sakaiproject.unboundid.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 org.sakaiproject.unboundid.UnboundidDirectoryProvider

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

setAttributeMappings(Map<String, String>) - Method in interface org.sakaiproject.unboundid.LdapAttributeMapper

Assign the directory attribute map.

setAttributeMappings(Map<String, String>) - Method in class org.sakaiproject.unboundid.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 org.sakaiproject.unboundid.UnboundidDirectoryProvider
 
setAttributeValueToSakaiUserTypeMap(Map<String, String>) - Method in class org.sakaiproject.unboundid.EntryAttributeToUserTypeMapper

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

setAuthenticateAllowed(boolean) - Method in class org.sakaiproject.unboundid.UnboundidDirectoryProvider

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

setAuthenticateWithProviderFirst(boolean) - Method in class org.sakaiproject.unboundid.UnboundidDirectoryProvider

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

setAutoBind(boolean) - Method in interface org.sakaiproject.unboundid.LdapConnectionManagerConfig

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

setAutoBind(boolean) - Method in class org.sakaiproject.unboundid.UnboundidDirectoryProvider

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

setBasePath(String) - Method in class org.sakaiproject.unboundid.UnboundidDirectoryProvider
 
setBatchSize(int) - Method in interface org.sakaiproject.unboundid.LdapConnectionManagerConfig
 
setBatchSize(int) - Method in class org.sakaiproject.unboundid.UnboundidDirectoryProvider
setDefaultAddressDomain(String) - Method in class org.sakaiproject.unboundid.EmailAddressDerivingLdapAttributeMapper

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

setDefaultSakaiUserType(String) - Method in class org.sakaiproject.unboundid.EntryAttributeToUserTypeMapper

Assign the default Sakai user type.

setEid(String) - Method in class org.sakaiproject.unboundid.LdapUserData
 
setEidBlacklist(Collection<String>) - Method in class org.sakaiproject.unboundid.RegexpBlacklistEidValidator

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

setEidValidator(EidValidator) - Method in class org.sakaiproject.unboundid.UnboundidDirectoryProvider

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

setEmail(String) - Method in class org.sakaiproject.unboundid.LdapUserData
 
setEnableAid(boolean) - Method in interface org.sakaiproject.unboundid.LdapConnectionManagerConfig
 
setEnableAid(boolean) - Method in class org.sakaiproject.unboundid.UnboundidDirectoryProvider
setFirstName(String) - Method in class org.sakaiproject.unboundid.LdapUserData
 
setFollowReferrals(boolean) - Method in interface org.sakaiproject.unboundid.LdapConnectionManagerConfig

Configures LDAP referral following

setFollowReferrals(boolean) - Method in class org.sakaiproject.unboundid.UnboundidDirectoryProvider

Configures LDAP referral following

setHealthCheckIntervalMillis(long) - Method in class org.sakaiproject.unboundid.UnboundidDirectoryProvider
 
setHealthCheckMappings(Map<String, String>) - Method in class org.sakaiproject.unboundid.UnboundidDirectoryProvider
 
setLastName(String) - Method in class org.sakaiproject.unboundid.LdapUserData
 
setLdapAttributeMapper(LdapAttributeMapper) - Method in class org.sakaiproject.unboundid.UnboundidDirectoryProvider

Assign the LdapAttributeMapper delegate.

setLdapHost(String[]) - Method in interface org.sakaiproject.unboundid.LdapConnectionManagerConfig
 
setLdapHost(String[]) - Method in class org.sakaiproject.unboundid.UnboundidDirectoryProvider
setLdapPassword(String) - Method in interface org.sakaiproject.unboundid.LdapConnectionManagerConfig
 
setLdapPassword(String) - Method in class org.sakaiproject.unboundid.UnboundidDirectoryProvider
setLdapPort(int[]) - Method in interface org.sakaiproject.unboundid.LdapConnectionManagerConfig
 
setLdapPort(int[]) - Method in class org.sakaiproject.unboundid.UnboundidDirectoryProvider
setLdapUser(String) - Method in interface org.sakaiproject.unboundid.LdapConnectionManagerConfig
 
setLdapUser(String) - Method in class org.sakaiproject.unboundid.UnboundidDirectoryProvider
setLogicalAttributeName(String) - Method in class org.sakaiproject.unboundid.EntryAttributeToUserTypeMapper

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

setMaxObjectsToQueryFor(int) - Method in class org.sakaiproject.unboundid.UnboundidDirectoryProvider
setMaxResultSize(int) - Method in interface org.sakaiproject.unboundid.LdapConnectionManagerConfig
 
setMaxResultSize(int) - Method in class org.sakaiproject.unboundid.UnboundidDirectoryProvider
setOperationTimeout(int) - Method in interface org.sakaiproject.unboundid.LdapConnectionManagerConfig
 
setOperationTimeout(int) - Method in class org.sakaiproject.unboundid.UnboundidDirectoryProvider
setPoolMaxConns(int) - Method in interface org.sakaiproject.unboundid.LdapConnectionManagerConfig
 
setPoolMaxConns(int) - Method in class org.sakaiproject.unboundid.UnboundidDirectoryProvider
setPreferredFirstName(String) - Method in class org.sakaiproject.unboundid.LdapUserData
 
setProperties(Properties) - Method in class org.sakaiproject.unboundid.LdapUserData
 
setProperty(String, String) - Method in class org.sakaiproject.unboundid.LdapUserData

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

setRdnToSakaiUserTypeMap(Map<String, String>) - Method in class org.sakaiproject.unboundid.EntryContainerRdnToUserTypeMapper

{@see mapRdn(String,String)}

setRecurseRdnIfNoMapping(boolean) - Method in class org.sakaiproject.unboundid.EntryContainerRdnToUserTypeMapper

{@see mapRdn(String,String)}

setRegexpFlags(int) - Method in class org.sakaiproject.unboundid.RegexpBlacklistEidValidator

Assign a bitmask for Pattern matching behaviors.

setRetryFailedOperationsDueToInvalidConnections(boolean) - Method in class org.sakaiproject.unboundid.UnboundidDirectoryProvider
setReturnLiteralAttributeValueIfNoMapping(boolean) - Method in class org.sakaiproject.unboundid.EntryAttributeToUserTypeMapper

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

setReturnLiteralRdnValueIfNoMapping(boolean) - Method in class org.sakaiproject.unboundid.EntryContainerRdnToUserTypeMapper

{@see mapRdn(String,String)}

setSearchableEmailAttributes(List<String>) - Method in class org.sakaiproject.unboundid.MultipleEmailLdapAttributeMapper

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

setSearchAliases(boolean) - Method in class org.sakaiproject.unboundid.UnboundidDirectoryProvider
 
setSearchScope(int) - Method in class org.sakaiproject.unboundid.UnboundidDirectoryProvider

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

setSecureConnection(boolean) - Method in interface org.sakaiproject.unboundid.LdapConnectionManagerConfig

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

setSecureConnection(boolean) - Method in class org.sakaiproject.unboundid.UnboundidDirectoryProvider

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

setStatusAttribute(String) - Method in class org.sakaiproject.unboundid.UserAttributeRoleProvider
 
setStatusRoles(Map<String, Set<String>>) - Method in class org.sakaiproject.unboundid.UserAttributeRoleProvider
 
setType(String) - Method in class org.sakaiproject.unboundid.LdapUserData
 
setUserDataDn(LDAPEntry, LdapUserData) - Method in class org.sakaiproject.unboundid.SimpleLdapAttributeMapper
 
setUserDirectoryService(UserDirectoryService) - Method in class org.sakaiproject.unboundid.UserAttributeRoleProvider
 
setUserType(String) - Method in class org.sakaiproject.unboundid.EmptyStringUserTypeMapper

Overridden to log a warn message but otherwise do nothing.

setUserType(String) - Method in class org.sakaiproject.unboundid.StringUserTypeMapper

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

setUserTypeMapper(UserTypeMapper) - Method in class org.sakaiproject.unboundid.SimpleLdapAttributeMapper

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

setValueMappings(Map<String, MessageFormat>) - Method in class org.sakaiproject.unboundid.SimpleLdapAttributeMapper
 
SimpleLdapAttributeMapper - Class in org.sakaiproject.unboundid

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

SimpleLdapAttributeMapper() - Constructor for class org.sakaiproject.unboundid.SimpleLdapAttributeMapper
 
StringUserTypeMapper - Class in org.sakaiproject.unboundid

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

StringUserTypeMapper() - Constructor for class org.sakaiproject.unboundid.StringUserTypeMapper

Leaves the cached user type String initialized to null

StringUserTypeMapper(String) - Constructor for class org.sakaiproject.unboundid.StringUserTypeMapper

Sets the cached user type to the given String.





T

toString() - Method in class org.sakaiproject.unboundid.LdapUserData

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





U

UnboundidDirectoryProvider - Class in org.sakaiproject.unboundid


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

UnboundidDirectoryProvider() - Constructor for class org.sakaiproject.unboundid.UnboundidDirectoryProvider
 
unpackEidFromAddress(String) - Method in interface org.sakaiproject.unboundid.EidDerivedEmailAddressHandler

Extract a user EID from the given email address.

unpackEidFromAddress(String) - Method in class org.sakaiproject.unboundid.EmailAddressDerivingLdapAttributeMapper

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


usePreferredFirstName(LdapUserData) - Method in class org.sakaiproject.unboundid.SimpleLdapAttributeMapper

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

USER_DN_PROPERTY - Static variable in class org.sakaiproject.unboundid.AttributeMappingConstants

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

UserAttributeRoleProvider - Class in org.sakaiproject.unboundid

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

UserAttributeRoleProvider() - Constructor for class org.sakaiproject.unboundid.UserAttributeRoleProvider
 
userExists(String) - Method in class org.sakaiproject.unboundid.UnboundidDirectoryProvider

Effectively the same as getUserByEid(null,eid).

UserTypeMapper - Interface in org.sakaiproject.unboundid

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





V

validateAddress(String) - Method in class org.sakaiproject.unboundid.EmailAddressDerivingLdapAttributeMapper

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


A C D E F G I L M N O P R S T U V 
All Classes All Packages