Index (Spotfire Server API | Spotfire Server 14.3.0)

A C D E F G H I J L N P R S T U V W
All Classes and Interfaces|All Packages|Serialized Form

A

abort() - Method in class com.spotfire.server.jaas.NamePasswordLoginModule: This is an implementation of the abort method in LoginModule interface.
addMember(GroupPrincipal, SpotfirePrincipal) - Method in class com.spotfire.server.api.userdir.UserDirectory: Adds the given principal (user or group) to the given group.
addMembers(GroupPrincipal, Collection<? extends SpotfirePrincipal>) - Method in class com.spotfire.server.api.userdir.UserDirectory: Adds the given principals (users or groups) to the given group.
authenticate(UsernameCredential, PasswordCredential) - Method in class com.spotfire.server.jaas.NamePasswordLoginModule: This abstract authenticate method is responsible for validating username-password combinations and must be implemented by all concrete subclasses.
authenticate(AuthenticationContext) - Method in interface com.spotfire.server.security.CustomAuthenticator: Performs authentication based on the provided AuthenticationContext.
authenticateWeb(WebAuthenticationContext) - Method in interface com.spotfire.server.security.CustomWebAuthenticator: Performs authentication based on the provided WebAuthenticationContext.
AuthenticationContext - Interface in com.spotfire.server.security: The AuthenticationContext contains information about the client and the network connection used by a client that needs to be authenticated.
AuthenticationFilterPrincipal - Class in com.spotfire.server.security: Deprecated.
The Authentication Filter API is deprecated and will be removed in a future release. Please use a CustomAuthenticator, a CustomWebAuthenticator or a custom login page (depending on the use case) instead.
AuthenticationFilterPrincipal(String, String, String, String) - Constructor for class com.spotfire.server.security.AuthenticationFilterPrincipal: Deprecated.
The Authentication Filter API is deprecated and will be removed in a future release. Please use a CustomAuthenticator, a CustomWebAuthenticator or a custom login page (depending on the use case) instead.
AutoCallbackHandler - Class in com.spotfire.server.jaas.util: The AutoCallbackHandler is a utility class that can be used by all JAAS clients.
AutoCallbackHandler(String, String) - Constructor for class com.spotfire.server.jaas.util.AutoCallbackHandler: Creates a new AutoCallbackHandler instance.

C

