Uses of Interface
org.apache.shiro.authc.AuthenticationInfo

Packages that use AuthenticationInfo

Package	Description
org.apache.shiro.authc	Core interfaces and exceptions concerning Authentication (the act of logging-in).
org.apache.shiro.authc.credential	Support for validating credentials (such as passwords or X509 certificates) during authentication via the CredentialsMatcher interface and its supporting implementations.
org.apache.shiro.authc.pam	Support for PAM, or Pluggable Authentication Modules, which is the capability to authenticate a user against multiple configurable (pluggable) modules (Shiro calls these Realms).
org.apache.shiro.mgt	Provides the master SecurityManager interface and a default implementation hierarchy for managing all aspects of Shiro's functionality in an application.
org.apache.shiro.realm	Components and sub-packages used in supporting the core Realm interface.
org.apache.shiro.realm.activedirectory	Realms that acquire security data from a Microsoft Active Directory.
org.apache.shiro.realm.jdbc	Realms that acquire security data from an RDBMS (Relational Database Management System) using the JDBC API.
org.apache.shiro.realm.ldap	Realms that acquire security data from an LDAP (Lightweight Directory Access Protocol) server utilizing LDAP/Naming APIs.
org.apache.shiro.subject	Components supporting the Subject interface, the most important concept in Shiro's API.
org.apache.shiro.subject.support	Concrete support implementations of most of the org.apache.shiro.subject interfaces.

Uses of AuthenticationInfo in org.apache.shiro.authc

Subinterfaces of AuthenticationInfo in org.apache.shiro.authc

Modifier and Type	Interface	Description
interface	Account	An Account is a convenience interface that extends both AuthenticationInfo and AuthorizationInfo and represents authentication and authorization for a single account in a single Realm.
interface	MergableAuthenticationInfo	An extension of the AuthenticationInfo interface to be implemented by classes that support merging with other AuthenticationInfo instances.
interface	SaltedAuthenticationInfo	Interface representing account information that may use a salt when hashing credentials.

Classes in org.apache.shiro.authc that implement AuthenticationInfo

Modifier and Type	Class	Description
class	SimpleAccount	Simple implementation of the Account interface that contains principal and credential and authorization information (roles and permissions) as instance variables and exposes them via getters and setters using standard JavaBean notation.
class	SimpleAuthenticationInfo	Simple implementation of the MergableAuthenticationInfo interface that holds the principals and credentials.

Methods in org.apache.shiro.authc that return AuthenticationInfo

Modifier and Type	Method	Description
final AuthenticationInfo	AbstractAuthenticator.authenticate(AuthenticationToken token)	Implementation of the Authenticator interface that functions in the following manner: Calls template doAuthenticate method for subclass execution of the actual authentication behavior. If an AuthenticationException is thrown during doAuthenticate, notify any registered AuthenticationListeners of the exception and then propagate the exception for the caller to handle. If no exception is thrown (indicating a successful login), notify any registered AuthenticationListeners of the successful attempt. Return the AuthenticationInfo
AuthenticationInfo	Authenticator.authenticate(AuthenticationToken authenticationToken)	Authenticates a user based on the submitted AuthenticationToken.
protected abstract AuthenticationInfo	AbstractAuthenticator.doAuthenticate(AuthenticationToken token)	Template design pattern hook for subclasses to implement specific authentication behavior.

Methods in org.apache.shiro.authc with parameters of type AuthenticationInfo

Modifier and Type	Method	Description
void	MergableAuthenticationInfo.merge(AuthenticationInfo info)	Merges the given AuthenticationInfo into this instance.
void	SimpleAccount.merge(AuthenticationInfo info)	Merges the specified AuthenticationInfo into this Account.
void	SimpleAuthenticationInfo.merge(AuthenticationInfo info)	Takes the specified info argument and adds its principals and credentials into this instance.
protected void	AbstractAuthenticator.notifySuccess(AuthenticationToken token, AuthenticationInfo info)	Notifies any registered AuthenticationListeners that authentication was successful for the specified token which resulted in the specified info.
void	AuthenticationListener.onSuccess(AuthenticationToken token, AuthenticationInfo info)	Callback triggered when an authentication attempt for a Subject has succeeded.

Uses of AuthenticationInfo in org.apache.shiro.authc.credential

Methods in org.apache.shiro.authc.credential with parameters of type AuthenticationInfo

