Uses of Class
com.spotfire.server.api.userdir.UserDirectoryException

Packages that use UserDirectoryException

Package	Description
com.spotfire.server.api.userdir	Package containing API for modifying users and groups in the server.

Uses of UserDirectoryException in com.spotfire.server.api.userdir

Subclasses of UserDirectoryException in com.spotfire.server.api.userdir

Modifier and Type	Class	Description
class	InvalidArgumentException	Thrown when an invalid argument is given.
class	InvalidOperationException	Thrown when an attempt is made to perform an invalid operation (for example adding principals to an immutable group or modifying a fixed principal).
class	InvalidPasswordException	Thrown when an invalid password is given.
class	NonTransientUserDirectoryException	Thrown when a retry of the operation without any changes by the calling application would fail.
class	NoSuchPrincipalException	Thrown when an operation has been requested on a principal that does not exist in the user directory.
class	PrincipalAlreadyExistsException	Thrown when an attempt has been made to name a principal with a name that already exists on another principal in the same domain in the user directory.
class	TransientUserDirectoryException	Thrown when a retry of the operation without any changes by the calling application might succeed (the typical scenario would be a connection timeout).

Methods in com.spotfire.server.api.userdir that throw UserDirectoryException

Modifier and Type	Method	Description
abstract void	UserDirectory.addMember(GroupPrincipal group, SpotfirePrincipal principal)	Adds the given principal (user or group) to the given group.
abstract void	UserDirectory.addMembers(GroupPrincipal group, Collection<? extends SpotfirePrincipal> principals)	Adds the given principals (users or groups) to the given group.
abstract GroupPrincipal	UserDirectory.createGroup(String name, String displayName, String emailAddress)	Creates a new group in the SPOTFIRE domain.
abstract UserPrincipal	UserDirectory.createUser(String name, String domainName, String displayName, String emailAddress, String password)	Creates a new user.
abstract boolean	UserDirectory.deletePrincipal(SpotfirePrincipal principal)	Deletes the given principal (user or group), if it exists.
abstract boolean	UserDirectory.deletePrincipals(Collection<? extends SpotfirePrincipal> principals)	Deletes the given principals (users or groups), if they exist.
abstract Set<GroupPrincipal>	UserDirectory.getAncestorGroups(SpotfirePrincipal principal)	Returns the groups that the given principal (user or group) is an immediate or inherited member of.
abstract GroupPrincipal	UserDirectory.getGroup(Guid guid)	Returns the group with the specified GUID.
abstract GroupPrincipal	UserDirectory.getGroup(String name, String domainName)	Returns the group with the specified name and domain.
abstract Set<SpotfirePrincipal>	UserDirectory.getMembers(GroupPrincipal group)	Returns the immediate members (users or groups) of the given group.
abstract Set<GroupPrincipal>	UserDirectory.getParentGroups(SpotfirePrincipal principal)	Returns the groups that the given principal (user or group) is an immediate member of.
abstract UserPrincipal	UserDirectory.getUser(Guid guid)	Returns the user with the specified GUID.
abstract UserPrincipal	UserDirectory.getUser(String name, String domainName)	Returns the user with the specified name and domain.
abstract boolean	UserDirectory.isMember(GroupPrincipal group, SpotfirePrincipal principal)	Returns true if the given principal (user or group) is a member (immediate or inherited) of the given group.
abstract UserPrincipal	UserDirectory.lock(UserPrincipal user, long time, TimeUnit unit)	Locks the given user for a specified amount of time.
abstract boolean	UserDirectory.removeMember(GroupPrincipal group, SpotfirePrincipal principal)	Removes the given principal (user or group) from the given group if it exists and is a member of the group.
abstract boolean	UserDirectory.removeMembers(GroupPrincipal group, Collection<? extends SpotfirePrincipal> principals)	Removes the given principals (users or groups) from the given group.
abstract Set<GroupPrincipal>	UserDirectory.searchGroups(PrincipalProperty searchProperty, String searchExpression, int maxResults)	Returns all groups, up to the specified upper limit, with a given property that matches the given search expression.
abstract Set<UserPrincipal>	UserDirectory.searchUsers(PrincipalProperty searchProperty, String searchExpression, int maxResults)	Returns all users, up to the specified upper limit, with a given property that matches the given search expression.
abstract <T extends SpotfirePrincipal> T	UserDirectory.setDisplayName(T principal, String displayName)	Sets the display name for the given principal (user or group).
abstract <T extends SpotfirePrincipal> T	UserDirectory.setEmailAddress(T principal, String emailAddress)	Sets the e-mail address for the given principal (user or group).
abstract UserPrincipal	UserDirectory.setEnabled(UserPrincipal user, boolean enabled)	Enables or disables the given user.
abstract void	UserDirectory.setMembers(GroupPrincipal group, Collection<? extends SpotfirePrincipal> principals)	Sets the given principals (users or groups) as members of the given group.
abstract <T extends SpotfirePrincipal> T	UserDirectory.setName(T principal, String name)	Sets the name for the given principal (user or group).
abstract void	UserDirectory.setParentGroups(SpotfirePrincipal principal, Collection<GroupPrincipal> groups)	Sets the groups that the given principal (user or group) should be an immediate member of.
abstract void	UserDirectory.setPassword(UserPrincipal user, String password)	Sets the password for the given user.
abstract UserPrincipal	UserDirectory.unlock(UserPrincipal user)	Unlocks the given user.