com.spotfire.server.api - package com.spotfire.server.api: Package containing common API classes.
com.spotfire.server.api.userdir - package com.spotfire.server.api.userdir: Package containing API for modifying users and groups in the server.
com.spotfire.server.jaas - package com.spotfire.server.jaas: Package containing API for creating a JAAS module for authentication.
com.spotfire.server.jaas.util - package com.spotfire.server.jaas.util: Package containing utility classes for the the JAAS authentication modules API.
com.spotfire.server.security - package com.spotfire.server.security: Package containing the API classes and interfaces for authentication and other security related functionality.
com.spotfire.server.util - package com.spotfire.server.util: Package containing general utility classes.
commit() - Method in class com.spotfire.server.jaas.NamePasswordLoginModule: This is an implementation of the commit method in LoginModule interface.
createGroup(String, String, String) - Method in class com.spotfire.server.api.userdir.UserDirectory: Creates a new group in the SPOTFIRE domain.
createUser(String, String, String, String, String) - Method in class com.spotfire.server.api.userdir.UserDirectory: Creates a new user.
Credential - Interface in com.spotfire.server.jaas: A marker interface for classes representing some form of authentication credentials, e.g., a username or a password.
CustomAuthenticator - Interface in com.spotfire.server.security: Service-provider interface for (passive) custom authentication.
CustomAuthenticatorException - Exception in com.spotfire.server.security: Exception thrown by implementations of CustomAuthenticator and CustomWebAuthenticator.
CustomAuthenticatorException(String) - Constructor for exception com.spotfire.server.security.CustomAuthenticatorException: Constructs a new instance with the specified detail message.
CustomAuthenticatorException(String, Throwable) - Constructor for exception com.spotfire.server.security.CustomAuthenticatorException: Constructs a new instance with the specified detail message and cause.
CustomAuthenticatorInitContext - Class in com.spotfire.server.security: The initialization context for a CustomAuthenticator.
CustomAuthenticatorPrincipal - Class in com.spotfire.server.security: This class represents a principal that was authenticated by a CustomAuthenticator or a CustomWebAuthenticator.
CustomAuthenticatorPrincipal(String, String, String, String) - Constructor for class com.spotfire.server.security.CustomAuthenticatorPrincipal: Creates a new instance.
CustomWebAuthenticator - Interface in com.spotfire.server.security: Service-provider interface for web-based custom authentication flows (based on OAuth2 or similar).
CustomWebAuthenticatorException - Exception in com.spotfire.server.security: Exception thrown by implementations of CustomWebAuthenticator.
CustomWebAuthenticatorException(String) - Constructor for exception com.spotfire.server.security.CustomWebAuthenticatorException: Constructs a new instance with the specified detail message.
CustomWebAuthenticatorException(String, String, String) - Constructor for exception com.spotfire.server.security.CustomWebAuthenticatorException: Constructs a new instance with the specified detail message, provider name and target URL.
CustomWebAuthenticatorException(String, Throwable) - Constructor for exception com.spotfire.server.security.CustomWebAuthenticatorException: Constructs a new instance with the specified detail message and cause.
CustomWebAuthenticatorException(String, Throwable, String, String) - Constructor for exception com.spotfire.server.security.CustomWebAuthenticatorException: Constructs a new instance with the specified detail message, cause, provider name and target URL.
CustomWebAuthenticatorInitContext - Class in com.spotfire.server.security: The initialization context for a CustomWebAuthenticator.
CustomWebAuthenticatorResult - Class in com.spotfire.server.security: A result object returned from a CustomWebAuthenticator after successful authentication.
CustomWebAuthenticatorResult(CustomAuthenticatorPrincipal, String) - Constructor for class com.spotfire.server.security.CustomWebAuthenticatorResult: Creates a new instance.

D

deletePrincipal(SpotfirePrincipal) - Method in class com.spotfire.server.api.userdir.UserDirectory: Deletes the given principal (user or group), if it exists.
deletePrincipals(Collection<? extends SpotfirePrincipal>) - Method in class com.spotfire.server.api.userdir.UserDirectory: Deletes the given principals (users or groups), if they exist.
DISPLAY_NAME - Enum constant in enum class com.spotfire.server.api.userdir.PrincipalProperty: The display name of a principal.

E

EMAIL - Enum constant in enum class com.spotfire.server.api.userdir.PrincipalProperty: The email address of a principal.
EMPTY - Static variable in class com.spotfire.server.util.Guid: A read-only Guid instance whose value is all zeros.
equals(Object) - Method in class com.spotfire.server.api.Guid
equals(Object) - Method in class com.spotfire.server.api.userdir.SpotfirePrincipal
equals(Object) - Method in class com.spotfire.server.jaas.JAASGroupPrincipal: Compares the specified object with this JAASGroupPrincipal instance.
equals(Object) - Method in class com.spotfire.server.jaas.JAASUserPrincipal: Compares the specified object with this JAASUserPrincipal instance.
equals(Object) - Method in class com.spotfire.server.util.Guid: Compares this object to the supplied object.

F

filter(SecurityContext, AuthenticationContext) - Method in interface com.spotfire.server.security.PostAuthenticationFilter: Applies a post authentication filter on the provided SecurityContext argument.

G

