A C D E F G H I L N P R S T U V

A

AccountState - Class in uk.ac.bath.bucs.idm.ldap

Bean to represent account state, and convert to and from the format used to store it in the LDAP.

AccountState() - Constructor for class uk.ac.bath.bucs.idm.ldap.AccountState

Creates a new AccountState instance with the default state of NONE.

AccountState.State - Enum in uk.ac.bath.bucs.idm.ldap

addAlternateAttribute(Map<String, Attribute>, String, List<FlaggableString>) - Static method in class uk.ac.bath.bucs.idm.ldap.AttributeUtils

Adds BasicAttributes for both regular and alternate versions of the specified attribute name to the provided Map, or sets appropriate nulls if null is passed or no data of the given type is supplied.

addAttribute(Map<String, Attribute>, String, String) - Static method in class uk.ac.bath.bucs.idm.ldap.AttributeUtils

Adds a BasicAttribute for the specified attribute name and value to the provided Map, or adds a null if null is passed.

addAttribute(Map<String, Attribute>, String, LocalDate) - Static method in class uk.ac.bath.bucs.idm.ldap.AttributeUtils

Adds a BasicAttribute for the specified attribute name and value to the provided Map, converting the date into a textual format, or adds a null if null is passed.

addAttribute(Map<String, Attribute>, String, Collection<String>) - Static method in class uk.ac.bath.bucs.idm.ldap.AttributeUtils

Adds a BasicAttribute for the specified attribute name and values to the provided Map, or adds a null if null is passed or no values are supplied.

addAttribute(Map<String, Attribute>, String, Map<String, String>, String) - Static method in class uk.ac.bath.bucs.idm.ldap.AttributeUtils

Adds a BasicAttribute for the specified attribute name and values to the provided Map, or adds a null if null is passed or no values are supplied.

addGroupMember(LdapService, String, String) - Static method in class uk.ac.bath.bucs.idm.ldap.LdapUtils

A light-weight method to add a member to a groupOfNames without reading the whole thing in first.

addGroupOwner(LdapService, String, String) - Static method in class uk.ac.bath.bucs.idm.ldap.LdapUtils

A light-weight method to add an owner to a groupOfNames without reading the whole thing in first.

addPosixGroupMember(LdapService, String, String) - Static method in class uk.ac.bath.bucs.idm.ldap.LdapUtils

A light-weight method to add a member to a posixGroup without reading the whole thing in first.

addUniqueAttribute(Map<String, Attribute>, String, Map<String, String>) - Static method in class uk.ac.bath.bucs.idm.ldap.AttributeUtils

Adds a BasicAttribute for the specified attribute name and values to the provided Map, or adds a null if null is passed or no values are supplied.

AdministrativeLock - Class in uk.ac.bath.bucs.idm.ldap

An immutable class to represent values of the administrativeLock LDAP attribute.

AdministrativeLock.Type - Enum in uk.ac.bath.bucs.idm.ldap

An enum type representing the various possible types of AdminstrativeLock value, along with some data about them.

ALTERNATE_ATTRIBUTE_POSTFIX - Static variable in class uk.ac.bath.bucs.idm.ldap.AttributeUtils

The text appended to attribute names to set alternate values - currently ;x-alternate.

AttributeUtils - Class in uk.ac.bath.bucs.idm.ldap

This class contains various static methods for working with LDAP attributes.

C

CacheFailureException - Exception in uk.ac.bath.bucs.idm.ldap

A RuntimeException thrown when an operation making use of a cache fails because the cache cannot be initialised, or could not be updated for an unacceptable period.

CacheFailureException(String, String, Throwable) - Constructor for exception uk.ac.bath.bucs.idm.ldap.CacheFailureException

Creates an instance of CacheFailureException with the supplied message, cache name and cause.

CacheFailureException(String, String, Duration, Throwable) - Constructor for exception uk.ac.bath.bucs.idm.ldap.CacheFailureException

Creates an instance of CacheFailureException with the supplied message, cache name, period of failure and cause.

cacheName - Variable in exception uk.ac.bath.bucs.idm.ldap.CacheFailureException

charAt(int) - Method in class uk.ac.bath.bucs.idm.ldap.FlaggableString

clearAtDate() - Method in enum uk.ac.bath.bucs.idm.ldap.AdministrativeLock.Type

clone() - Method in class uk.ac.bath.bucs.idm.ldap.AccountState

clone() - Method in class uk.ac.bath.bucs.idm.ldap.FlaggableString

clone() - Method in class uk.ac.bath.bucs.idm.ldap.GroupRecord

clone() - Method in class uk.ac.bath.bucs.idm.ldap.PersonRecord

clone() - Method in class uk.ac.bath.bucs.idm.ldap.RoleRecord

clone() - Method in class uk.ac.bath.bucs.idm.ldap.UnitRecord

close() - Method in class uk.ac.bath.bucs.idm.ldap.LdapService

Disposes of any resources and terminates any threads that are held by the instance.

compareTo(FlaggableString) - Method in class uk.ac.bath.bucs.idm.ldap.FlaggableString

Defines a sort order where any non-flagged strings are sorted alphabetically first, followed by any flagged strings sorted in a second alphabetical sequence.

compareTo(GroupRecord) - Method in class uk.ac.bath.bucs.idm.ldap.GroupRecord

compareTo(PersonRecord) - Method in class uk.ac.bath.bucs.idm.ldap.PersonRecord

Defines a sort order based on username, falling back to the first surname and forename values, and then the first common name.

compareTo(RoleRecord) - Method in class uk.ac.bath.bucs.idm.ldap.RoleRecord

compareTo(UnitRecord) - Method in class uk.ac.bath.bucs.idm.ldap.UnitRecord

Defines a sort order based exclusively on name.

connect() - Method in class uk.ac.bath.bucs.idm.ldap.LdapService

Establishes an LDAP connection using the normal credentials, or an anonymous bind if none are configured.

connect(LdapService.ConnectionType) - Method in class uk.ac.bath.bucs.idm.ldap.LdapService

Establishes an LDAP connection using the specified set of credentials.

connectGroup() - Method in class uk.ac.bath.bucs.idm.ldap.LdapService

Establishes an LDAP connection using the group credentials, or an anonymous bind if none are configured.

D

dateRequired() - Method in enum uk.ac.bath.bucs.idm.ldap.AdministrativeLock.Type

deleteEntry(String) - Method in class uk.ac.bath.bucs.idm.ldap.LdapService

Deletes an LDAP entry recursively, using the appropriate set of credentials.

destroy() - Method in enum uk.ac.bath.bucs.idm.ldap.UniStructure

dnsToUids(List<String>) - Static method in class uk.ac.bath.bucs.idm.ldap.LdapUtils

Converts a list of Distinguished Names to a list of uids.

dnToUid(String) - Static method in class uk.ac.bath.bucs.idm.ldap.LdapUtils

Converts a Distinguished Name for a person to the uid for that person.

durationOfFailure - Variable in exception uk.ac.bath.bucs.idm.ldap.CacheFailureException

E

equals(Object) - Method in class uk.ac.bath.bucs.idm.ldap.AccountState

equals(Object) - Method in class uk.ac.bath.bucs.idm.ldap.AdministrativeLock

equals(Object) - Method in class uk.ac.bath.bucs.idm.ldap.FlaggableString

equals(Object) - Method in class uk.ac.bath.bucs.idm.ldap.GroupRecord

equals(Object) - Method in class uk.ac.bath.bucs.idm.ldap.PersonRecord

equals(Object) - Method in class uk.ac.bath.bucs.idm.ldap.RoleRecord