Modifier and Type	Method	Description
boolean	AllowAllCredentialsMatcher.doCredentialsMatch(AuthenticationToken token, AuthenticationInfo info)	Returns true always no matter what the method arguments are.
boolean	CredentialsMatcher.doCredentialsMatch(AuthenticationToken token, AuthenticationInfo info)	Returns true if the provided token credentials match the stored account credentials, false otherwise.
boolean	HashedCredentialsMatcher.doCredentialsMatch(AuthenticationToken token, AuthenticationInfo info)	This implementation first hashes the token's credentials, potentially using a salt if the info argument is a SaltedAuthenticationInfo.
boolean	PasswordMatcher.doCredentialsMatch(AuthenticationToken token, AuthenticationInfo info)
boolean	SimpleCredentialsMatcher.doCredentialsMatch(AuthenticationToken token, AuthenticationInfo info)	This implementation acquires the token's credentials (via getCredentials(token)) and then the account's credentials (via getCredentials(account)) and then passes both of them to the equals(tokenCredentials, accountCredentials) method for equality comparison.
protected Object	HashedCredentialsMatcher.getCredentials(AuthenticationInfo info)	Returns a Hash instance representing the already-hashed AuthenticationInfo credentials stored in the system.
protected Object	SimpleCredentialsMatcher.getCredentials(AuthenticationInfo info)	Returns the account's credentials.
protected Object	PasswordMatcher.getStoredPassword(AuthenticationInfo storedAccountInfo)
protected Object	HashedCredentialsMatcher.hashProvidedCredentials(AuthenticationToken token, AuthenticationInfo info)	Hash the provided token's credentials using the salt stored with the account if the info instance is an instanceof SaltedAuthenticationInfo (see the class-level JavaDoc for why this is the preferred approach).

Uses of AuthenticationInfo in org.apache.shiro.authc.pam

Methods in org.apache.shiro.authc.pam that return AuthenticationInfo

Modifier and Type	Method	Description
AuthenticationInfo	AbstractAuthenticationStrategy.afterAllAttempts(AuthenticationToken token, AuthenticationInfo aggregate)	Simply returns the aggregate argument without modification.
AuthenticationInfo	AtLeastOneSuccessfulStrategy.afterAllAttempts(AuthenticationToken token, AuthenticationInfo aggregate)	Ensures that the aggregate method argument is not null and aggregate.getPrincipals() is not null, and if either is null, throws an AuthenticationException to indicate that none of the realms authenticated successfully.
AuthenticationInfo	AuthenticationStrategy.afterAllAttempts(AuthenticationToken token, AuthenticationInfo aggregate)	Method invoked by the ModularAuthenticator signifying that all of its configured Realms have been consulted for account data, allowing post-processing after all realms have completed.
AuthenticationInfo	AbstractAuthenticationStrategy.afterAttempt(Realm realm, AuthenticationToken token, AuthenticationInfo singleRealmInfo, AuthenticationInfo aggregateInfo, Throwable t)	Base implementation that will aggregate the specified singleRealmInfo into the aggregateInfo and then returns the aggregate.
AuthenticationInfo	AllSuccessfulStrategy.afterAttempt(Realm realm, AuthenticationToken token, AuthenticationInfo info, AuthenticationInfo aggregate, Throwable t)	Merges the specified info into the aggregate argument and returns it (just as the parent implementation does), but additionally ensures the following: if the Throwable argument is not null, re-throws it to immediately cancel the authentication process, since this strategy requires all realms to authenticate successfully. neither the info or aggregate argument is null to ensure that each realm did in fact authenticate successfully
AuthenticationInfo	AuthenticationStrategy.afterAttempt(Realm realm, AuthenticationToken token, AuthenticationInfo singleRealmInfo, AuthenticationInfo aggregateInfo, Throwable t)	Method invoked by the ModularAuthenticator just after the given realm has been consulted for authentication, allowing post-authentication-attempt logic for that realm only.
AuthenticationInfo	AbstractAuthenticationStrategy.beforeAllAttempts(Collection<? extends Realm> realms, AuthenticationToken token)	Simply returns new SimpleAuthenticationInfo();, which supports aggregating account data across realms.
AuthenticationInfo	AuthenticationStrategy.beforeAllAttempts(Collection<? extends Realm> realms, AuthenticationToken token)	Method invoked by the ModularAuthenticator signifying that the authentication process is about to begin for the specified token - called before any Realm is actually invoked.
AuthenticationInfo	FirstSuccessfulStrategy.beforeAllAttempts(Collection<? extends Realm> realms, AuthenticationToken token)	Returns null immediately, relying on this class's merge implementation to return only the first info object it encounters, ignoring all subsequent ones.
AuthenticationInfo	AbstractAuthenticationStrategy.beforeAttempt(Realm realm, AuthenticationToken token, AuthenticationInfo aggregate)	Simply returns the aggregate method argument, without modification.
AuthenticationInfo	AllSuccessfulStrategy.beforeAttempt(Realm realm, AuthenticationToken token, AuthenticationInfo info)	Because all realms in this strategy must complete successfully, this implementation ensures that the given Realm supports the given token argument.
AuthenticationInfo	AuthenticationStrategy.beforeAttempt(Realm realm, AuthenticationToken token, AuthenticationInfo aggregate)	Method invoked by the ModularAuthenticator just prior to the realm being consulted for account data, allowing pre-authentication-attempt logic for that realm only.
AuthenticationInfo	FirstSuccessfulStrategy.beforeAttempt(Realm realm, AuthenticationToken token, AuthenticationInfo aggregate)	Throws ShortCircuitIterationException if stopAfterFirstSuccess is set and authentication is successful with a previously consulted realm.
protected AuthenticationInfo	ModularRealmAuthenticator.doAuthenticate(AuthenticationToken authenticationToken)	Attempts to authenticate the given token by iterating over the internal collection of Realms.
protected AuthenticationInfo	ModularRealmAuthenticator.doMultiRealmAuthentication(Collection<Realm> realms, AuthenticationToken token)	Performs the multi-realm authentication attempt by calling back to a AuthenticationStrategy object as each realm is consulted for AuthenticationInfo for the specified token.
protected AuthenticationInfo	ModularRealmAuthenticator.doSingleRealmAuthentication(Realm realm, AuthenticationToken token)	Performs the authentication attempt by interacting with the single configured realm, which is significantly simpler than performing multi-realm logic.
protected AuthenticationInfo	AbstractAuthenticationStrategy.merge(AuthenticationInfo info, AuthenticationInfo aggregate)	Merges the specified info argument into the aggregate argument and then returns an aggregate for continued use throughout the login process.
protected AuthenticationInfo	FirstSuccessfulStrategy.merge(AuthenticationInfo info, AuthenticationInfo aggregate)	Returns the specified aggregate instance if is non null and valid (that is, has principals and they are not empty) immediately, or, if it is null or not valid, the info argument is returned instead.