getAncestorGroups(SpotfirePrincipal) - Method in class com.spotfire.server.api.userdir.UserDirectory: Returns the groups that the given principal (user or group) is an immediate or inherited member of.
getAttribute(String) - Method in interface com.spotfire.server.security.AuthenticationContext: See ServletRequest.getAttribute(java.lang.String).
getAttributeNames() - Method in interface com.spotfire.server.security.AuthenticationContext: See ServletRequest.getAttributeNames().
getAuthenticationEndpoint(Map<String, Object>, String, String) - Method in interface com.spotfire.server.security.CustomWebAuthenticator: Returns an absolute URL to the authentication endpoint of the identity provider with the given name, including all relevant request parameters.
getColor() - Method in class com.spotfire.server.security.WebAuthProviderDescription: Returns the CSS color to use as background color of the button on the login page, or null if the default color should be used.
getCookies() - Method in interface com.spotfire.server.security.AuthenticationContext: See HttpServletRequest.getCookies().
getDateHeader(String) - Method in interface com.spotfire.server.security.AuthenticationContext: See HttpServletRequest.getDateHeader(java.lang.String).
getDisplayName() - Method in class com.spotfire.server.api.userdir.SpotfirePrincipal: Returns the display name of this principal.
getDisplayName() - Method in class com.spotfire.server.security.AuthenticationFilterPrincipal: Deprecated.

Returns the display name of the authenticated principal.
getDisplayName() - Method in class com.spotfire.server.security.CustomAuthenticatorPrincipal: Returns the display name of the authenticated principal.
getDisplayName() - Method in class com.spotfire.server.security.SecurityContext: Returns the display name of the authenticated principal, or null if no display name has been set.
getDomainName() - Method in exception com.spotfire.server.api.userdir.PrincipalAlreadyExistsException: Returns the domain name of the already existing principal.
getDomainName() - Method in class com.spotfire.server.api.userdir.SpotfirePrincipal: Returns the domain name of this principal.
getDomainName() - Method in class com.spotfire.server.security.AuthenticationFilterPrincipal: Deprecated.

Returns the domain name of the authenticated principal.
getDomainName() - Method in class com.spotfire.server.security.CustomAuthenticatorPrincipal: Returns the domain name of the authenticated principal.
getDomainName() - Method in class com.spotfire.server.security.SecurityContext: Returns the domain name of the authenticated principal.
getEmail() - Method in class com.spotfire.server.api.userdir.SpotfirePrincipal: Returns the email address of this principal.
getEmailAddress() - Method in class com.spotfire.server.security.AuthenticationFilterPrincipal: Deprecated.

Returns the email address of the authenticated principal.
getEmailAddress() - Method in class com.spotfire.server.security.CustomAuthenticatorPrincipal: Returns the email address of the authenticated principal.
getEmailAddress() - Method in class com.spotfire.server.security.SecurityContext: Returns the email address of the authenticated principal, or null if no email address has been set.
getGroup(Guid) - Method in class com.spotfire.server.api.userdir.UserDirectory: Returns the group with the specified GUID.
getGroup(String, String) - Method in class com.spotfire.server.api.userdir.UserDirectory: Returns the group with the specified name and domain.
getGuid() - Method in class com.spotfire.server.api.userdir.SpotfirePrincipal: Returns the GUID of this principal.
getHeader(String) - Method in interface com.spotfire.server.security.AuthenticationContext: See HttpServletRequest.getHeader(java.lang.String).
getHeaderNames() - Method in interface com.spotfire.server.security.AuthenticationContext: See HttpServletRequest.getHeaderNames().
getHeaders(String) - Method in interface com.spotfire.server.security.AuthenticationContext: See HttpServletRequest.getHeaders(java.lang.String).
getIntHeader(String) - Method in interface com.spotfire.server.security.AuthenticationContext: See HttpServletRequest.getIntHeader(java.lang.String).
getLabel() - Method in class com.spotfire.server.security.WebAuthProviderDescription: Returns the label to be shown on the login page.
getLocalAddr() - Method in interface com.spotfire.server.security.AuthenticationContext: Delegates to the underlying jakarta.servlet.http.HttpServletRequest.
getLocale() - Method in interface com.spotfire.server.security.AuthenticationContext: Delegates to the underlying jakarta.servlet.http.HttpServletRequest.
getLocales() - Method in interface com.spotfire.server.security.AuthenticationContext: Delegates to the underlying jakarta.servlet.http.HttpServletRequest.
getLocalName() - Method in interface com.spotfire.server.security.AuthenticationContext: Delegates to the underlying jakarta.servlet.http.HttpServletRequest.
getLocalPort() - Method in interface com.spotfire.server.security.AuthenticationContext: Delegates to the underlying jakarta.servlet.http.HttpServletRequest.
getMembers(GroupPrincipal) - Method in class com.spotfire.server.api.userdir.UserDirectory: Returns the immediate members (users or groups) of the given group.
getName() - Method in exception com.spotfire.server.api.userdir.PrincipalAlreadyExistsException: Returns the name of the already existing principal.
getName() - Method in class com.spotfire.server.api.userdir.SpotfirePrincipal: Returns the name of this principal.
getName() - Method in class com.spotfire.server.jaas.JAASGroupPrincipal: This method returns the name of the principal.
getName() - Method in class com.spotfire.server.jaas.JAASUserPrincipal: This method returns the name of the principal.
getName() - Method in interface com.spotfire.server.jaas.UsernameCredential: Returns the username.
getName() - Method in class com.spotfire.server.security.AuthenticationFilterPrincipal: Deprecated.

