Index
A B C D E F G H I J L M N O P R S U V W
All Classes All Packages
All Classes All Packages
All Classes All Packages
A
- AbstractClearableCredential - Class in jakarta.security.enterprise.credential
-
AbstractClearableCredential
contains behavior common to
implementations that can be meaningfully cleared.Credential
- AbstractClearableCredential() - Constructor for class jakarta.security.enterprise.credential.AbstractClearableCredential
- authenticate(HttpServletRequest, HttpServletResponse, AuthenticationParameters) - Method in interface jakarta.security.enterprise.SecurityContext
-
Signal to the container (programmatically trigger) that it should start or continue a web/HTTP based authentication dialog with the caller.
- AuthenticationException - Exception in jakarta.security.enterprise
-
A generic authentication exception.
- AuthenticationException() - Constructor for exception jakarta.security.enterprise.AuthenticationException
-
Constructs a new
AuthenticationException
exception withnull
as its detail message. - AuthenticationException(String) - Constructor for exception jakarta.security.enterprise.AuthenticationException
-
Constructs a new
AuthenticationException
exception with the specified detail message. - AuthenticationException(String, Throwable) - Constructor for exception jakarta.security.enterprise.AuthenticationException
-
Constructs a new
AuthenticationException
exception with the specified detail message and cause. - AuthenticationException(Throwable) - Constructor for exception jakarta.security.enterprise.AuthenticationException
-
Constructs a new
AuthenticationException
exception with the specified cause. - AuthenticationParameters - Class in jakarta.security.enterprise.authentication.mechanism.http
-
Parameters that are provided along with an authentication request.
- AuthenticationParameters() - Constructor for class jakarta.security.enterprise.authentication.mechanism.http.AuthenticationParameters
- AuthenticationStatus - Enum in jakarta.security.enterprise
-
The AuthenticationStatus is used as a return value by primarily the
HttpAuthenticationMechanism
to indicate the result (status) of the authentication process. - AutoApplySession - Annotation Type in jakarta.security.enterprise.authentication.mechanism.http
-
The AutoApplySession annotation provides an application the ability to declaratively designate that an authentication mechanism uses the
jakarta.servlet.http.registerSession
and auto applies this for every request.
B
- BasicAuthenticationCredential - Class in jakarta.security.enterprise.credential
-
BasicAuthenticationCredential
extendsUsernamePasswordCredential
to represent credentials used by HTTP Basic Authentication. - BasicAuthenticationCredential(String) - Constructor for class jakarta.security.enterprise.credential.BasicAuthenticationCredential
-
Constructor
- BasicAuthenticationMechanismDefinition - Annotation Type in jakarta.security.enterprise.authentication.mechanism.http
-
Annotation used to define a container authentication mechanism that implements the HTTP basic access authentication protocol as defined by the Servlet spec (13.6.1) and make that implementation available as an enabled CDI bean.
- bindDn() - Method in annotation type jakarta.security.enterprise.identitystore.LdapIdentityStoreDefinition
-
Distinguished name for the application or administrative user that will be used to make the initial connection to the LDAP and to perform searches and lookups.
- bindDnPassword() - Method in annotation type jakarta.security.enterprise.identitystore.LdapIdentityStoreDefinition
-
Password for the application/admin user defined by the bindDn member.
C
- callerBaseDn() - Method in annotation type jakarta.security.enterprise.identitystore.LdapIdentityStoreDefinition
-
Base distinguished name for callers in the LDAP store (e.g., "
ou=caller,dc=eclipse,dc=net
"). - callerNameAttribute() - Method in annotation type jakarta.security.enterprise.identitystore.LdapIdentityStoreDefinition
-
Name of the attribute that contains the callers name in the person object (e.g., "
uid
"). - CallerOnlyCredential - Class in jakarta.security.enterprise.credential
-
CallerOnlyCredential
represents a credential that only contains a caller name and no secret of any kind. - CallerOnlyCredential(String) - Constructor for class jakarta.security.enterprise.credential.CallerOnlyCredential
- CallerPrincipal - Class in jakarta.security.enterprise
-
Principal that represents the caller principal associated with the invocation being processed by the container (e.g. the current HTTP request).
- CallerPrincipal(String) - Constructor for class jakarta.security.enterprise.CallerPrincipal
- callerQuery() - Method in annotation type jakarta.security.enterprise.identitystore.DatabaseIdentityStoreDefinition
-
SQL query to validate the {caller, password} pair.
- callerSearchBase() - Method in annotation type jakarta.security.enterprise.identitystore.LdapIdentityStoreDefinition
-
Search base for looking up callers (e.g., "
ou=caller,dc=eclipse,dc=net
"). - callerSearchFilter() - Method in annotation type jakarta.security.enterprise.identitystore.LdapIdentityStoreDefinition
-
Search filter to find callers when callerSearchBase is set.
- callerSearchScope() - Method in annotation type jakarta.security.enterprise.identitystore.LdapIdentityStoreDefinition
-
Search scope for caller searches: determines depth of the search in the LDAP tree.
- callerSearchScopeExpression() - Method in annotation type jakarta.security.enterprise.identitystore.LdapIdentityStoreDefinition
-
Allow callerSearchScope to be specified as a Jakarta Expression Language expression.
- cleanClientSubject() - Method in interface jakarta.security.enterprise.authentication.mechanism.http.HttpMessageContext
-
Convenience method to clean the subject associated with this context.
- cleanClientSubject() - Method in class jakarta.security.enterprise.authentication.mechanism.http.HttpMessageContextWrapper
- cleanSubject(HttpServletRequest, HttpServletResponse, HttpMessageContext) - Method in interface jakarta.security.enterprise.authentication.mechanism.http.HttpAuthenticationMechanism
-
Remove mechanism specific principals and credentials from the subject and any other state the mechanism might have used.
- clear() - Method in class jakarta.security.enterprise.credential.AbstractClearableCredential
- clear() - Method in interface jakarta.security.enterprise.credential.Credential
-
Clears the credential.
- clear() - Method in class jakarta.security.enterprise.credential.Password
-
Securely clears the password value.
- clearCredential() - Method in class jakarta.security.enterprise.credential.AbstractClearableCredential
-
Invokes the specific subclass to securely clear the credential value.
- clearCredential() - Method in class jakarta.security.enterprise.credential.UsernamePasswordCredential
- compareTo(String) - Method in class jakarta.security.enterprise.credential.Password
- compareTo(String, String) - Method in class jakarta.security.enterprise.credential.UsernamePasswordCredential
- cookieHttpOnly() - Method in annotation type jakarta.security.enterprise.authentication.mechanism.http.RememberMe
-
Flag to indicate that the remember me cookie should not be exposed to client-side scripting code, and should only be sent with HTTP requests.
- cookieHttpOnlyExpression() - Method in annotation type jakarta.security.enterprise.authentication.mechanism.http.RememberMe
-
Jakarta Expression Language expression variant of
cookieHttpOnly()
. - cookieMaxAgeSeconds() - Method in annotation type jakarta.security.enterprise.authentication.mechanism.http.RememberMe
-
Max age in seconds for the remember me cookie.
- cookieMaxAgeSecondsExpression() - Method in annotation type jakarta.security.enterprise.authentication.mechanism.http.RememberMe
-
Jakarta Expression Language expression variant of
cookieMaxAgeSeconds()
. - cookieName() - Method in annotation type jakarta.security.enterprise.authentication.mechanism.http.RememberMe
-
Name of the remember me cookie.
- cookieSecureOnly() - Method in annotation type jakarta.security.enterprise.authentication.mechanism.http.RememberMe
-
Flag to indicate that the remember me cookie should only be sent using a secure protocol (e.g.
- cookieSecureOnlyExpression() - Method in annotation type jakarta.security.enterprise.authentication.mechanism.http.RememberMe
-
Jakarta Expression Language expression variant of
cookieSecureOnly()
. - credential(Credential) - Method in class jakarta.security.enterprise.authentication.mechanism.http.AuthenticationParameters
-
Sets the credential to be used by the authentication mechanism responding to the authenticate call in which these AuthenticationParameters are passed.
- Credential - Interface in jakarta.security.enterprise.credential
-
Credential
represents the credential the caller will use to authenticate. - CredentialValidationResult - Class in jakarta.security.enterprise.identitystore
-
CredentialValidationResult
is the result from an attempt to validate an instance ofCredential
. - CredentialValidationResult(CallerPrincipal) - Constructor for class jakarta.security.enterprise.identitystore.CredentialValidationResult
-
Constructor for a VALID result.
- CredentialValidationResult(CallerPrincipal, Set<String>) - Constructor for class jakarta.security.enterprise.identitystore.CredentialValidationResult
-
Constructor for a VALID result.
- CredentialValidationResult(String) - Constructor for class jakarta.security.enterprise.identitystore.CredentialValidationResult
-
Constructor for a VALID result.
- CredentialValidationResult(String, CallerPrincipal, String, String, Set<String>) - Constructor for class jakarta.security.enterprise.identitystore.CredentialValidationResult
-
Constructor for a VALID result.
- CredentialValidationResult(String, String, String, String, Set<String>) - Constructor for class jakarta.security.enterprise.identitystore.CredentialValidationResult
-
Constructor for a VALID result.
- CredentialValidationResult(String, Set<String>) - Constructor for class jakarta.security.enterprise.identitystore.CredentialValidationResult
-
Constructor for a VALID result.
- CredentialValidationResult.Status - Enum in jakarta.security.enterprise.identitystore
- CustomFormAuthenticationMechanismDefinition - Annotation Type in jakarta.security.enterprise.authentication.mechanism.http
-
Annotation used to define a container authentication mechanism that implements authentication resembling Servlet FORM authentication (Servlet spec 13.6.3).
D
- DatabaseIdentityStoreDefinition - Annotation Type in jakarta.security.enterprise.identitystore
-
Annotation used to define a container-provided
IdentityStore
that stores caller credentials and identity attributes in a relational database, and make that implementation available as an enabled CDI bean. - dataSourceLookup() - Method in annotation type jakarta.security.enterprise.identitystore.DatabaseIdentityStoreDefinition
-
Full JNDI name of the data source that provides access to the data base where the caller identities are stored.
- DEFAULT_VALIDATION_TYPES - Static variable in interface jakarta.security.enterprise.identitystore.IdentityStore
-
Default set of validation types.
- doNothing() - Method in interface jakarta.security.enterprise.authentication.mechanism.http.HttpMessageContext
-
Instructs the container to "do nothing".
- doNothing() - Method in class jakarta.security.enterprise.authentication.mechanism.http.HttpMessageContextWrapper
E
- errorPage() - Method in annotation type jakarta.security.enterprise.authentication.mechanism.http.LoginToContinue
-
The resource (page) a caller should get to see in case an error, such as providing invalid credentials, occurs on the page set by
LoginToContinue.loginPage()
.
F
- FormAuthenticationMechanismDefinition - Annotation Type in jakarta.security.enterprise.authentication.mechanism.http
-
Annotation used to define a container authentication mechanism that implements FORM authentication as defined by the Servlet spec (13.6.3) and make that implementation available as an enabled CDI bean.
- forward(String) - Method in interface jakarta.security.enterprise.authentication.mechanism.http.HttpMessageContext
-
Forwards to another resource (Jakarta Servlet, Jakarta Server Pages file, or HTML file) on the server.
- forward(String) - Method in class jakarta.security.enterprise.authentication.mechanism.http.HttpMessageContextWrapper
G
- generate(char[]) - Method in interface jakarta.security.enterprise.identitystore.PasswordHash
-
Generate an encoded password hash value for storage in a user's account.
- generateLoginToken(CallerPrincipal, Set<String>) - Method in interface jakarta.security.enterprise.identitystore.RememberMeIdentityStore
-
Associates the given principal and groups with a token.
- getAuthParameters() - Method in interface jakarta.security.enterprise.authentication.mechanism.http.HttpMessageContext
-
Returns the parameters that were provided with the SecurityContext#authenticate(AuthParameters) call.
- getAuthParameters() - Method in class jakarta.security.enterprise.authentication.mechanism.http.HttpMessageContextWrapper
- getCaller() - Method in class jakarta.security.enterprise.credential.CallerOnlyCredential
- getCaller() - Method in class jakarta.security.enterprise.credential.UsernamePasswordCredential
- getCallerDn() - Method in class jakarta.security.enterprise.identitystore.CredentialValidationResult
-
Return the CallerPrincipal for the validated credential.
- getCallerGroups() - Method in class jakarta.security.enterprise.identitystore.CredentialValidationResult
-
Determines the set of groups that the specified Caller is in, based on the associated identity store.
- getCallerGroups(CredentialValidationResult) - Method in interface jakarta.security.enterprise.identitystore.IdentityStore
-
Returns groups for the caller, who is identified by the
CallerPrincipal
(and potentially other values) found in thevalidationResult
parameter. - getCallerPrincipal() - Method in interface jakarta.security.enterprise.authentication.mechanism.http.HttpMessageContext
-
Gets the Principal set by a call to notifyContainerAboutLogin().
- getCallerPrincipal() - Method in class jakarta.security.enterprise.authentication.mechanism.http.HttpMessageContextWrapper
- getCallerPrincipal() - Method in class jakarta.security.enterprise.identitystore.CredentialValidationResult
-
Return the CallerPrincipal for the validated credential.
- getCallerPrincipal() - Method in interface jakarta.security.enterprise.SecurityContext
-
Retrieve the platform-specific
java.security.Principal
that represents the name of authenticated caller, or null if the current caller is not authenticated. - getCallerUniqueId() - Method in class jakarta.security.enterprise.identitystore.CredentialValidationResult
-
Return a string that uniquely identifies this caller within the identity store (since the Principal name used may not be unique).
- getClientSubject() - Method in interface jakarta.security.enterprise.authentication.mechanism.http.HttpMessageContext
-
Returns the subject for which authentication is to take place.
- getClientSubject() - Method in class jakarta.security.enterprise.authentication.mechanism.http.HttpMessageContextWrapper
- getCredential() - Method in class jakarta.security.enterprise.authentication.mechanism.http.AuthenticationParameters
-
The credential set as parameter in this instance.
- getGroups() - Method in interface jakarta.security.enterprise.authentication.mechanism.http.HttpMessageContext
-
Gets the groups set by a call to notifyContainerAboutLogin().
- getGroups() - Method in class jakarta.security.enterprise.authentication.mechanism.http.HttpMessageContextWrapper
- getHandler() - Method in interface jakarta.security.enterprise.authentication.mechanism.http.HttpMessageContext
-
Returns the low level Jakarta Authentication handler that the runtime provided when creating this
HttpMessageContext
, and which this context uses to communicate the authentication details to the runtime. - getHandler() - Method in class jakarta.security.enterprise.authentication.mechanism.http.HttpMessageContextWrapper
- getIdentityStoreId() - Method in class jakarta.security.enterprise.identitystore.CredentialValidationResult
-
Return the unique ID of the identity store used to validate the credentials.
- getMessageInfo() - Method in interface jakarta.security.enterprise.authentication.mechanism.http.HttpMessageContext
-
Returns the the low level Jakarta Authentication message info instance for the current request.
- getMessageInfo() - Method in class jakarta.security.enterprise.authentication.mechanism.http.HttpMessageContextWrapper
- getName() - Method in class jakarta.security.enterprise.CallerPrincipal
-
The name of the caller
- getPassword() - Method in class jakarta.security.enterprise.credential.UsernamePasswordCredential
-
Determines the password.
- getPasswordAsString() - Method in class jakarta.security.enterprise.credential.UsernamePasswordCredential
-
Determines the password.
- getPrincipalsByType(Class<T>) - Method in interface jakarta.security.enterprise.SecurityContext
-
Retrieve all Principals of the given type from the authenticated caller's Subject, or an empty set if the current caller is not authenticated, or if the specified type isn't found in the Subject.
- getRequest() - Method in interface jakarta.security.enterprise.authentication.mechanism.http.HttpMessageContext
-
Returns the request object associated with the current request.
- getRequest() - Method in class jakarta.security.enterprise.authentication.mechanism.http.HttpMessageContextWrapper
- getResponse() - Method in interface jakarta.security.enterprise.authentication.mechanism.http.HttpMessageContext
-
Returns the response object associated with the current request.
- getResponse() - Method in class jakarta.security.enterprise.authentication.mechanism.http.HttpMessageContextWrapper
- getStatus() - Method in class jakarta.security.enterprise.identitystore.CredentialValidationResult
-
Determines the validation status.
- getToken() - Method in class jakarta.security.enterprise.credential.RememberMeCredential
-
Determines the token value to compare for authentication.
- getValue() - Method in class jakarta.security.enterprise.credential.Password
-
Determines the password value.
- getWrapped() - Method in class jakarta.security.enterprise.authentication.mechanism.http.HttpMessageContextWrapper
- groupMemberAttribute() - Method in annotation type jakarta.security.enterprise.identitystore.LdapIdentityStoreDefinition
-
Name of the attribute in a group object that identifies the members of the group (e.g., "
member
"). - groupMemberOfAttribute() - Method in annotation type jakarta.security.enterprise.identitystore.LdapIdentityStoreDefinition
-
Name of the attribute in a person object that identifies the groups the caller belongs to (e.g., "
memberOf
"). - groupNameAttribute() - Method in annotation type jakarta.security.enterprise.identitystore.LdapIdentityStoreDefinition
-
Name of the attribute of a group object that represents the group name (e.g., "
cn
") - groupSearchBase() - Method in annotation type jakarta.security.enterprise.identitystore.LdapIdentityStoreDefinition
-
Search base for looking up groups (e.g., "
ou=group,dc=eclipse,dc=net
"). - groupSearchFilter() - Method in annotation type jakarta.security.enterprise.identitystore.LdapIdentityStoreDefinition
-
Search filter to find groups when groupSearchBase is set.
- groupSearchScope() - Method in annotation type jakarta.security.enterprise.identitystore.LdapIdentityStoreDefinition
-
Search scope for group searches, determines depth of the search in the LDAP tree.
- groupSearchScopeExpression() - Method in annotation type jakarta.security.enterprise.identitystore.LdapIdentityStoreDefinition
-
Allow groupSearchScope to be specified as a Jakarta Expression Language expression.
- groupsQuery() - Method in annotation type jakarta.security.enterprise.identitystore.DatabaseIdentityStoreDefinition
-
SQL query to retrieve the groups associated with the caller when authentication succeeds.
H
- hasAccessToWebResource(String, String...) - Method in interface jakarta.security.enterprise.SecurityContext
-
Checks whether the caller has access to the provided "web resource" using the given methods, as specified by section 13.8 of the Servlet specification.
- hashAlgorithm() - Method in annotation type jakarta.security.enterprise.identitystore.DatabaseIdentityStoreDefinition
-
A
PasswordHash
implementation used to verify plaintext passwords by generating a hash of the password and comparing it against the hashed value returned from the database via theDatabaseIdentityStoreDefinition.callerQuery()
. - hashAlgorithmParameters() - Method in annotation type jakarta.security.enterprise.identitystore.DatabaseIdentityStoreDefinition
-
Used to specify algorithm-specific parameters.
- HttpAuthenticationMechanism - Interface in jakarta.security.enterprise.authentication.mechanism.http
-
HttpAuthenticationMechanism
is a mechanism for obtaining a caller's credentials in some way, using the HTTP protocol where necessary. - HttpMessageContext - Interface in jakarta.security.enterprise.authentication.mechanism.http
-
HttpMessageContext
contains all of the per-request state information and encapsulates the client request, server response, container handler for authentication callbacks, and the subject representing the caller. - HttpMessageContextWrapper - Class in jakarta.security.enterprise.authentication.mechanism.http
-
This class is an implementation of the HttpMessageContext interface that can be subclassed by developers wishing to provide extra or different functionality.
- HttpMessageContextWrapper(HttpMessageContext) - Constructor for class jakarta.security.enterprise.authentication.mechanism.http.HttpMessageContextWrapper
I
- IdentityStore - Interface in jakarta.security.enterprise.identitystore
-
IdentityStore
is a mechanism for validating a caller's credentials and accessing a caller's identity attributes. - IdentityStore.ValidationType - Enum in jakarta.security.enterprise.identitystore
-
Determines the type of validation (operations) that should be done by this store.
- IdentityStoreHandler - Interface in jakarta.security.enterprise.identitystore
-
IdentityStoreHandler
is a mechanism for validating a caller's credentials, and accessing a caller's identity attributes, by consulting a set of one or moreIdentityStore
s. - IdentityStorePermission - Class in jakarta.security.enterprise.identitystore
-
Class for IdentityStore permissions.
- IdentityStorePermission(String) - Constructor for class jakarta.security.enterprise.identitystore.IdentityStorePermission
-
Create an IdentityStorePermission with the specified name.
- IdentityStorePermission(String, String) - Constructor for class jakarta.security.enterprise.identitystore.IdentityStorePermission
-
Create an IdentityStorePermission with the specified name.
- initialize(Map<String, String>) - Method in interface jakarta.security.enterprise.identitystore.PasswordHash
-
Initialize the instance with the parameters it should use to generate and verify password hashes.
- INVALID - jakarta.security.enterprise.identitystore.CredentialValidationResult.Status
-
Indicates that the credential is not valid after a validation attempt.
- INVALID_RESULT - Static variable in class jakarta.security.enterprise.identitystore.CredentialValidationResult
- isAuthenticationRequest() - Method in interface jakarta.security.enterprise.authentication.mechanism.http.HttpMessageContext
-
Checks if the current call to an authentication mechanism is the result from the application calling
SecurityContext.authenticate(HttpServletRequest, HttpServletResponse, AuthenticationParameters)
- isAuthenticationRequest() - Method in class jakarta.security.enterprise.authentication.mechanism.http.HttpMessageContextWrapper
- isCallerInRole(String) - Method in interface jakarta.security.enterprise.SecurityContext
-
Checks whether the authenticated caller is included in the specified logical application "role".
- isCleared() - Method in class jakarta.security.enterprise.credential.AbstractClearableCredential
- isCleared() - Method in interface jakarta.security.enterprise.credential.Credential
-
Determines whether the credential value has been securely cleared.
- isNewAuthentication() - Method in class jakarta.security.enterprise.authentication.mechanism.http.AuthenticationParameters
-
Whether a new authentication dialog is required.
- isProtected() - Method in interface jakarta.security.enterprise.authentication.mechanism.http.HttpMessageContext
-
Checks if the currently requested resource is protected or not.
- isProtected() - Method in class jakarta.security.enterprise.authentication.mechanism.http.HttpMessageContextWrapper
- isRegisterSession() - Method in interface jakarta.security.enterprise.authentication.mechanism.http.HttpMessageContext
-
Check if the runtime has been asked to register an authentication session duing the current request.
- isRegisterSession() - Method in class jakarta.security.enterprise.authentication.mechanism.http.HttpMessageContextWrapper
- isRememberMe() - Method in class jakarta.security.enterprise.authentication.mechanism.http.AuthenticationParameters
-
Whether "remember me" should be used.
- isRememberMe() - Method in annotation type jakarta.security.enterprise.authentication.mechanism.http.RememberMe
-
Flag to determine if remember me should be used.
- isRememberMeExpression() - Method in annotation type jakarta.security.enterprise.authentication.mechanism.http.RememberMe
-
Jakarta Expression Language expression to determine if remember me should be used.
- isValid() - Method in interface jakarta.security.enterprise.credential.Credential
-
Determines whether the credential is valid.
J
- jakarta.security.enterprise - package jakarta.security.enterprise
-
The main Jakarta Security package.
- jakarta.security.enterprise.authentication.mechanism.http - package jakarta.security.enterprise.authentication.mechanism.http
-
The HTTP authentication mechanism API package.
- jakarta.security.enterprise.credential - package jakarta.security.enterprise.credential
-
The Identity Store Credential API package.
- jakarta.security.enterprise.identitystore - package jakarta.security.enterprise.identitystore
-
The identity store API package.
L
- LdapIdentityStoreDefinition - Annotation Type in jakarta.security.enterprise.identitystore
-
Annotation used to define a container-provided
IdentityStore
that stores caller credentials and identity attributes (together caller identities) in an LDAP store, and make that implementation available as an enabled CDI bean. - LdapIdentityStoreDefinition.LdapSearchScope - Enum in jakarta.security.enterprise.identitystore
-
Enum representing LDAP search scope values.
- loginPage() - Method in annotation type jakarta.security.enterprise.authentication.mechanism.http.LoginToContinue
-
The resource (page) a caller should get to see in case the originally requested resource requires authentication, and the caller is currently not authenticated.
- loginToContinue() - Method in annotation type jakarta.security.enterprise.authentication.mechanism.http.CustomFormAuthenticationMechanismDefinition
- loginToContinue() - Method in annotation type jakarta.security.enterprise.authentication.mechanism.http.FormAuthenticationMechanismDefinition
- LoginToContinue - Annotation Type in jakarta.security.enterprise.authentication.mechanism.http
-
The
LoginToContinue
annotation provides an application the ability to declaratively add login to continue functionality to an authentication mechanism.
M
- maxResults() - Method in annotation type jakarta.security.enterprise.identitystore.LdapIdentityStoreDefinition
-
Set the maximum number of results (objects) the server should return in response to a search.
- maxResultsExpression() - Method in annotation type jakarta.security.enterprise.identitystore.LdapIdentityStoreDefinition
-
Allow maxResults to be specified as Jakarta Expression Language expression.
N
- newAuthentication(boolean) - Method in class jakarta.security.enterprise.authentication.mechanism.http.AuthenticationParameters
-
Signal to the authentication mechanism responding to the authenticate call in which these AuthenticationParameters are passed, that an explicit new authentication dialog is required, as opposed to continuing a potentially existing one.
- NOT_DONE - jakarta.security.enterprise.AuthenticationStatus
-
The authentication mechanism was called, but decided not to authenticate.
- NOT_VALIDATED - jakarta.security.enterprise.identitystore.CredentialValidationResult.Status
-
Indicates that the credential could not be validated
- NOT_VALIDATED_RESULT - Static variable in class jakarta.security.enterprise.identitystore.CredentialValidationResult
- notifyContainerAboutLogin(CredentialValidationResult) - Method in interface jakarta.security.enterprise.authentication.mechanism.http.HttpMessageContext
-
Convenience method intended to pass the
CredentialValidationResult
result of an identity store directly on to the container. - notifyContainerAboutLogin(CredentialValidationResult) - Method in class jakarta.security.enterprise.authentication.mechanism.http.HttpMessageContextWrapper
- notifyContainerAboutLogin(String, Set<String>) - Method in interface jakarta.security.enterprise.authentication.mechanism.http.HttpMessageContext
-
Asks the container to register the given caller name and groups in order to make them available to the application for use with
SecurityContext.isCallerInRole(String)
etc. - notifyContainerAboutLogin(String, Set<String>) - Method in class jakarta.security.enterprise.authentication.mechanism.http.HttpMessageContextWrapper
- notifyContainerAboutLogin(Principal, Set<String>) - Method in interface jakarta.security.enterprise.authentication.mechanism.http.HttpMessageContext
-
Asks the container to register the given caller principal and groups in order to make them available to the application for use with
SecurityContext.isCallerInRole(String)
etc. - notifyContainerAboutLogin(Principal, Set<String>) - Method in class jakarta.security.enterprise.authentication.mechanism.http.HttpMessageContextWrapper
O
- ONE_LEVEL - jakarta.security.enterprise.identitystore.LdapIdentityStoreDefinition.LdapSearchScope
P
- Password - Class in jakarta.security.enterprise.credential
-
Represents a text-based password, and includes a built-in mechanism for securely clearing the value.
- Password(char[]) - Constructor for class jakarta.security.enterprise.credential.Password
-
Constructor
- Password(String) - Constructor for class jakarta.security.enterprise.credential.Password
-
Constructor
- PasswordHash - Interface in jakarta.security.enterprise.identitystore
-
PasswordHash
is an interface for objects that can generate and verify password hashes. - Pbkdf2PasswordHash - Interface in jakarta.security.enterprise.identitystore
-
This interface represents the built-in
Pbkdf2PasswordHash
implementation. - priority() - Method in annotation type jakarta.security.enterprise.identitystore.DatabaseIdentityStoreDefinition
-
Determines the order in case multiple IdentityStores are found.
- priority() - Method in interface jakarta.security.enterprise.identitystore.IdentityStore
-
Determines the order of invocation for multiple
IdentityStore
s. - priority() - Method in annotation type jakarta.security.enterprise.identitystore.LdapIdentityStoreDefinition
-
Determines the order in case multiple IdentityStores are found.
- priorityExpression() - Method in annotation type jakarta.security.enterprise.identitystore.DatabaseIdentityStoreDefinition
-
Allow
priority
to be specified as a Jakarta Expression Language expression. - priorityExpression() - Method in annotation type jakarta.security.enterprise.identitystore.LdapIdentityStoreDefinition
-
Allow priority to be specified as a Jakarta Expression Language expression.
- PROVIDE_GROUPS - jakarta.security.enterprise.identitystore.IdentityStore.ValidationType
-
Only groups for a principal, possibly established by another IdentityStore, are taken from this store.
R
- readTimeout() - Method in annotation type jakarta.security.enterprise.identitystore.LdapIdentityStoreDefinition
-
Set the timeout value that should be used when waiting for the LDAP server to return results.
- readTimeoutExpression() - Method in annotation type jakarta.security.enterprise.identitystore.LdapIdentityStoreDefinition
-
Allow readTimeout to be specified as an Jakarta Expression Language expression.
- realmName() - Method in annotation type jakarta.security.enterprise.authentication.mechanism.http.BasicAuthenticationMechanismDefinition
-
Name of realm that will be sent via the
WWW-Authenticate
header. - redirect(String) - Method in interface jakarta.security.enterprise.authentication.mechanism.http.HttpMessageContext
-
Sets the response status to SC_FOUND 302 (Found)
- redirect(String) - Method in class jakarta.security.enterprise.authentication.mechanism.http.HttpMessageContextWrapper
- rememberMe(boolean) - Method in class jakarta.security.enterprise.authentication.mechanism.http.AuthenticationParameters
-
Signals that for this call to the authentication mechanism "remember me" should be applied, IFF the "remember me" feature is configured for the authentication mechanism responding to the authenticate call.
- RememberMe - Annotation Type in jakarta.security.enterprise.authentication.mechanism.http
-
The RememberMe annotation provides an application the ability to declaratively designate that an authentication mechanism effectively "remembers" the authentication and auto applies this with every request.
- RememberMeCredential - Class in jakarta.security.enterprise.credential
-
RememberMeCredential
represents a credential presented as a token, for the explicit usage with the Jakarta Security provided remember me function. - RememberMeCredential(String) - Constructor for class jakarta.security.enterprise.credential.RememberMeCredential
-
Constructor
- RememberMeIdentityStore - Interface in jakarta.security.enterprise.identitystore
-
RememberMeIdentityStore
is a mechanism for validating a caller's credentials and accessing a caller's identity attributes that's specifically tailored for the "remember me" feature. - removeLoginToken(String) - Method in interface jakarta.security.enterprise.identitystore.RememberMeIdentityStore
-
Dissociates the principal and groups that were associated with the token before and removes the token itself.
- responseNotFound() - Method in interface jakarta.security.enterprise.authentication.mechanism.http.HttpMessageContext
-
Sets the response status to 404 (not found).
- responseNotFound() - Method in class jakarta.security.enterprise.authentication.mechanism.http.HttpMessageContextWrapper
- responseUnauthorized() - Method in interface jakarta.security.enterprise.authentication.mechanism.http.HttpMessageContext
-
Sets the response status to 401 (unauthorized).
- responseUnauthorized() - Method in class jakarta.security.enterprise.authentication.mechanism.http.HttpMessageContextWrapper
S
- secureResponse(HttpServletRequest, HttpServletResponse, HttpMessageContext) - Method in interface jakarta.security.enterprise.authentication.mechanism.http.HttpAuthenticationMechanism
-
Secure the response, optionally.
- SecurityContext - Interface in jakarta.security.enterprise
-
The SecurityContext provides an access point for programmatic security; an injectable type that is intended to be used by application code to query and interact with Jakarta Security.
- SEND_CONTINUE - jakarta.security.enterprise.AuthenticationStatus
-
The authentication mechanism was called and a multi-step authentication dialog with the caller has been started (for instance, the caller has been redirected to a login page).
- SEND_FAILURE - jakarta.security.enterprise.AuthenticationStatus
-
The authentication mechanism was called but the caller was not successfully authenticated and therefore the caller principal will not be made available.
- setCleared() - Method in class jakarta.security.enterprise.credential.AbstractClearableCredential
-
Specifies that the credential value has been securely cleared.
- setCredential(Credential) - Method in class jakarta.security.enterprise.authentication.mechanism.http.AuthenticationParameters
-
Sets the credential as parameter in this instance.
- setNewAuthentication(boolean) - Method in class jakarta.security.enterprise.authentication.mechanism.http.AuthenticationParameters
-
Sets whether a new authentication dialog is required.
- setRegisterSession(String, Set<String>) - Method in interface jakarta.security.enterprise.authentication.mechanism.http.HttpMessageContext
-
Asks the runtime to register an authentication session.
- setRegisterSession(String, Set<String>) - Method in class jakarta.security.enterprise.authentication.mechanism.http.HttpMessageContextWrapper
- setRememberMe(boolean) - Method in class jakarta.security.enterprise.authentication.mechanism.http.AuthenticationParameters
-
Sets whether "remember me" should be used.
- setRequest(HttpServletRequest) - Method in interface jakarta.security.enterprise.authentication.mechanism.http.HttpMessageContext
-
Sets the request object.
- setRequest(HttpServletRequest) - Method in class jakarta.security.enterprise.authentication.mechanism.http.HttpMessageContextWrapper
- setResponse(HttpServletResponse) - Method in interface jakarta.security.enterprise.authentication.mechanism.http.HttpMessageContext
-
Set the response object.
- setResponse(HttpServletResponse) - Method in class jakarta.security.enterprise.authentication.mechanism.http.HttpMessageContextWrapper
- SUBTREE - jakarta.security.enterprise.identitystore.LdapIdentityStoreDefinition.LdapSearchScope
- SUCCESS - jakarta.security.enterprise.AuthenticationStatus
-
The authentication mechanism was called and the caller was successfully authenticated.
U
- url() - Method in annotation type jakarta.security.enterprise.identitystore.LdapIdentityStoreDefinition
-
URL where the LDAP server can be reached.
- useFor() - Method in annotation type jakarta.security.enterprise.identitystore.DatabaseIdentityStoreDefinition
-
Determines what the identity store is used for
- useFor() - Method in annotation type jakarta.security.enterprise.identitystore.LdapIdentityStoreDefinition
-
Determines what the identity store is used for
- useForExpression() - Method in annotation type jakarta.security.enterprise.identitystore.DatabaseIdentityStoreDefinition
-
Allow
useFor
to be specified as an Jakarta Expression Language expression. - useForExpression() - Method in annotation type jakarta.security.enterprise.identitystore.LdapIdentityStoreDefinition
-
Allow useFor to be specified as a Jakarta Expression Language expression.
- useForwardToLogin() - Method in annotation type jakarta.security.enterprise.authentication.mechanism.http.LoginToContinue
-
Use a forward to reach the page set by the
LoginToContinue.loginPage()
if true, otherwise use a redirect. - useForwardToLoginExpression() - Method in annotation type jakarta.security.enterprise.authentication.mechanism.http.LoginToContinue
-
Jakarta Expression Language expression variant of
useForwardToLogin()
. - UsernamePasswordCredential - Class in jakarta.security.enterprise.credential
-
Represents the credentials typically used by standard caller name/password authentication.
- UsernamePasswordCredential(String, Password) - Constructor for class jakarta.security.enterprise.credential.UsernamePasswordCredential
-
Constructor.
- UsernamePasswordCredential(String, String) - Constructor for class jakarta.security.enterprise.credential.UsernamePasswordCredential
-
Constructor.
V
- VALID - jakarta.security.enterprise.identitystore.CredentialValidationResult.Status
-
Indicates that the credential is valid after a validation attempt.
- validate(Credential) - Method in interface jakarta.security.enterprise.identitystore.IdentityStore
-
Validates the given credential.
- validate(Credential) - Method in interface jakarta.security.enterprise.identitystore.IdentityStoreHandler
-
Validate the given
Credential
and return the identity and attributes of the caller it represents. - validate(RememberMeCredential) - Method in interface jakarta.security.enterprise.identitystore.RememberMeIdentityStore
-
Validates the given credential.
- VALIDATE - jakarta.security.enterprise.identitystore.IdentityStore.ValidationType
-
Only validation is performed, so no groups, are taken from this store.
- validateRequest(HttpServletRequest, HttpServletResponse, HttpMessageContext) - Method in interface jakarta.security.enterprise.authentication.mechanism.http.HttpAuthenticationMechanism
-
Authenticate an HTTP request.
- validationTypes() - Method in interface jakarta.security.enterprise.identitystore.IdentityStore
-
Determines the type of validation the
IdentityStore
should be used for. - valueOf(String) - Static method in enum jakarta.security.enterprise.AuthenticationStatus
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum jakarta.security.enterprise.identitystore.CredentialValidationResult.Status
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum jakarta.security.enterprise.identitystore.IdentityStore.ValidationType
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum jakarta.security.enterprise.identitystore.LdapIdentityStoreDefinition.LdapSearchScope
-
Returns the enum constant of this type with the specified name.
- values() - Static method in enum jakarta.security.enterprise.AuthenticationStatus
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum jakarta.security.enterprise.identitystore.CredentialValidationResult.Status
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum jakarta.security.enterprise.identitystore.IdentityStore.ValidationType
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum jakarta.security.enterprise.identitystore.LdapIdentityStoreDefinition.LdapSearchScope
-
Returns an array containing the constants of this enum type, in the order they are declared.
- verify(char[], String) - Method in interface jakarta.security.enterprise.identitystore.PasswordHash
-
Verify a password against the hashed password value retrieved from a user's account.
W
- withParams() - Static method in class jakarta.security.enterprise.authentication.mechanism.http.AuthenticationParameters
-
Creates a new instance of AuthenticationParameters, useful for a fluent/builder style creation of parameters.
- withRequest(HttpServletRequest) - Method in interface jakarta.security.enterprise.authentication.mechanism.http.HttpMessageContext
-
Sets the request object.
- withRequest(HttpServletRequest) - Method in class jakarta.security.enterprise.authentication.mechanism.http.HttpMessageContextWrapper
All Classes All Packages