Methods in org.apache.shiro.authc.pam with parameters of type AuthenticationInfo

Modifier and Type	Method	Description
AuthenticationInfo	AbstractAuthenticationStrategy.afterAllAttempts(AuthenticationToken token, AuthenticationInfo aggregate)	Simply returns the aggregate argument without modification.
AuthenticationInfo	AtLeastOneSuccessfulStrategy.afterAllAttempts(AuthenticationToken token, AuthenticationInfo aggregate)	Ensures that the aggregate method argument is not null and aggregate.getPrincipals() is not null, and if either is null, throws an AuthenticationException to indicate that none of the realms authenticated successfully.
AuthenticationInfo	AuthenticationStrategy.afterAllAttempts(AuthenticationToken token, AuthenticationInfo aggregate)	Method invoked by the ModularAuthenticator signifying that all of its configured Realms have been consulted for account data, allowing post-processing after all realms have completed.
AuthenticationInfo	AbstractAuthenticationStrategy.afterAttempt(Realm realm, AuthenticationToken token, AuthenticationInfo singleRealmInfo, AuthenticationInfo aggregateInfo, Throwable t)	Base implementation that will aggregate the specified singleRealmInfo into the aggregateInfo and then returns the aggregate.
AuthenticationInfo	AllSuccessfulStrategy.afterAttempt(Realm realm, AuthenticationToken token, AuthenticationInfo info, AuthenticationInfo aggregate, Throwable t)	Merges the specified info into the aggregate argument and returns it (just as the parent implementation does), but additionally ensures the following: if the Throwable argument is not null, re-throws it to immediately cancel the authentication process, since this strategy requires all realms to authenticate successfully. neither the info or aggregate argument is null to ensure that each realm did in fact authenticate successfully
AuthenticationInfo	AuthenticationStrategy.afterAttempt(Realm realm, AuthenticationToken token, AuthenticationInfo singleRealmInfo, AuthenticationInfo aggregateInfo, Throwable t)	Method invoked by the ModularAuthenticator just after the given realm has been consulted for authentication, allowing post-authentication-attempt logic for that realm only.
AuthenticationInfo	AbstractAuthenticationStrategy.beforeAttempt(Realm realm, AuthenticationToken token, AuthenticationInfo aggregate)	Simply returns the aggregate method argument, without modification.
AuthenticationInfo	AllSuccessfulStrategy.beforeAttempt(Realm realm, AuthenticationToken token, AuthenticationInfo info)	Because all realms in this strategy must complete successfully, this implementation ensures that the given Realm supports the given token argument.
AuthenticationInfo	AuthenticationStrategy.beforeAttempt(Realm realm, AuthenticationToken token, AuthenticationInfo aggregate)	Method invoked by the ModularAuthenticator just prior to the realm being consulted for account data, allowing pre-authentication-attempt logic for that realm only.
AuthenticationInfo	FirstSuccessfulStrategy.beforeAttempt(Realm realm, AuthenticationToken token, AuthenticationInfo aggregate)	Throws ShortCircuitIterationException if stopAfterFirstSuccess is set and authentication is successful with a previously consulted realm.
protected AuthenticationInfo	AbstractAuthenticationStrategy.merge(AuthenticationInfo info, AuthenticationInfo aggregate)	Merges the specified info argument into the aggregate argument and then returns an aggregate for continued use throughout the login process.
protected AuthenticationInfo	FirstSuccessfulStrategy.merge(AuthenticationInfo info, AuthenticationInfo aggregate)	Returns the specified aggregate instance if is non null and valid (that is, has principals and they are not empty) immediately, or, if it is null or not valid, the info argument is returned instead.