Returns the username of the authenticated principal.
getName() - Method in class com.spotfire.server.security.CustomAuthenticatorPrincipal: Returns the username of the authenticated principal.
getOption(String) - Method in class com.spotfire.server.jaas.NamePasswordLoginModule: Returns the value of the named option from the JAAS application configuration.
getOption(String, boolean) - Method in class com.spotfire.server.jaas.NamePasswordLoginModule: The getOption method returns the boolean value of the option with the given name.
getOption(String, String) - Method in class com.spotfire.server.jaas.NamePasswordLoginModule: Returns the value of the named option from the JAAS application configuration.
getParameter(String) - Method in interface com.spotfire.server.security.WebAuthenticationContext: Delegates to the underlying jakarta.servlet.http.HttpServletRequest.
getParameterMap() - Method in interface com.spotfire.server.security.WebAuthenticationContext: Delegates to the underlying jakarta.servlet.http.HttpServletRequest.
getParameterNames() - Method in interface com.spotfire.server.security.WebAuthenticationContext: Delegates to the underlying jakarta.servlet.http.HttpServletRequest.
getParameters() - Method in class com.spotfire.server.security.CustomAuthenticatorInitContext: Returns a, possibly empty, map of initialization parameters (configured using the Configuration Tool or the config-external-auth configuration command).
getParameters() - Method in class com.spotfire.server.security.CustomWebAuthenticatorInitContext: Returns a, possibly empty, map of initialization parameters (configured using the Configuration Tool or the config-custom-web-auth configuration command).
getParameters() - Method in class com.spotfire.server.security.PostAuthenticationFilterInitContext: Returns a, possibly empty, map of initialization parameters (configured using the Configuration Tool or the config-post-auth-filter configuration command).
getParameterValues(String) - Method in interface com.spotfire.server.security.WebAuthenticationContext: Delegates to the underlying jakarta.servlet.http.HttpServletRequest.
getParentGroups(SpotfirePrincipal) - Method in class com.spotfire.server.api.userdir.UserDirectory: Returns the groups that the given principal (user or group) is an immediate member of.
getPassword() - Method in interface com.spotfire.server.jaas.PasswordCredential: Returns the password.
getPasswordCredential() - Method in class com.spotfire.server.jaas.NamePasswordLoginModule: Returns the PasswordCredential extracted from the input from the PasswordCallback.
getPrincipal() - Method in exception com.spotfire.server.api.userdir.NoSuchPrincipalException: Returns the missing principal.
getPrincipals() - Method in class com.spotfire.server.jaas.NamePasswordLoginModule: The getPrincipals method must be implemented by all concrete subclasses and should return a list of all Principal objects that should be associated with the logged in Subject.
getPrivateCredentials() - Method in class com.spotfire.server.jaas.NamePasswordLoginModule: The getPrivateCredentials method should return a list of all private Credential objects associated with the logged in Subject.
getProviderName() - Method in class com.spotfire.server.security.WebAuthProviderDescription: Returns the name of the provider.
getProviders() - Method in interface com.spotfire.server.security.CustomWebAuthenticator: Returns a non-empty list of descriptions of available providers.
getPublicCredentials() - Method in class com.spotfire.server.jaas.NamePasswordLoginModule: The getPublicCredentials method should return a list of all public Credential objects associated with the logged in Subject.
getQueryString() - Method in interface com.spotfire.server.security.AuthenticationContext: Delegates to the underlying jakarta.servlet.http.HttpServletRequest.
getRemoteAddr() - Method in interface com.spotfire.server.security.AuthenticationContext: See ServletRequest.getRemoteAddr().
getRemoteHost() - Method in interface com.spotfire.server.security.AuthenticationContext: See ServletRequest.getRemoteHost().
getRemotePort() - Method in interface com.spotfire.server.security.AuthenticationContext: Delegates to the underlying jakarta.servlet.http.HttpServletRequest.
getRequestContext() - Method in interface com.spotfire.server.security.AuthenticationContext: Returns a mutable map, stored as a request attribute, that is only available from this interface.
getReturnEndpoint() - Method in class com.spotfire.server.security.CustomWebAuthenticatorInitContext: Deprecated.
This method is deprecated and will be removed in a future release. Please use WebAuthenticationContext.getReturnEndpoint() instead.
getReturnEndpoint() - Method in interface com.spotfire.server.security.WebAuthenticationContext: Returns the URI to the endpoint on the Spotfire Server to which the identity provider should redirect the user's browser after authentication.
getServerName() - Method in interface com.spotfire.server.security.AuthenticationContext: See ServletRequest.getServerName().
getServerPort() - Method in interface com.spotfire.server.security.AuthenticationContext: See ServletRequest.getServerPort().
getSessionContext() - Method in interface com.spotfire.server.security.WebAuthenticationContext: Returns a mutable map, stored as a parameter in the HTTP session associated with this request, that is only available from this interface.
getSessionId() - Method in interface com.spotfire.server.security.AuthenticationContext: Returns the HTTP session ID.
getUser(Guid) - Method in class com.spotfire.server.api.userdir.UserDirectory: Returns the user with the specified GUID.
getUser(String, String) - Method in class com.spotfire.server.api.userdir.UserDirectory: Returns the user with the specified name and domain.
getUserDirectory() - Method in interface com.spotfire.server.security.AuthenticationContext: Returns a reference to the User Directory class, that can be used for reading and writing users and groups.
getUserDirectory() - Method in class com.spotfire.server.security.CustomAuthenticatorInitContext: Returns a reference to the User Directory class, that can be used for reading and writing users and groups.
getUserDirectory() - Method in class com.spotfire.server.security.CustomWebAuthenticatorInitContext: Returns a reference to the User Directory class, that can be used for reading and writing users and groups.
getUserDirectory() - Method in class com.spotfire.server.security.PostAuthenticationFilterInitContext: Returns a reference to the User Directory class, that can be used for reading and writing users and groups.
getUsername() - Method in class com.spotfire.server.security.AuthenticationFilterPrincipal: Deprecated.