equals(Object) - Method in class uk.ac.bath.bucs.idm.ldap.UnitRecord

extractAlternateAttribute(Attributes, String) - Static method in class uk.ac.bath.bucs.idm.ldap.AttributeUtils

Extracts the values for attributes with the supplied name, and the supplied name with ALTERNATE_ATTRIBUTE_POSTFIX appended, from the supplied Attributes object into a list of FlaggableStrings.

extractDateAttribute(Attributes, String, String) - Static method in class uk.ac.bath.bucs.idm.ldap.AttributeUtils

Extracts the single value for the attribute with the supplied name from the supplied Attributes object and converts it to a LocalDate, or returns null if the attribute isn't set.

extractListAttribute(Attributes, String) - Static method in class uk.ac.bath.bucs.idm.ldap.AttributeUtils

Extracts the values for the attribute with the supplied name from the supplied Attributes object into a List of Strings.

extractMapAttribute(Attributes, String, String, String) - Static method in class uk.ac.bath.bucs.idm.ldap.AttributeUtils

Extracts the values for attribute with the supplied name from the supplied Attributes object into a @{code Map<String, String>}, using the supplied regular expression.

extractSetAttribute(Attributes, String) - Static method in class uk.ac.bath.bucs.idm.ldap.AttributeUtils

Extracts the values for the attribute with the supplied name from the supplied Attributes object into a Set of Strings.

extractSingleValueAttribute(Attributes, String) - Static method in class uk.ac.bath.bucs.idm.ldap.AttributeUtils

Extracts the single value for the attribute with the supplied name from the supplied Attributes object, or null if it isn't set.

F

FlaggableString - Class in uk.ac.bath.bucs.idm.ldap

A string which may be flagged.

FlaggableString(CharSequence) - Constructor for class uk.ac.bath.bucs.idm.ldap.FlaggableString

Creates a new un-flagged instance of FlaggableString.

FlaggableString(CharSequence, boolean) - Constructor for class uk.ac.bath.bucs.idm.ldap.FlaggableString

Creates a new instance of FlaggableString with the specified flag.

fromLdap(Set<String>) - Static method in class uk.ac.bath.bucs.idm.ldap.AccountState

Builds an AccountState instance from data in the format supplied by PersonRecord from the LDAP.

fromPersonRecord(PersonRecord) - Static method in class uk.ac.bath.bucs.idm.ldap.AccountState

Builds an AccountState instance from data contained in a PersonRecord.

G

getAccessControls() - Method in class uk.ac.bath.bucs.idm.ldap.PersonRecord

Gets an immutable view of the map of access controls, which may be empty but will never be null.

getAccessControlsCopy() - Method in class uk.ac.bath.bucs.idm.ldap.PersonRecord

Gets a copy of the map of access controls, which may be empty but will never be null.

getAccountState() - Method in class uk.ac.bath.bucs.idm.ldap.PersonRecord

Gets an immutable view of the account state values, which may be empty but will never be null.

getAdministrativeLock() - Method in class uk.ac.bath.bucs.idm.ldap.PersonRecord

getAlternateUsername() - Method in class uk.ac.bath.bucs.idm.ldap.PersonRecord

getApplicantCategory() - Method in class uk.ac.bath.bucs.idm.ldap.RoleRecord

Gets the value of the applicantCategory attribute.

getApplicantStatus() - Method in class uk.ac.bath.bucs.idm.ldap.RoleRecord

getApplications() - Method in class uk.ac.bath.bucs.idm.ldap.GroupRecord

Gets an immutable view of the map of application data, which may be empty but will never be null.

getApplicationsCopy() - Method in class uk.ac.bath.bucs.idm.ldap.GroupRecord

Gets a copy of the map of application data, which may be empty but will never be null.

getAutogenAdditions() - Method in class uk.ac.bath.bucs.idm.ldap.PersonRecord

Gets an immutable view of the set of additions to autogenerated things, which may be empty but will never be null.

getAutogenExclusions() - Method in class uk.ac.bath.bucs.idm.ldap.PersonRecord

Gets an immutable view of the set of exclusions from autogenerated things, which may be empty but will never be null.

getBuilding() - Method in class uk.ac.bath.bucs.idm.ldap.RoleRecord

getCacheName() - Method in exception uk.ac.bath.bucs.idm.ldap.CacheFailureException

Gets the name of the cache that experienced the failure.

getChildren(String) - Static method in enum uk.ac.bath.bucs.idm.ldap.UniStructure

Returns the direct children of the specified OU.

getCn() - Method in class uk.ac.bath.bucs.idm.ldap.GroupRecord

getComment() - Method in class uk.ac.bath.bucs.idm.ldap.AdministrativeLock

getCommonName() - Method in class uk.ac.bath.bucs.idm.ldap.PersonRecord

Gets an immutable view of the list of common names, which may be empty but will never be null.

getCommonNameVisible() - Method in class uk.ac.bath.bucs.idm.ldap.PersonRecord

Gets only those values of the common name that are not hidden by being flagged x-alternate, in a freshly-created List.

getDate() - Method in class uk.ac.bath.bucs.idm.ldap.AdministrativeLock

getDescendants(String, boolean) - Static method in enum uk.ac.bath.bucs.idm.ldap.UniStructure

Returns all the descendants of the specified OU.

getDescription() - Method in class uk.ac.bath.bucs.idm.ldap.GroupRecord

getDescription() - Method in class uk.ac.bath.bucs.idm.ldap.PersonRecord

getDescription() - Method in class uk.ac.bath.bucs.idm.ldap.RoleRecord

getDescription() - Method in class uk.ac.bath.bucs.idm.ldap.UnitRecord

getDesignation() - Method in class uk.ac.bath.bucs.idm.ldap.PersonRecord

getDisplayName() - Method in class uk.ac.bath.bucs.idm.ldap.PersonRecord

getDistinguishedName() - Method in class uk.ac.bath.bucs.idm.ldap.GroupRecord

getDn() - Method in exception uk.ac.bath.bucs.idm.ldap.LdapDataException

getDurationOfFailure() - Method in exception uk.ac.bath.bucs.idm.ldap.CacheFailureException

Gets the duration over which the failure persisted before the exception was thrown.

getEmployeeType() - Method in class uk.ac.bath.bucs.idm.ldap.PersonRecord

getEndDate() - Method in class uk.ac.bath.bucs.idm.ldap.PersonRecord

getEndDate() - Method in class uk.ac.bath.bucs.idm.ldap.RoleRecord

getExpectedEndDate() - Method in class uk.ac.bath.bucs.idm.ldap.RoleRecord

getExternalDisplayName() - Method in class uk.ac.bath.bucs.idm.ldap.PersonRecord

getExternalMail() - Method in class uk.ac.bath.bucs.idm.ldap.PersonRecord

Gets an immutable view of the set of external mail addresses, which may be empty but will never be null.

getExternalPhone() - Method in class uk.ac.bath.bucs.idm.ldap.PersonRecord

getExternalPhone() - Method in class uk.ac.bath.bucs.idm.ldap.RoleRecord

getExtraMailAliases() - Method in class uk.ac.bath.bucs.idm.ldap.PersonRecord

Gets an immutable view of the list of extra mail aliases, which may be empty but will never be null.

getFacilities() - Method in class uk.ac.bath.bucs.idm.ldap.AccountState

Gets an immutable view of the account's set of facilities, which may be empty but will never be null.

getFacilitiesCopy() - Method in class uk.ac.bath.bucs.idm.ldap.AccountState

Gets a copy of the account's set of facilities, which may be empty but will never be null.