Uses of AuthenticationInfo in org.apache.shiro.mgt

Methods in org.apache.shiro.mgt that return AuthenticationInfo

Modifier and Type	Method	Description
AuthenticationInfo	AuthenticatingSecurityManager.authenticate(AuthenticationToken token)	Delegates to the wrapped Authenticator for authentication.

Methods in org.apache.shiro.mgt with parameters of type AuthenticationInfo

Modifier and Type	Method	Description
protected Subject	DefaultSecurityManager.createSubject(AuthenticationToken token, AuthenticationInfo info, Subject existing)	Creates a Subject instance for the user represented by the given method arguments.
protected PrincipalCollection	AbstractRememberMeManager.getIdentityToRemember(Subject subject, AuthenticationInfo info)	Returns info.getPrincipals() and ignores the Subject argument.
void	AbstractRememberMeManager.onSuccessfulLogin(Subject subject, AuthenticationToken token, AuthenticationInfo info)	Reacts to the successful login attempt by first always forgetting any previously stored identity.
protected void	DefaultSecurityManager.onSuccessfulLogin(AuthenticationToken token, AuthenticationInfo info, Subject subject)
void	RememberMeManager.onSuccessfulLogin(Subject subject, AuthenticationToken token, AuthenticationInfo info)	Reacts to a successful authentication attempt, typically saving the principals to be retrieved ('remembered') for future system access.
void	AbstractRememberMeManager.rememberIdentity(Subject subject, AuthenticationToken token, AuthenticationInfo authcInfo)	Remembers a subject-unique identity for retrieval later.
protected void	DefaultSecurityManager.rememberMeSuccessfulLogin(AuthenticationToken token, AuthenticationInfo info, Subject subject)

Uses of AuthenticationInfo in org.apache.shiro.realm

Methods in org.apache.shiro.realm that return AuthenticationInfo

Modifier and Type	Method	Description
protected abstract AuthenticationInfo	AuthenticatingRealm.doGetAuthenticationInfo(AuthenticationToken token)	Retrieves authentication data from an implementation-specific datasource (RDBMS, LDAP, etc.) for the given authentication token.
protected AuthenticationInfo	SimpleAccountRealm.doGetAuthenticationInfo(AuthenticationToken token)
final AuthenticationInfo	AuthenticatingRealm.getAuthenticationInfo(AuthenticationToken token)	This implementation functions as follows: It attempts to acquire any cached AuthenticationInfo corresponding to the specified AuthenticationToken argument.
AuthenticationInfo	Realm.getAuthenticationInfo(AuthenticationToken token)	Returns an account's authentication-specific information for the specified token, or null if no account could be found based on the token.

Methods in org.apache.shiro.realm that return types with arguments of type AuthenticationInfo