Returns the username of the authenticated principal.
getUsername() - Method in class com.spotfire.server.security.CustomAuthenticatorPrincipal: Returns the username of the authenticated principal.
getUsername() - Method in class com.spotfire.server.security.SecurityContext: Returns the username of the authenticated principal.
getUsernameCredential() - Method in class com.spotfire.server.jaas.NamePasswordLoginModule: Returns the UsernameCredential extracted from the input from the NameCallback.
GroupPrincipal - Class in com.spotfire.server.api.userdir: Represents a group principal (a principal that may contain other principals).
Guid - Class in com.spotfire.server.api: This class represents an universally unique identifier (UUID), also known as globally unique identifier (GUID), as defined in RFC 4122.
Guid - Class in com.spotfire.server.util: This class represents an universally unique identifier (UUID), also known as globally unique identifier (GUID), see UUID.
Guid() - Constructor for class com.spotfire.server.util.Guid: Constructs a new Guid.
Guid(String) - Constructor for class com.spotfire.server.api.Guid: Constructs a new Guid using the specified string representation as described in the Guid.toString() method.
Guid(String) - Constructor for class com.spotfire.server.util.Guid: Constructs a new Guid using the specified guid string representation as described in the toString() method.

H

handle(Callback[]) - Method in class com.spotfire.server.jaas.util.AutoCallbackHandler: The handle method processes the given callbacks.
hashCode() - Method in class com.spotfire.server.api.Guid
hashCode() - Method in class com.spotfire.server.api.userdir.SpotfirePrincipal
hashCode() - Method in class com.spotfire.server.jaas.JAASGroupPrincipal: Returns the hash code value for the principal.
hashCode() - Method in class com.spotfire.server.jaas.JAASUserPrincipal: Returns the hash code value for the principal.
hashCode() - Method in class com.spotfire.server.util.Guid: Returns a hash code for this Guid.