getFaxNumber() - Method in class uk.ac.bath.bucs.idm.ldap.PersonRecord

getFaxNumber() - Method in class uk.ac.bath.bucs.idm.ldap.RoleRecord

getForename() - Method in class uk.ac.bath.bucs.idm.ldap.PersonRecord

Gets an immutable view of the list of forenames, which may be empty but will never be null.

getForenameVisible() - Method in class uk.ac.bath.bucs.idm.ldap.PersonRecord

Gets only the value of forename that is not hidden by being flagged x-alternate.

getGender() - Method in class uk.ac.bath.bucs.idm.ldap.PersonRecord

Gets the value of the gender attribute.

getGidNumber() - Method in class uk.ac.bath.bucs.idm.ldap.GroupRecord

Returns the gidNumber (posixGroups only).

getGraceEndDate() - Method in class uk.ac.bath.bucs.idm.ldap.AccountState

getGroup(String) - Method in class uk.ac.bath.bucs.idm.ldap.LdapService

Gets a GroupRecord from within the ou=groups or ou=unixgroups,ou=config branches of the LDAP.

getGroup(String, String) - Method in class uk.ac.bath.bucs.idm.ldap.LdapService

Gets a GroupRecord from within the specified search base of the LDAP.

getGroupPrincipal() - Method in class uk.ac.bath.bucs.idm.ldap.LdapService

Gets the principal used for group actions.

getGroupsForUser(String, boolean) - Method in class uk.ac.bath.bucs.idm.ldap.LdapService

Gets GroupRecords from the LDAP for all groups containing the specified user.

getHpcPosixGid() - Method in class uk.ac.bath.bucs.idm.ldap.PersonRecord

getHpcPosixHome() - Method in class uk.ac.bath.bucs.idm.ldap.PersonRecord

getId() - Method in class uk.ac.bath.bucs.idm.ldap.RoleRecord

getInitials() - Method in class uk.ac.bath.bucs.idm.ldap.PersonRecord

Gets an immutable view of the list of initial values, which may be empty but will never be null.

getInitialsVisible() - Method in class uk.ac.bath.bucs.idm.ldap.PersonRecord

Gets only the value of initials that is not hidden by being flagged x-alternate.

getInstance(AdministrativeLock.Type, String) - Static method in class uk.ac.bath.bucs.idm.ldap.AdministrativeLock

Static factory for AdministrativeLock instances without dates.

getInstance(AdministrativeLock.Type, LocalDate, String) - Static method in class uk.ac.bath.bucs.idm.ldap.AdministrativeLock

Static factory for AdministrativeLock instances with dates.

getInstance(String, String, String) - Static method in class uk.ac.bath.bucs.idm.ldap.LdapService

Static factory method for LdapServices configured with one set of credentials to use for all operations.

getInstance() - Static method in enum uk.ac.bath.bucs.idm.ldap.UniStructure

Gets a reference to the underlying singleton instance.

getInstanceAnon(String) - Static method in class uk.ac.bath.bucs.idm.ldap.LdapService

Static factory method for unauthenticated LdapServices.

getInstanceExplicitlyConfigured(String, String, String, String, String, String, String, int, int) - Static method in class uk.ac.bath.bucs.idm.ldap.LdapService