Modifier and Type	Method	Description
org.apache.shiro.cache.Cache<Object,AuthenticationInfo>	AuthenticatingRealm.getAuthenticationCache()	Returns a Cache instance to use for authentication caching, or null if no cache has been set.

Methods in org.apache.shiro.realm with parameters of type AuthenticationInfo

Modifier and Type	Method	Description
protected void	AuthenticatingRealm.assertCredentialsMatch(AuthenticationToken token, AuthenticationInfo info)	Asserts that the submitted AuthenticationToken's credentials match the stored account AuthenticationInfo's credentials, and if not, throws an AuthenticationException.
protected boolean	AuthenticatingRealm.isAuthenticationCachingEnabled(AuthenticationToken token, AuthenticationInfo info)	Returns true if authentication caching should be utilized based on the specified AuthenticationToken and/or AuthenticationInfo, false otherwise.

Method parameters in org.apache.shiro.realm with type arguments of type AuthenticationInfo

Modifier and Type	Method	Description
void	AuthenticatingRealm.setAuthenticationCache(org.apache.shiro.cache.Cache<Object,AuthenticationInfo> authenticationCache)	Sets an explicit Cache instance to use for authentication caching.

Uses of AuthenticationInfo in org.apache.shiro.realm.activedirectory

Methods in org.apache.shiro.realm.activedirectory that return AuthenticationInfo

Modifier and Type	Method	Description
protected AuthenticationInfo	ActiveDirectoryRealm.buildAuthenticationInfo(String username, char[] password)
protected AuthenticationInfo	ActiveDirectoryRealm.queryForAuthenticationInfo(AuthenticationToken token, LdapContextFactory ldapContextFactory)	Builds an AuthenticationInfo object by querying the active directory LDAP context for the specified username.

Uses of AuthenticationInfo in org.apache.shiro.realm.jdbc

Methods in org.apache.shiro.realm.jdbc that return AuthenticationInfo

Modifier and Type	Method	Description
protected AuthenticationInfo	JdbcRealm.doGetAuthenticationInfo(AuthenticationToken token)

Uses of AuthenticationInfo in org.apache.shiro.realm.ldap

Methods in org.apache.shiro.realm.ldap that return AuthenticationInfo

Modifier and Type	Method	Description
protected AuthenticationInfo	DefaultLdapRealm.createAuthenticationInfo(AuthenticationToken token, Object ldapPrincipal, Object ldapCredentials, LdapContext ldapContext)	Returns the AuthenticationInfo resulting from a Subject's successful LDAP authentication attempt.
protected AuthenticationInfo	AbstractLdapRealm.doGetAuthenticationInfo(AuthenticationToken token)
protected AuthenticationInfo	DefaultLdapRealm.doGetAuthenticationInfo(AuthenticationToken token)	Delegates to DefaultLdapRealm.queryForAuthenticationInfo(org.apache.shiro.authc.AuthenticationToken, LdapContextFactory), wrapping any NamingExceptions in a Shiro AuthenticationException to satisfy the parent method signature.
protected abstract AuthenticationInfo	AbstractLdapRealm.queryForAuthenticationInfo(AuthenticationToken token, LdapContextFactory ldapContextFactory)	Abstract method that should be implemented by subclasses to builds an AuthenticationInfo object by querying the LDAP context for the specified username.
protected AuthenticationInfo	DefaultLdapRealm.queryForAuthenticationInfo(AuthenticationToken token, LdapContextFactory ldapContextFactory)	This implementation opens an LDAP connection using the token's discovered principal and provided credentials.

Uses of AuthenticationInfo in org.apache.shiro.subject

Methods in org.apache.shiro.subject that return AuthenticationInfo

Modifier and Type	Method	Description
AuthenticationInfo	SubjectContext.getAuthenticationInfo()

Methods in org.apache.shiro.subject with parameters of type AuthenticationInfo

Modifier and Type	Method	Description
void	SubjectContext.setAuthenticationInfo(AuthenticationInfo info)

Uses of AuthenticationInfo in org.apache.shiro.subject.support

Methods in org.apache.shiro.subject.support that return AuthenticationInfo

Modifier and Type	Method	Description
AuthenticationInfo	DefaultSubjectContext.getAuthenticationInfo()

Methods in org.apache.shiro.subject.support with parameters of type AuthenticationInfo

Modifier and Type	Method	Description
void	DefaultSubjectContext.setAuthenticationInfo(AuthenticationInfo info)