I

init() - Method in class com.spotfire.server.jaas.NamePasswordLoginModule: An abstract initialization method, called by the NamePasswordLoginModule.initialize(Subject, CallbackHandler, Map, Map) method.
init(CustomAuthenticatorInitContext) - Method in interface com.spotfire.server.security.CustomAuthenticator: Initializes this CustomAuthenticator.
init(CustomWebAuthenticatorInitContext) - Method in interface com.spotfire.server.security.CustomWebAuthenticator: Initializes this CustomWebAuthenticator.
init(PostAuthenticationFilterInitContext) - Method in interface com.spotfire.server.security.PostAuthenticationFilter: Initializes this PostAuthenticationFilter.
init(Map<String, String>) - Method in interface com.spotfire.server.security.CustomAuthenticator: Deprecated.
This method is deprecated and will be removed in a future release. Please implement the CustomAuthenticator.init(CustomAuthenticatorInitContext) method instead.
initialize(Subject, CallbackHandler, Map, Map) - Method in class com.spotfire.server.jaas.NamePasswordLoginModule: This is an implementation of the initialize method in LoginModule interface.
InvalidArgumentException - Exception in com.spotfire.server.api.userdir: Thrown when an invalid argument is given.
InvalidOperationException - Exception in com.spotfire.server.api.userdir: Thrown when an attempt is made to perform an invalid operation (for example adding principals to an immutable group or modifying a fixed principal).
InvalidPasswordException - Exception in com.spotfire.server.api.userdir: Thrown when an invalid password is given.
isEnabled() - Method in class com.spotfire.server.api.userdir.UserPrincipal: Indicates whether or not this user is enabled (may log in).
isFixed() - Method in class com.spotfire.server.api.userdir.SpotfirePrincipal: Indicates whether or not this principal is fixed (cannot be removed, renamed or manually altered in any other way - except for being enabled/disabled and locked/unlocked).
isGuid(String) - Static method in class com.spotfire.server.util.Guid: Tells whether or not the supplied guid string corresponds to a valid Guid.
isImmutable() - Method in class com.spotfire.server.api.userdir.GroupPrincipal: Indicates whether or not this group is immutable (cannot have members manually added or removed).
isLocked() - Method in class com.spotfire.server.api.userdir.UserPrincipal: Indicates whether or not this user is locked (temporarily prevented from logging in).
isMember(GroupPrincipal, SpotfirePrincipal) - Method in class com.spotfire.server.api.userdir.UserDirectory: Returns true if the given principal (user or group) is a member (immediate or inherited) of the given group.
isRequestedSessionIdFromCookie() - Method in interface com.spotfire.server.security.AuthenticationContext: Returns the HTTP session ID.
isRequestedSessionIdFromURL() - Method in interface com.spotfire.server.security.AuthenticationContext: Returns the HTTP session ID.
isRequestedSessionIdValid() - Method in interface com.spotfire.server.security.AuthenticationContext: Returns the HTTP session ID.
isSecure() - Method in interface com.spotfire.server.security.AuthenticationContext: See ServletRequest.isSecure().