Static factory method for LdapServices configured with one set of credentials for general operations, a separate set for group operations, and a third set for config operations (e.g.

getInstanceGroup(String, String, String, String, String) - Static method in class uk.ac.bath.bucs.idm.ldap.LdapService

Static factory method for LdapServices configured with one set of credentials for general operations and a separate set for group operations.

getInstanceGroupConfig(String, String, String, String, String, String, String) - Static method in class uk.ac.bath.bucs.idm.ldap.LdapService

Static factory method for LdapServices configured with one set of credentials for general operations, a separate set for group operations, and a third set for config operations (e.g.

getJobFamily() - Method in class uk.ac.bath.bucs.idm.ldap.RoleRecord

getKnownAs() - Method in class uk.ac.bath.bucs.idm.ldap.PersonRecord

Gets an immutable view of the list of knownAs values, which may be empty but will never be null.

getKnownAsVisible() - Method in class uk.ac.bath.bucs.idm.ldap.PersonRecord

Gets only the value of knownAs that is not hidden by being flagged x-alternate.

getLabeledURI() - Method in class uk.ac.bath.bucs.idm.ldap.PersonRecord

getLabeledUri() - Method in class uk.ac.bath.bucs.idm.ldap.RoleRecord

getLabeledURI() - Method in class uk.ac.bath.bucs.idm.ldap.UnitRecord

getLeftDate() - Method in class uk.ac.bath.bucs.idm.ldap.PersonRecord

getLeftDate() - Method in class uk.ac.bath.bucs.idm.ldap.RoleRecord

getLibraryCardNumber() - Method in class uk.ac.bath.bucs.idm.ldap.PersonRecord

getListedPeople(boolean, boolean, boolean, boolean) - Method in class uk.ac.bath.bucs.idm.ldap.LdapService

Returns a list of all the person entries of the specified type(s) currently present in ou=people in the LDAP.

getListedPersonRecords(boolean, boolean, boolean, boolean) - Method in class uk.ac.bath.bucs.idm.ldap.LdapService

Returns a list of PersonRecords for all the person entries of the specified type(s) currently present in ou=people in the LDAP.

getLocation() - Method in class uk.ac.bath.bucs.idm.ldap.PersonRecord

getLocation() - Method in class uk.ac.bath.bucs.idm.ldap.RoleRecord

getMail() - Method in class uk.ac.bath.bucs.idm.ldap.PersonRecord

getMailAll() - Method in class uk.ac.bath.bucs.idm.ldap.PersonRecord

Gets an immutable view of the set of all routed email addresses, which may be empty but will never be null.

getMailRouting() - Method in class uk.ac.bath.bucs.idm.ldap.PersonRecord

getMaintainers() - Method in class uk.ac.bath.bucs.idm.ldap.UnitRecord

Gets an immutable view of the list of maintainers for whom permissions recurse down the hierarchy.

getMaintainersNoRecurse() - Method in class uk.ac.bath.bucs.idm.ldap.UnitRecord

Gets an immutable view of the list of maintainers for whom permissions DO NOT recurse down the hierarchy.

getManagerUsername() - Method in class uk.ac.bath.bucs.idm.ldap.PersonRecord

Gets the username of the manager.

getMaxPageSize() - Method in class uk.ac.bath.bucs.idm.ldap.LdapService

Gets the maximum page size that will be used for Virtual List View queries.

getMaxRetries() - Method in class uk.ac.bath.bucs.idm.ldap.LdapService

Gets the maximum number of retries that will be attempted for a given operation.

getMemberDNs() - Method in class uk.ac.bath.bucs.idm.ldap.GroupRecord

Gets an immutable view of the set of member distinguished names, which may be empty but will never be null.

getMemberDNsCopy() - Method in class uk.ac.bath.bucs.idm.ldap.GroupRecord

Gets a copy of the set of member distinguished names, which may be empty but will never be null.

getMembers() - Method in class uk.ac.bath.bucs.idm.ldap.GroupRecord

Gets a mutable copy of the set of member usernames, which may be empty but will never be null.

getMiddleInitials() - Method in class uk.ac.bath.bucs.idm.ldap.PersonRecord

Gets an immutable view of the list of middle initial values, which may be empty but will never be null.

getMiddleInitialsVisible() - Method in class uk.ac.bath.bucs.idm.ldap.PersonRecord

Gets only the value of middle initials that is not hidden by being flagged x-alternate.

getMobileNumber() - Method in class uk.ac.bath.bucs.idm.ldap.PersonRecord

getMobileNumber() - Method in class uk.ac.bath.bucs.idm.ldap.RoleRecord

getName() - Method in class uk.ac.bath.bucs.idm.ldap.UnitRecord

getNameFromCode(String) - Static method in enum uk.ac.bath.bucs.idm.ldap.UniStructure

Returns the full name of an OU, given the shortou code.

getOnlyState(List<FlaggableString>, boolean) - Static method in class uk.ac.bath.bucs.idm.ldap.FlaggableString

Extracts only those FlaggableStrings from a list of FlaggableStrings which are in the specified flag state.

getOrganisation() - Method in class uk.ac.bath.bucs.idm.ldap.PersonRecord

getOu() - Method in class uk.ac.bath.bucs.idm.ldap.PersonRecord

getOu() - Method in class uk.ac.bath.bucs.idm.ldap.RoleRecord

getOwnCloudQuota() - Method in class uk.ac.bath.bucs.idm.ldap.PersonRecord

Gets the value of the ownCloudQuota attribute in megabytes.

getOwnerDNs() - Method in class uk.ac.bath.bucs.idm.ldap.GroupRecord

Gets an immutable view of the set of owner distinguished names, which may be empty but will never be null.

getOwnerDNsCopy() - Method in class uk.ac.bath.bucs.idm.ldap.GroupRecord

Gets a copy of the set of owner distinguished names, which may be empty but will never be null.

getOwners() - Method in class uk.ac.bath.bucs.idm.ldap.GroupRecord

Gets a mutable copy of the set of owner usernames, which may be empty but will never be null.

getParent(String) - Static method in enum uk.ac.bath.bucs.idm.ldap.UniStructure

Looks up the code for the parent of the supplied shortou code.

getParentOu() - Method in class uk.ac.bath.bucs.idm.ldap.UnitRecord

getPartTime() - Method in class uk.ac.bath.bucs.idm.ldap.RoleRecord

getPayrollNo() - Method in class uk.ac.bath.bucs.idm.ldap.PersonRecord

Gets an immutable view of the list of payroll numbers, which may be empty but will never be null.

getPeriod() - Method in class uk.ac.bath.bucs.idm.ldap.RoleRecord

getPerson(String) - Method in class uk.ac.bath.bucs.idm.ldap.LdapService

Gets a PersonRecord (with nested RoleRecords as appropriate) from the LDAP.

getPersonId() - Method in class uk.ac.bath.bucs.idm.ldap.PersonRecord

getPersonLinks() - Method in class uk.ac.bath.bucs.idm.ldap.PersonRecord

Gets an immutable view of the list of personLinks, which may be empty but will never be null.

getPersonLinks() - Method in class uk.ac.bath.bucs.idm.ldap.RoleRecord

Gets an immutable view of the list of personLinks, which may be empty but will never be null.

getPhoneNumber() - Method in class uk.ac.bath.bucs.idm.ldap.PersonRecord

getPhoneNumber() - Method in class uk.ac.bath.bucs.idm.ldap.RoleRecord

getPosixGecos() - Method in class uk.ac.bath.bucs.idm.ldap.PersonRecord

getPosixGid() - Method in class uk.ac.bath.bucs.idm.ldap.PersonRecord

getPosixHome() - Method in class uk.ac.bath.bucs.idm.ldap.PersonRecord

getPosixShell() - Method in class uk.ac.bath.bucs.idm.ldap.PersonRecord

getPosixUid() - Method in class uk.ac.bath.bucs.idm.ldap.PersonRecord

getPrincipal() - Method in class uk.ac.bath.bucs.idm.ldap.LdapService

Gets the principal used for all actions unless groupPrincipal is set.

getProgCode() - Method in class uk.ac.bath.bucs.idm.ldap.RoleRecord

getRecordType() - Method in class uk.ac.bath.bucs.idm.ldap.GroupRecord

getRecordType() - Method in class uk.ac.bath.bucs.idm.ldap.PersonRecord

Gets a single-valued record type.

getRecordType() - Method in class uk.ac.bath.bucs.idm.ldap.RoleRecord

getRecordTypes() - Method in class uk.ac.bath.bucs.idm.ldap.PersonRecord

Gets an immutable view of the set of record types, which may be empty but will never be null.

getRemoveDate() - Method in class uk.ac.bath.bucs.idm.ldap.RoleRecord

getRole(String) - Method in class uk.ac.bath.bucs.idm.ldap.LdapService

Gets a RoleRecord from the LDAP.

getRole(int) - Method in class uk.ac.bath.bucs.idm.ldap.PersonRecord

Gets a reference to the specified role held within the object.

getRoleCategory() - Method in class uk.ac.bath.bucs.idm.ldap.RoleRecord

getRoleNumber() - Method in class uk.ac.bath.bucs.idm.ldap.RoleRecord

getRoleOccupant() - Method in class uk.ac.bath.bucs.idm.ldap.RoleRecord

getRoles() - Method in class uk.ac.bath.bucs.idm.ldap.PersonRecord

Gets an immutable view of the list of roles, which may be empty but will never be null.

getRoleTitle() - Method in class uk.ac.bath.bucs.idm.ldap.RoleRecord

getRoleType() - Method in class uk.ac.bath.bucs.idm.ldap.RoleRecord

getRoom() - Method in class uk.ac.bath.bucs.idm.ldap.RoleRecord

getRoomNumber() - Method in class uk.ac.bath.bucs.idm.ldap.PersonRecord

getRoomNumber() - Method in class uk.ac.bath.bucs.idm.ldap.RoleRecord

getShortName() - Method in class uk.ac.bath.bucs.idm.ldap.UnitRecord

getShortOu() - Method in class uk.ac.bath.bucs.idm.ldap.PersonRecord

getShortOu() - Method in class uk.ac.bath.bucs.idm.ldap.RoleRecord

getShortOu() - Method in class uk.ac.bath.bucs.idm.ldap.UnitRecord

getShortOuSet() - Method in class uk.ac.bath.bucs.idm.ldap.RoleRecord

Gets an immutable view of the set of shortOus, which may be empty but will never be null.

getState() - Method in class uk.ac.bath.bucs.idm.ldap.AccountState

getSupportOuOverride() - Method in class uk.ac.bath.bucs.idm.ldap.PersonRecord

getSurname() - Method in class uk.ac.bath.bucs.idm.ldap.PersonRecord

Gets an immutable view of the list of surnames, which may be empty but will never be null.

getSurnameVisible() - Method in class uk.ac.bath.bucs.idm.ldap.PersonRecord

Gets only the value of surname that is not hidden by being flagged x-alternate.

getTitle() - Method in class uk.ac.bath.bucs.idm.ldap.PersonRecord

getType() - Method in class uk.ac.bath.bucs.idm.ldap.AdministrativeLock

getUnit(String) - Method in class uk.ac.bath.bucs.idm.ldap.LdapService

Gets a UnitRecord from the LDAP.

getUrl() - Method in class uk.ac.bath.bucs.idm.ldap.LdapService

getUsername() - Method in class uk.ac.bath.bucs.idm.ldap.PersonRecord

getVeryShortOu() - Method in class uk.ac.bath.bucs.idm.ldap.UnitRecord

GroupRecord - Class in uk.ac.bath.bucs.idm.ldap

Bean class to represent all of the information about a single LDAP group (either groupOfNames or posixGroup), sortable by cn.

GroupRecord() - Constructor for class uk.ac.bath.bucs.idm.ldap.GroupRecord

GroupRecord.Type - Enum in uk.ac.bath.bucs.idm.ldap

Types of record, corresponding to LDAP objectClasses.

H

handle(SearchResult, LdapService) - Method in interface uk.ac.bath.bucs.idm.ldap.ResultHandler

Handles a single result from an LDAP search.

hasDate() - Method in enum uk.ac.bath.bucs.idm.ldap.AdministrativeLock.Type

hashCode() - Method in class uk.ac.bath.bucs.idm.ldap.AccountState

hashCode() - Method in class uk.ac.bath.bucs.idm.ldap.AdministrativeLock

hashCode() - Method in class uk.ac.bath.bucs.idm.ldap.FlaggableString

hashCode() - Method in class uk.ac.bath.bucs.idm.ldap.GroupRecord

hashCode() - Method in class uk.ac.bath.bucs.idm.ldap.PersonRecord

hashCode() - Method in class uk.ac.bath.bucs.idm.ldap.RoleRecord

hashCode() - Method in class uk.ac.bath.bucs.idm.ldap.UnitRecord

hasSameBitsAs(AccountState) - Method in class uk.ac.bath.bucs.idm.ldap.AccountState

Returns true if the supplied state has the same account components as this state.

I

isAccountNotIssued() - Method in class uk.ac.bath.bucs.idm.ldap.PersonRecord

Gets the value of the accountNotIssued attribute.

isActive() - Method in class uk.ac.bath.bucs.idm.ldap.RoleRecord

isApplicant() - Method in class uk.ac.bath.bucs.idm.ldap.AccountState

isApplicant() - Method in class uk.ac.bath.bucs.idm.ldap.PersonRecord

isApplicantClosed() - Method in class uk.ac.bath.bucs.idm.ldap.AccountState

isApplicantGrace() - Method in class uk.ac.bath.bucs.idm.ldap.AccountState

isApplicantGraceWithResidue() - Method in class uk.ac.bath.bucs.idm.ldap.AccountState

isApplicantWithResidue() - Method in class uk.ac.bath.bucs.idm.ldap.AccountState

isBathPerson() - Method in class uk.ac.bath.bucs.idm.ldap.PersonRecord

isChildOf(String, String) - Static method in enum uk.ac.bath.bucs.idm.ldap.UniStructure

Returns true if ou1 is equal to ou2 or a child of it.

isClosed() - Method in class uk.ac.bath.bucs.idm.ldap.AccountState

isExDirectory() - Method in class uk.ac.bath.bucs.idm.ldap.PersonRecord

isExDirectory() - Method in class uk.ac.bath.bucs.idm.ldap.RoleRecord

isExDirectory() - Method in class uk.ac.bath.bucs.idm.ldap.UnitRecord

isExternal() - Method in class uk.ac.bath.bucs.idm.ldap.AccountState

isExternalClosed() - Method in class uk.ac.bath.bucs.idm.ldap.AccountState

isExternalPerson() - Method in class uk.ac.bath.bucs.idm.ldap.PersonRecord

isFlagged() - Method in class uk.ac.bath.bucs.idm.ldap.FlaggableString

Determines whether the string is flagged.

isFull() - Method in class uk.ac.bath.bucs.idm.ldap.AccountState

isGrace() - Method in class uk.ac.bath.bucs.idm.ldap.AccountState

isGraceToApplicant() - Method in class uk.ac.bath.bucs.idm.ldap.AccountState

isGroupMember(LdapService, String, String) - Static method in class uk.ac.bath.bucs.idm.ldap.LdapUtils

Tests to see if a particular user is a member of a particular LDAP groupOfNames.

isGroupOwner(LdapService, String, String) - Static method in class uk.ac.bath.bucs.idm.ldap.LdapUtils

Tests to see if a particular user is an owner of a particular LDAP groupOfNames.

isLocked() - Method in class uk.ac.bath.bucs.idm.ldap.AccountState

isMembershipHidden() - Method in class uk.ac.bath.bucs.idm.ldap.GroupRecord

isMembersOmitted() - Method in class uk.ac.bath.bucs.idm.ldap.GroupRecord

isNone() - Method in class uk.ac.bath.bucs.idm.ldap.AccountState

isNonPayroll() - Method in class uk.ac.bath.bucs.idm.ldap.AccountState

isNonPerson() - Method in class uk.ac.bath.bucs.idm.ldap.PersonRecord

isNotRegistered() - Method in class uk.ac.bath.bucs.idm.ldap.AccountState

isStaffGrace() - Method in class uk.ac.bath.bucs.idm.ldap.AccountState

isStaffGraceToApplicant() - Method in class uk.ac.bath.bucs.idm.ldap.AccountState

isTemp() - Method in class uk.ac.bath.bucs.idm.ldap.AccountState

isWeb() - Method in class uk.ac.bath.bucs.idm.ldap.AccountState

L

LdapDataException - Exception in uk.ac.bath.bucs.idm.ldap

Exception class to represent errors with LDAP data.

LdapDataException(String) - Constructor for exception uk.ac.bath.bucs.idm.ldap.LdapDataException

Creates a new instance of LdapDataException with the specified detail message.

LdapDataException(String, Throwable) - Constructor for exception uk.ac.bath.bucs.idm.ldap.LdapDataException

Creates a new instance of LdapDataException with the specified detail message and cause.

LdapDataException(String, String) - Constructor for exception uk.ac.bath.bucs.idm.ldap.LdapDataException

Creates a new instance of LdapDataException with the specified detail message and DN.

LdapDataException(String, String, Throwable) - Constructor for exception uk.ac.bath.bucs.idm.ldap.LdapDataException

Creates a new instance of LdapDataException with the specified detail message, DN and cause.

LdapService - Class in uk.ac.bath.bucs.idm.ldap

Class to read from and write to the LDAP server, the data being encapsulated in the various bean classes: PersonRecord, RoleRecord, UnitRecord and GroupRecord.

LdapService.ConnectionType - Enum in uk.ac.bath.bucs.idm.ldap

LdapUtils - Class in uk.ac.bath.bucs.idm.ldap

Class containing static methods to assist with use of the Bath LDAP.

length() - Method in class uk.ac.bath.bucs.idm.ldap.FlaggableString

N

NotFoundException - Exception in uk.ac.bath.bucs.idm.ldap

NotFoundException(String) - Constructor for exception uk.ac.bath.bucs.idm.ldap.NotFoundException

Creates a new instance of NotFoundException.

P

ParallelResultHandler<T> - Interface in uk.ac.bath.bucs.idm.ldap

Extends the ResultHandler interface to allow parallel-processing of results.

personIdToUid(LdapService, int) - Static method in class uk.ac.bath.bucs.idm.ldap.LdapUtils

Converts a PersonId to a uid by querying the LDAP.

PersonRecord - Class in uk.ac.bath.bucs.idm.ldap

Bean class to represent all of the information about a single person/account in the LDAP, with a little help from RoleRecord.

PersonRecord() - Constructor for class uk.ac.bath.bucs.idm.ldap.PersonRecord

PersonRecord.Gender - Enum in uk.ac.bath.bucs.idm.ldap

Genders

PersonRecord.Type - Enum in uk.ac.bath.bucs.idm.ldap

Types of record, corresponding to LDAP objectClasses

processExternalPhones(String) - Static method in class uk.ac.bath.bucs.idm.ldap.LdapUtils

Turns the String stored in any of the phone number-related properties of beans into a List of numbers suitable for external display.

processInternalPhones(String) - Static method in class uk.ac.bath.bucs.idm.ldap.LdapUtils

Turns the String stored in any of the phone number-related properties of beans into a List of numbers suitable for internal display.

R

refresh() - Static method in enum uk.ac.bath.bucs.idm.ldap.UniStructure

Causes UniStructure to re-cache its data from the LDAP.

removeGroupMember(LdapService, String, String) - Static method in class uk.ac.bath.bucs.idm.ldap.LdapUtils

A light-weight method to remove a member from a groupOfNames without reading the whole thing in first.

removeGroupOwner(LdapService, String, String) - Static method in class uk.ac.bath.bucs.idm.ldap.LdapUtils

A light-weight method to remove an owner from a groupOfNames without reading the whole thing in first.

removePosixGroupMember(LdapService, String, String) - Static method in class uk.ac.bath.bucs.idm.ldap.LdapUtils

A light-weight method to remove a member from a posixGroup without reading the whole thing in first.

ResultHandler<T> - Interface in uk.ac.bath.bucs.idm.ldap

Instances of classes that implement this interface are used to handle results during LDAP searches.

ResultHandlerException - Exception in uk.ac.bath.bucs.idm.ldap

Exception type to be thrown by ResultHandler implementations.

ResultHandlerException(String, Throwable) - Constructor for exception uk.ac.bath.bucs.idm.ldap.ResultHandlerException

Constructs an instance of ResultHandlerException with the specified detail message and cause.

RoleRecord - Class in uk.ac.bath.bucs.idm.ldap

Bean class to represent all of the information about a single LDAP role, sortable by role number.

Note: this class has a natural ordering that is inconsistent with equals.

RoleRecord() - Constructor for class uk.ac.bath.bucs.idm.ldap.RoleRecord

RoleRecord.Type - Enum in uk.ac.bath.bucs.idm.ldap

Types of record, corresponding to LDAP objectClasses

S

search(String, String, int, ResultHandler<T>, String[], String[]) - Method in class uk.ac.bath.bucs.idm.ldap.LdapService

Searches using the general credentials in the named context for entries that match the filter and invokes the supplied ResultHandler instance on each in turn - or on several at once if it is a ParallelResultHandler instance.

search(String, String, int, ResultHandler<T>, String[], String[], boolean) - Method in class uk.ac.bath.bucs.idm.ldap.LdapService

Searches using the specified credentials in the named context for entries that match the filter and invokes the supplied ResultHandler instance on each in turn - or on several at once if it is a ParallelResultHandler instance.

searchGroupRecords(LdapService, String, int) - Static method in class uk.ac.bath.bucs.idm.ldap.LdapUtils

Searches for groups (groupOfNames or posixGroup) using the supplied filter and search scope, and returns a fully-fledged GroupRecord object for each one found.

searchGroupRecords(LdapService, String) - Static method in class uk.ac.bath.bucs.idm.ldap.LdapUtils

Searches for groups (groupOfNames or posixGroup) using the supplied filter, and returns a fully-fledged GroupRecord object for each one found.

searchPersonRecords(LdapService, String) - Static method in class uk.ac.bath.bucs.idm.ldap.LdapUtils

Searches for people using the supplied filter, and returns a fully-fledged PersonRecord object for each one found.

searchRoleRecords(LdapService, String) - Static method in class uk.ac.bath.bucs.idm.ldap.LdapUtils

Searches for roles using the supplied filter and returns a RoleRecord object, along with the fully-fledged PersonRecord object containing it, for each one found.

searchSmall(String, String, int, ResultHandler<T>, String[]) - Method in class uk.ac.bath.bucs.idm.ldap.LdapService

Searches using the general credentials in the named context for entries that match the filter and invokes the supplied ResultHandler instance on each in turn - or on several at once if it is a ParallelResultHandler instance.

searchSmall(String, String, int, ResultHandler<T>, String[], boolean) - Method in class uk.ac.bath.bucs.idm.ldap.LdapService

Searches using the specified credentials in the named context for entries that match the filter and invokes the supplied ResultHandler instance on each in turn - or on several at once if it is a ParallelResultHandler instance.

searchUnitRecords(LdapService, String) - Static method in class uk.ac.bath.bucs.idm.ldap.LdapUtils

Searches for units using the supplied filter, and returns a fully-fledged UnitRecord object for each one found.

setAccessControls(Map<String, String>) - Method in class uk.ac.bath.bucs.idm.ldap.PersonRecord

Sets the map of access control key-value pairs.

setAccountNotIssued(boolean) - Method in class uk.ac.bath.bucs.idm.ldap.PersonRecord

setAccountState(Set<String>) - Method in class uk.ac.bath.bucs.idm.ldap.PersonRecord

Sets the account state.

setAdministrativeLock(AdministrativeLock) - Method in class uk.ac.bath.bucs.idm.ldap.PersonRecord

setAlternateUsername(String) - Method in class uk.ac.bath.bucs.idm.ldap.PersonRecord

setApplicantCategory(String) - Method in class uk.ac.bath.bucs.idm.ldap.RoleRecord

setApplicantStatus(String) - Method in class uk.ac.bath.bucs.idm.ldap.RoleRecord

setApplications(Map<String, String>) - Method in class uk.ac.bath.bucs.idm.ldap.GroupRecord

Sets the Map of application data key-value pairs.

setAutogenAdditions(Set<String>) - Method in class uk.ac.bath.bucs.idm.ldap.PersonRecord

Sets the set of additions to autogenerated things.

setAutogenExclusions(Set<String>) - Method in class uk.ac.bath.bucs.idm.ldap.PersonRecord

Sets the set of exclusions from autogenerated things.

setBuilding(String) - Method in class uk.ac.bath.bucs.idm.ldap.RoleRecord

setCn(String) - Method in class uk.ac.bath.bucs.idm.ldap.GroupRecord

setCommonName(List<FlaggableString>) - Method in class uk.ac.bath.bucs.idm.ldap.PersonRecord

Sets the list of common names.

setDescription(String) - Method in class uk.ac.bath.bucs.idm.ldap.GroupRecord

setDescription(String) - Method in class uk.ac.bath.bucs.idm.ldap.PersonRecord

setDescription(String) - Method in class uk.ac.bath.bucs.idm.ldap.RoleRecord

setDescription(String) - Method in class uk.ac.bath.bucs.idm.ldap.UnitRecord

setDesignation(String) - Method in class uk.ac.bath.bucs.idm.ldap.PersonRecord

setDisplayName(String) - Method in class uk.ac.bath.bucs.idm.ldap.PersonRecord

setDistinguishedName(String) - Method in class uk.ac.bath.bucs.idm.ldap.GroupRecord

setEmployeeType(String) - Method in class uk.ac.bath.bucs.idm.ldap.PersonRecord

setEndDate(LocalDate) - Method in class uk.ac.bath.bucs.idm.ldap.PersonRecord

setEndDate(LocalDate) - Method in class uk.ac.bath.bucs.idm.ldap.RoleRecord

setExDirectory(boolean) - Method in class uk.ac.bath.bucs.idm.ldap.PersonRecord

setExDirectory(boolean) - Method in class uk.ac.bath.bucs.idm.ldap.RoleRecord

setExDirectory(boolean) - Method in class uk.ac.bath.bucs.idm.ldap.UnitRecord

setExpectedEndDate(LocalDate) - Method in class uk.ac.bath.bucs.idm.ldap.RoleRecord

setExternalDisplayName(String) - Method in class uk.ac.bath.bucs.idm.ldap.PersonRecord

setExternalMail(Set<String>) - Method in class uk.ac.bath.bucs.idm.ldap.PersonRecord

Sets the set of external email addresses.

setExternalPhone(String) - Method in class uk.ac.bath.bucs.idm.ldap.PersonRecord

setExternalPhone(String) - Method in class uk.ac.bath.bucs.idm.ldap.RoleRecord

setExtraMailAliases(List<String>) - Method in class uk.ac.bath.bucs.idm.ldap.PersonRecord

Sets the list of extra mail aliases.

setFacilities(Set<String>) - Method in class uk.ac.bath.bucs.idm.ldap.AccountState

Sets the set of facility strings.

setFacilities(String) - Method in class uk.ac.bath.bucs.idm.ldap.AccountState

Sets the set of facility strings by splitting a single string on the tilde character '~'.

setFaxNumber(String) - Method in class uk.ac.bath.bucs.idm.ldap.PersonRecord

setFaxNumber(String) - Method in class uk.ac.bath.bucs.idm.ldap.RoleRecord

setFlagged(boolean) - Method in class uk.ac.bath.bucs.idm.ldap.FlaggableString

Sets the flag state of the string.

setForename(List<FlaggableString>) - Method in class uk.ac.bath.bucs.idm.ldap.PersonRecord

Sets the list of forenames.

setGender(PersonRecord.Gender) - Method in class uk.ac.bath.bucs.idm.ldap.PersonRecord

setGidNumber(int) - Method in class uk.ac.bath.bucs.idm.ldap.GroupRecord

Sets the gidNumber (posixGroups only).

setGraceEndDate(LocalDate) - Method in class uk.ac.bath.bucs.idm.ldap.AccountState

Sets the grace end date, the day the account is expected to close.

setGroup(GroupRecord, boolean) - Method in class uk.ac.bath.bucs.idm.ldap.LdapService

Sets the state of a group in the LDAP from a GroupRecord.

setHpcPosixGid(Integer) - Method in class uk.ac.bath.bucs.idm.ldap.PersonRecord

setHpcPosixHome(String) - Method in class uk.ac.bath.bucs.idm.ldap.PersonRecord

setId(String) - Method in class uk.ac.bath.bucs.idm.ldap.RoleRecord

setInitials(List<FlaggableString>) - Method in class uk.ac.bath.bucs.idm.ldap.PersonRecord

Sets the list of initial values.

setJobFamily(String) - Method in class uk.ac.bath.bucs.idm.ldap.RoleRecord

setKnownAs(List<FlaggableString>) - Method in class uk.ac.bath.bucs.idm.ldap.PersonRecord

Sets the list of knownAs values.

setLabeledURI(String) - Method in class uk.ac.bath.bucs.idm.ldap.PersonRecord

setLabeledUri(String) - Method in class uk.ac.bath.bucs.idm.ldap.RoleRecord

setLabeledURI(String) - Method in class uk.ac.bath.bucs.idm.ldap.UnitRecord

setLeftDate(LocalDate) - Method in class uk.ac.bath.bucs.idm.ldap.PersonRecord

setLeftDate(LocalDate) - Method in class uk.ac.bath.bucs.idm.ldap.RoleRecord

setLibraryCardNumber(String) - Method in class uk.ac.bath.bucs.idm.ldap.PersonRecord

setLocation(String) - Method in class uk.ac.bath.bucs.idm.ldap.PersonRecord

setLocation(String) - Method in class uk.ac.bath.bucs.idm.ldap.RoleRecord

setLocked(boolean) - Method in class uk.ac.bath.bucs.idm.ldap.AccountState

setMail(String) - Method in class uk.ac.bath.bucs.idm.ldap.PersonRecord

setMailAll(Collection<String>) - Method in class uk.ac.bath.bucs.idm.ldap.PersonRecord

Sets the list of all routed email addresses.

setMailRouting(Set<String>) - Method in class uk.ac.bath.bucs.idm.ldap.PersonRecord

setMaintainers(List<String>) - Method in class uk.ac.bath.bucs.idm.ldap.UnitRecord

Sets the list of maintainers for whom permissions recurse down the hierarchy.

setMaintainersNoRecurse(List<String>) - Method in class uk.ac.bath.bucs.idm.ldap.UnitRecord

Sets the list of maintainers for whom permissions DO NOT recurse down the hierarchy.

setManagerUsername(String) - Method in class uk.ac.bath.bucs.idm.ldap.PersonRecord

Sets the username of the manager.

setMemberDNs(Set<String>) - Method in class uk.ac.bath.bucs.idm.ldap.GroupRecord

Sets the set of member distinguished names.

setMembers(Set<String>) - Method in class uk.ac.bath.bucs.idm.ldap.GroupRecord

Sets the set of members from usernames.

setMembershipHidden(boolean) - Method in class uk.ac.bath.bucs.idm.ldap.GroupRecord

setMembersOmitted(boolean) - Method in class uk.ac.bath.bucs.idm.ldap.GroupRecord

setMiddleInitials(List<FlaggableString>) - Method in class uk.ac.bath.bucs.idm.ldap.PersonRecord

Sets the list of middle initial values.

setMobileNumber(String) - Method in class uk.ac.bath.bucs.idm.ldap.PersonRecord

setMobileNumber(String) - Method in class uk.ac.bath.bucs.idm.ldap.RoleRecord

setName(String) - Method in class uk.ac.bath.bucs.idm.ldap.UnitRecord

setNonPayroll(boolean) - Method in class uk.ac.bath.bucs.idm.ldap.AccountState

setNotRegistered(boolean) - Method in class uk.ac.bath.bucs.idm.ldap.AccountState

setOrganisation(String) - Method in class uk.ac.bath.bucs.idm.ldap.PersonRecord

setOu(String) - Method in class uk.ac.bath.bucs.idm.ldap.PersonRecord

setOu(String) - Method in class uk.ac.bath.bucs.idm.ldap.RoleRecord

setOwnCloudQuota(int) - Method in class uk.ac.bath.bucs.idm.ldap.PersonRecord

Sets the value of the ownCloudQuota attribute, in megabytes.

setOwnerDNs(Set<String>) - Method in class uk.ac.bath.bucs.idm.ldap.GroupRecord

Sets the set of owner distinguished names.

setOwners(Set<String>) - Method in class uk.ac.bath.bucs.idm.ldap.GroupRecord

Sets the set of owners from usernames.

setParentOu(String) - Method in class uk.ac.bath.bucs.idm.ldap.UnitRecord

setPartTime(String) - Method in class uk.ac.bath.bucs.idm.ldap.RoleRecord

setPayrollNo(List<String>) - Method in class uk.ac.bath.bucs.idm.ldap.PersonRecord

Sets the list of payroll numbers.

setPeriod(Integer) - Method in class uk.ac.bath.bucs.idm.ldap.RoleRecord

setPerson(PersonRecord) - Method in class uk.ac.bath.bucs.idm.ldap.LdapService

Sets the state of a person in the LDAP from a PersonRecord and any nested RoleRecords.

setPersonId(Integer) - Method in class uk.ac.bath.bucs.idm.ldap.PersonRecord

setPersonLinks(List<String>) - Method in class uk.ac.bath.bucs.idm.ldap.PersonRecord

Sets the list of personLinks.

setPersonLinks(List<String>) - Method in class uk.ac.bath.bucs.idm.ldap.RoleRecord

Sets the list of personLinks.

setPhoneNumber(String) - Method in class uk.ac.bath.bucs.idm.ldap.PersonRecord

setPhoneNumber(String) - Method in class uk.ac.bath.bucs.idm.ldap.RoleRecord

setPosixGecos(String) - Method in class uk.ac.bath.bucs.idm.ldap.PersonRecord

setPosixGid(Integer) - Method in class uk.ac.bath.bucs.idm.ldap.PersonRecord

setPosixHome(String) - Method in class uk.ac.bath.bucs.idm.ldap.PersonRecord

setPosixShell(String) - Method in class uk.ac.bath.bucs.idm.ldap.PersonRecord

setPosixUid(Integer) - Method in class uk.ac.bath.bucs.idm.ldap.PersonRecord

setProgCode(String) - Method in class uk.ac.bath.bucs.idm.ldap.RoleRecord

setRecordType(GroupRecord.Type) - Method in class uk.ac.bath.bucs.idm.ldap.GroupRecord

setRecordType(PersonRecord.Type) - Method in class uk.ac.bath.bucs.idm.ldap.PersonRecord

Sets a single record type, replacing all existing values.

setRecordType(RoleRecord.Type) - Method in class uk.ac.bath.bucs.idm.ldap.RoleRecord

setRecordTypes(Set<PersonRecord.Type>) - Method in class uk.ac.bath.bucs.idm.ldap.PersonRecord

Sets the set of record types.

setRemoveDate(LocalDate) - Method in class uk.ac.bath.bucs.idm.ldap.RoleRecord

setRole(int, RoleRecord) - Method in class uk.ac.bath.bucs.idm.ldap.PersonRecord

Sets the specified role held within the object.

setRoleCategory(String) - Method in class uk.ac.bath.bucs.idm.ldap.RoleRecord

setRoleNumber(Integer) - Method in class uk.ac.bath.bucs.idm.ldap.RoleRecord

setRoleOccupant(String) - Method in class uk.ac.bath.bucs.idm.ldap.RoleRecord

setRoles(List<RoleRecord>) - Method in class uk.ac.bath.bucs.idm.ldap.PersonRecord

Sets the list of role.

setRoleTitle(String) - Method in class uk.ac.bath.bucs.idm.ldap.RoleRecord

setRoleType(String) - Method in class uk.ac.bath.bucs.idm.ldap.RoleRecord

setRoom(String) - Method in class uk.ac.bath.bucs.idm.ldap.RoleRecord

setRoomNumber(String) - Method in class uk.ac.bath.bucs.idm.ldap.PersonRecord

setRoomNumber(String) - Method in class uk.ac.bath.bucs.idm.ldap.RoleRecord

setShortName(String) - Method in class uk.ac.bath.bucs.idm.ldap.UnitRecord

setShortOu(String) - Method in class uk.ac.bath.bucs.idm.ldap.PersonRecord

setShortOu(String) - Method in class uk.ac.bath.bucs.idm.ldap.RoleRecord

setShortOu(String) - Method in class uk.ac.bath.bucs.idm.ldap.UnitRecord

setShortOuSet(List<String>) - Method in class uk.ac.bath.bucs.idm.ldap.RoleRecord

Sets the set of shortOus.

setState(AccountState.State) - Method in class uk.ac.bath.bucs.idm.ldap.AccountState

Setting any state other than one of the six GRACE states will erase graceEndDate.

setSupportOuOverride(String) - Method in class uk.ac.bath.bucs.idm.ldap.PersonRecord

setSurname(List<FlaggableString>) - Method in class uk.ac.bath.bucs.idm.ldap.PersonRecord

Sets the list of surnames.

setTitle(String) - Method in class uk.ac.bath.bucs.idm.ldap.PersonRecord

setUnit(UnitRecord) - Method in class uk.ac.bath.bucs.idm.ldap.LdapService

Sets the state of a unit in the LDAP from a UnitRecord.

setUsername(String) - Method in class uk.ac.bath.bucs.idm.ldap.PersonRecord

setVeryShortOu(String) - Method in class uk.ac.bath.bucs.idm.ldap.UnitRecord

subSequence(int, int) - Method in class uk.ac.bath.bucs.idm.ldap.FlaggableString

T

toBetterString(Object) - Static method in class uk.ac.bath.bucs.idm.ldap.LdapService

toLdap() - Method in class uk.ac.bath.bucs.idm.ldap.AccountState

Converts the state into the form required to store in a PersonRecord, and thenceforth the LDAP.

toString() - Method in class uk.ac.bath.bucs.idm.ldap.AccountState

toString() - Method in class uk.ac.bath.bucs.idm.ldap.AdministrativeLock

Converts this AdministrativeLock value to a String representation suitable for writing to the LDAP.

toString() - Method in class uk.ac.bath.bucs.idm.ldap.FlaggableString

toString() - Method in class uk.ac.bath.bucs.idm.ldap.GroupRecord

toString() - Method in enum uk.ac.bath.bucs.idm.ldap.LdapService.ConnectionType

toString() - Method in class uk.ac.bath.bucs.idm.ldap.PersonRecord

toString() - Method in class uk.ac.bath.bucs.idm.ldap.RoleRecord

toString() - Method in class uk.ac.bath.bucs.idm.ldap.UnitRecord

U

uidsToDns(List<String>) - Static method in class uk.ac.bath.bucs.idm.ldap.LdapUtils

Converts a list of uids to a list of Distinguished Names.

uidToDn(String) - Static method in class uk.ac.bath.bucs.idm.ldap.LdapUtils

Converts a uid to a Distinguished Name for the object representing that uid.

uidToPersonId(LdapService, String) - Static method in class uk.ac.bath.bucs.idm.ldap.LdapUtils

Converts a uid to a PersonId by querying the LDAP.

uk.ac.bath.bucs.idm.ldap - package uk.ac.bath.bucs.idm.ldap

UniStructure - Enum in uk.ac.bath.bucs.idm.ldap

Class to provide information on the University structure.

The data is cached for an hour unless UniStructure.refresh() is called.

UnitRecord - Class in uk.ac.bath.bucs.idm.ldap

Bean class to represent all of the information about a single organisational unit in the LDAP.

Note: this class has a natural ordering that is inconsistent with equals.

UnitRecord() - Constructor for class uk.ac.bath.bucs.idm.ldap.UnitRecord

Creates a new, empty instance of UnitRecord.

usernameExists(LdapService, String) - Static method in class uk.ac.bath.bucs.idm.ldap.LdapUtils

Queries the LDAP to check if a username exists.

V

valueOf(String) - Static method in enum uk.ac.bath.bucs.idm.ldap.AccountState.State

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum uk.ac.bath.bucs.idm.ldap.AdministrativeLock.Type

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in class uk.ac.bath.bucs.idm.ldap.AdministrativeLock

Parses the string representation used in the LDAP into an AdministrativeLock instance.

valueOf(String) - Static method in enum uk.ac.bath.bucs.idm.ldap.GroupRecord.Type

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum uk.ac.bath.bucs.idm.ldap.LdapService.ConnectionType

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum uk.ac.bath.bucs.idm.ldap.PersonRecord.Gender

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum uk.ac.bath.bucs.idm.ldap.PersonRecord.Type

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum uk.ac.bath.bucs.idm.ldap.RoleRecord.Type

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum uk.ac.bath.bucs.idm.ldap.UniStructure

Returns the enum constant of this type with the specified name.

values() - Static method in enum uk.ac.bath.bucs.idm.ldap.AccountState.State

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum uk.ac.bath.bucs.idm.ldap.AdministrativeLock.Type

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum uk.ac.bath.bucs.idm.ldap.GroupRecord.Type

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum uk.ac.bath.bucs.idm.ldap.LdapService.ConnectionType

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum uk.ac.bath.bucs.idm.ldap.PersonRecord.Gender

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum uk.ac.bath.bucs.idm.ldap.PersonRecord.Type

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum uk.ac.bath.bucs.idm.ldap.RoleRecord.Type

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum uk.ac.bath.bucs.idm.ldap.UniStructure

Returns an array containing the constants of this enum type, in the order they are declared.

A C D E F G H I L N P R S T U V