J

JAASGroupPrincipal - Class in com.spotfire.server.jaas: This class can be used as a base class for Principal implementations representing groups.
JAASGroupPrincipal(String) - Constructor for class com.spotfire.server.jaas.JAASGroupPrincipal: Creates a new JAASGroupPrincipal instance with the given groupname.
JAASUserPrincipal - Class in com.spotfire.server.jaas: This class can be used as a base class for Principal implementations representing users.
JAASUserPrincipal(String) - Constructor for class com.spotfire.server.jaas.JAASUserPrincipal: Creates a new JAASUserPrincipal instance with the given username.

L

lock(UserPrincipal, long, TimeUnit) - Method in class com.spotfire.server.api.userdir.UserDirectory: Locks the given user for a specified amount of time.
login() - Method in class com.spotfire.server.jaas.NamePasswordLoginModule: This is an implementation of the login method in LoginModule interface.
logout() - Method in class com.spotfire.server.jaas.NamePasswordLoginModule: This is an implementation of the logout method in LoginModule interface.

N

NAME - Enum constant in enum class com.spotfire.server.api.userdir.PrincipalProperty: The name of a principal.
NamePasswordLoginModule - Class in com.spotfire.server.jaas: An abstract base class for LoginModule implementations designed for username-password authentication.
NamePasswordLoginModule() - Constructor for class com.spotfire.server.jaas.NamePasswordLoginModule
NonTransientUserDirectoryException - Exception in com.spotfire.server.api.userdir: Thrown when a retry of the operation without any changes by the calling application would fail.
NoSuchPrincipalException - Exception in com.spotfire.server.api.userdir: Thrown when an operation has been requested on a principal that does not exist in the user directory.

P

parseGuid(String) - Static method in class com.spotfire.server.util.Guid: Constructs a new Guid using the specified guid string representation as described in the toString() method.
PasswordCredential - Interface in com.spotfire.server.jaas: An interface for credential classes with password properties.
PostAuthenticationFilter - Interface in com.spotfire.server.security: An interface defining the methods that must be implemented by a class to which post authentication filtering duties can be delegated.
PostAuthenticationFilterException - Exception in com.spotfire.server.security: A PostAuthenticationFilterException is an exception indicating that a configuration error prevents the PostAuthenticationFilter from working.
PostAuthenticationFilterException() - Constructor for exception com.spotfire.server.security.PostAuthenticationFilterException: Constructs a new exception with null as its detail message.
PostAuthenticationFilterException(String) - Constructor for exception com.spotfire.server.security.PostAuthenticationFilterException: Constructs a new exception with the specified detail message.
PostAuthenticationFilterException(String, Throwable) - Constructor for exception com.spotfire.server.security.PostAuthenticationFilterException: Constructs a new exception with the specified detail message and cause.
PostAuthenticationFilterException(Throwable) - Constructor for exception com.spotfire.server.security.PostAuthenticationFilterException: Constructs a new exception with the specified cause and a detail message of cause == null ? null : cause.toString(), which typically contains the class and detail message of cause.
PostAuthenticationFilterInitContext - Class in com.spotfire.server.security: The initialization context for a PostAuthenticationFilter.
PrincipalAlreadyExistsException - Exception in com.spotfire.server.api.userdir: 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.
PrincipalProperty - Enum Class in com.spotfire.server.api.userdir: Represents searchable properties (fields) of user directory principals.

R

removeMember(GroupPrincipal, SpotfirePrincipal) - Method in class com.spotfire.server.api.userdir.UserDirectory: Removes the given principal (user or group) from the given group if it exists and is a member of the group.
removeMembers(GroupPrincipal, Collection<? extends SpotfirePrincipal>) - Method in class com.spotfire.server.api.userdir.UserDirectory: Removes the given principals (users or groups) from the given group.

S

searchGroups(PrincipalProperty, String, int) - Method in class com.spotfire.server.api.userdir.UserDirectory: Returns all groups, up to the specified upper limit, with a given property that matches the given search expression.
searchUsers(PrincipalProperty, String, int) - Method in class com.spotfire.server.api.userdir.UserDirectory: Returns all users, up to the specified upper limit, with a given property that matches the given search expression.
SecurityContext - Class in com.spotfire.server.security: The SecurityContext class contains information about an authenticated user.
SecurityContext(String, String) - Constructor for class com.spotfire.server.security.SecurityContext: Creates a new SecurityContext instance.
SecurityContext(String, String, String, String) - Constructor for class com.spotfire.server.security.SecurityContext: Creates a new SecurityContext instance.
setDisplayName(T, String) - Method in class com.spotfire.server.api.userdir.UserDirectory: Sets the display name for the given principal (user or group).
setEmailAddress(T, String) - Method in class com.spotfire.server.api.userdir.UserDirectory: Sets the e-mail address for the given principal (user or group).
setEnabled(UserPrincipal, boolean) - Method in class com.spotfire.server.api.userdir.UserDirectory: Enables or disables the given user.
setMembers(GroupPrincipal, Collection<? extends SpotfirePrincipal>) - Method in class com.spotfire.server.api.userdir.UserDirectory: Sets the given principals (users or groups) as members of the given group.
setName(T, String) - Method in class com.spotfire.server.api.userdir.UserDirectory: Sets the name for the given principal (user or group).
setParentGroups(SpotfirePrincipal, Collection<GroupPrincipal>) - Method in class com.spotfire.server.api.userdir.UserDirectory: Sets the groups that the given principal (user or group) should be an immediate member of.
setPassword(UserPrincipal, String) - Method in class com.spotfire.server.api.userdir.UserDirectory: Sets the password for the given user.
SpotfirePrincipal - Class in com.spotfire.server.api.userdir: Represents a principal, such as a user or a group.

T

toString() - Method in class com.spotfire.server.api.Guid: Returns a String representation of this Guid.
toString() - Method in class com.spotfire.server.jaas.JAASGroupPrincipal: The method returns a String representation of this principal.
toString() - Method in class com.spotfire.server.jaas.JAASUserPrincipal: The method returns a String representation of this principal.
toString() - Method in class com.spotfire.server.security.AuthenticationFilterPrincipal: Deprecated.
toString() - Method in class com.spotfire.server.security.CustomAuthenticatorPrincipal
toString() - Method in class com.spotfire.server.security.SecurityContext
toString() - Method in class com.spotfire.server.util.Guid: Returns a String representation of this Guid.
TransientUserDirectoryException - Exception in com.spotfire.server.api.userdir: Thrown when a retry of the operation without any changes by the calling application might succeed (the typical scenario would be a connection timeout).

U

unlock(UserPrincipal) - Method in class com.spotfire.server.api.userdir.UserDirectory: Unlocks the given user.
UserDirectory - Class in com.spotfire.server.api.userdir: Provides functionality to create, read, update and delete users and groups.
UserDirectoryException - Exception in com.spotfire.server.api.userdir: Thrown when an error occurs when calling the user directory.
UsernameCredential - Interface in com.spotfire.server.jaas: An interface for credential classes with username properties.
UserPrincipal - Class in com.spotfire.server.api.userdir: Represents a user principal.

V

valueOf(String) - Static method in enum class com.spotfire.server.api.userdir.PrincipalProperty: Returns the enum constant of this class with the specified name.
values() - Static method in enum class com.spotfire.server.api.userdir.PrincipalProperty: Returns an array containing the constants of this enum class, in the order they are declared.

W

WebAuthenticationContext - Interface in com.spotfire.server.security: The WebAuthenticationContext contains information besides the information provided by the AuthenticationContext that is only available to CustomWebAuthenticator implementations.
WebAuthProviderDescription - Class in com.spotfire.server.security: Describes a web authentication provider so that it may be displayed on the login page.
WebAuthProviderDescription(String, String, String) - Constructor for class com.spotfire.server.security.WebAuthProviderDescription: Creates a new instance.

A C D E F G H I J L N P R S T U V W
All Classes and Interfaces|All Packages|Serialized Form