A B C D E F G H I J K L M N O P Q R S T U V W X _

A

AbstractAuthenticationStrategy - Class in org.apache.shiro.authc.pam
Abstract base implementation for Shiro's concrete AuthenticationStrategy implementations.
AbstractAuthenticationStrategy() - Constructor for class org.apache.shiro.authc.pam.AbstractAuthenticationStrategy
 
AbstractAuthenticator - Class in org.apache.shiro.authc
Superclass for almost all Authenticator implementations that performs the common work around authentication attempts.
AbstractAuthenticator() - Constructor for class org.apache.shiro.authc.AbstractAuthenticator
Default no-argument constructor.
AbstractCacheManager - Class in org.apache.shiro.cache
Very simple abstract CacheManager implementation that retains all created Cache instances in an in-memory ConcurrentMap.
AbstractCacheManager() - Constructor for class org.apache.shiro.cache.AbstractCacheManager
Default no-arg constructor that instantiates an internal name-to-cache ConcurrentMap.
AbstractFactory<T> - Class in org.apache.shiro.util
TODO - Class JavaDoc
AbstractFactory() - Constructor for class org.apache.shiro.util.AbstractFactory
 
AbstractFilter - Class in org.apache.shiro.web.servlet
Base abstract Filter simplifying Filter initialization and access to init parameters.
AbstractFilter() - Constructor for class org.apache.shiro.web.servlet.AbstractFilter
 
AbstractHash - Class in org.apache.shiro.crypto.hash
Deprecated. in Shiro 1.1 in favor of using the concrete SimpleHash implementation directly.
AbstractHash() - Constructor for class org.apache.shiro.crypto.hash.AbstractHash
Deprecated. Creates an new instance without any of its properties set (no hashing is performed).
AbstractHash(Object) - Constructor for class org.apache.shiro.crypto.hash.AbstractHash
Deprecated. Creates a hash of the specified source with no salt using a single hash iteration.
AbstractHash(Object, Object) - Constructor for class org.apache.shiro.crypto.hash.AbstractHash
Deprecated. Creates a hash of the specified source using the given salt using a single hash iteration.
AbstractHash(Object, Object, int) - Constructor for class org.apache.shiro.crypto.hash.AbstractHash
Deprecated. Creates a hash of the specified source using the given salt a total of hashIterations times.
AbstractLdapRealm - Class in org.apache.shiro.realm.ldap
A Realm that authenticates with an LDAP server to build the Subject for a user.
AbstractLdapRealm() - Constructor for class org.apache.shiro.realm.ldap.AbstractLdapRealm
 
AbstractNativeSessionManager - Class in org.apache.shiro.session.mgt
Abstract implementation supporting the NativeSessionManager interface, supporting SessionListeners and application of the globalSessionTimeout.
AbstractNativeSessionManager() - Constructor for class org.apache.shiro.session.mgt.AbstractNativeSessionManager
 
AbstractRememberMeManager - Class in org.apache.shiro.mgt
Abstract implementation of the RememberMeManager interface that handles serialization and encryption of the remembered user identity.
AbstractRememberMeManager() - Constructor for class org.apache.shiro.mgt.AbstractRememberMeManager
Default constructor that initializes a DefaultSerializer as the serializer and an AesCipherService as the cipherService.
AbstractSessionDAO - Class in org.apache.shiro.session.mgt.eis
An abstract SessionDAO implementation that performs some sanity checks on session creation and reading and allows for pluggable Session ID generation strategies if desired.
AbstractSessionDAO() - Constructor for class org.apache.shiro.session.mgt.eis.AbstractSessionDAO
Default no-arg constructor that defaults the sessionIdGenerator to be a JavaUuidSessionIdGenerator.
AbstractSessionManager - Class in org.apache.shiro.session.mgt
Base abstract class of the SessionManager interface, enabling configuration of an application-wide globalSessionTimeout.
AbstractSessionManager() - Constructor for class org.apache.shiro.session.mgt.AbstractSessionManager
 
AbstractShiroFilter - Class in org.apache.shiro.web.servlet
Abstract base class that provides all standard Shiro request filtering behavior and expects subclasses to implement configuration-specific logic (INI, XML, .properties, etc).
AbstractShiroFilter() - Constructor for class org.apache.shiro.web.servlet.AbstractShiroFilter
 
AbstractSymmetricCipherService - Class in org.apache.shiro.crypto
Base abstract class for supporting symmetric key cipher algorithms.
AbstractSymmetricCipherService(String) - Constructor for class org.apache.shiro.crypto.AbstractSymmetricCipherService
 
AbstractValidatingSessionManager - Class in org.apache.shiro.session.mgt
Default business-tier implementation of the ValidatingSessionManager interface.
AbstractValidatingSessionManager() - Constructor for class org.apache.shiro.session.mgt.AbstractValidatingSessionManager
 
AccessControlFilter - Class in org.apache.shiro.web.filter
Superclass for any filter that controls access to a resource and may redirect the user to the login page if they are not authenticated.
AccessControlFilter() - Constructor for class org.apache.shiro.web.filter.AccessControlFilter
 
Account - Interface in org.apache.shiro.authc
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.
AccountException - Exception in org.apache.shiro.authc
Exception thrown due to a problem with the account under which an authentication attempt is being executed.
AccountException() - Constructor for exception org.apache.shiro.authc.AccountException
Creates a new AccountException.
AccountException(String) - Constructor for exception org.apache.shiro.authc.AccountException
Constructs a new AccountException.
AccountException(Throwable) - Constructor for exception org.apache.shiro.authc.AccountException
Constructs a new AccountException.
AccountException(String, Throwable) - Constructor for exception org.apache.shiro.authc.AccountException
Constructs a new AccountException.
accountExists(String) - Method in class org.apache.shiro.realm.SimpleAccountRealm
 
ACTIVE_SESSION_CACHE_NAME - Static variable in class org.apache.shiro.session.mgt.eis.CachingSessionDAO
The default active sessions cache name, equal to shiro-activeSessionCache.
ActiveDirectoryRealm - Class in org.apache.shiro.realm.activedirectory
A Realm that authenticates with an active directory LDAP server to determine the roles for a particular user.
ActiveDirectoryRealm() - Constructor for class org.apache.shiro.realm.activedirectory.ActiveDirectoryRealm
 
add(Permission) - Method in class org.apache.shiro.authz.SimpleRole
 
add(Destroyable) - Method in class org.apache.shiro.guice.ShiroModule
 
add(SimpleAccount) - Method in class org.apache.shiro.realm.SimpleAccountRealm
 
add(SimpleRole) - Method in class org.apache.shiro.realm.SimpleAccountRealm
 
add(Object, String) - Method in interface org.apache.shiro.subject.MutablePrincipalCollection
Adds the given principal to this collection.
add(Object, String) - Method in class org.apache.shiro.subject.SimplePrincipalCollection
 
add(Filter) - Method in class org.apache.shiro.web.filter.mgt.SimpleNamedFilterList
 
add(int, Filter) - Method in class org.apache.shiro.web.filter.mgt.SimpleNamedFilterList
 
addAccount(String, String) - Method in class org.apache.shiro.realm.SimpleAccountRealm
 
addAccount(String, String, String...) - Method in class org.apache.shiro.realm.SimpleAccountRealm
 
addAll(Collection<Permission>) - Method in class org.apache.shiro.authz.SimpleRole
 
addAll(Collection, String) - Method in interface org.apache.shiro.subject.MutablePrincipalCollection
Adds all of the principals in the given collection to this collection.
addAll(PrincipalCollection) - Method in interface org.apache.shiro.subject.MutablePrincipalCollection
Adds all of the principals from the given principal collection to this collection.
addAll(Collection, String) - Method in class org.apache.shiro.subject.SimplePrincipalCollection
 
addAll(PrincipalCollection) - Method in class org.apache.shiro.subject.SimplePrincipalCollection
 
addAll(Collection<? extends Filter>) - Method in class org.apache.shiro.web.filter.mgt.SimpleNamedFilterList
 
addAll(int, Collection<? extends Filter>) - Method in class org.apache.shiro.web.filter.mgt.SimpleNamedFilterList
 
addDefaultFilters(boolean) - Method in class org.apache.shiro.web.filter.mgt.DefaultFilterChainManager
 
addFilter(String, Filter) - Method in class org.apache.shiro.web.filter.mgt.DefaultFilterChainManager
 
addFilter(String, Filter, boolean) - Method in class org.apache.shiro.web.filter.mgt.DefaultFilterChainManager
 
addFilter(String, Filter, boolean, boolean) - Method in class org.apache.shiro.web.filter.mgt.DefaultFilterChainManager
 
addFilter(String, Filter) - Method in interface org.apache.shiro.web.filter.mgt.FilterChainManager
Adds a filter to the 'pool' of available filters that can be used when creating filter chains.
addFilter(String, Filter, boolean) - Method in interface org.apache.shiro.web.filter.mgt.FilterChainManager
Adds a filter to the 'pool' of available filters that can be used when creating filter chains.
addFilterChain(String, Key<? extends Filter>...) - Method in class org.apache.shiro.guice.web.ShiroWebModule
Adds a filter chain to the shiro configuration.
addObjectPermission(Permission) - Method in class org.apache.shiro.authc.SimpleAccount
Assigns an object-based permission directly to this Account (not any of its realms).
addObjectPermission(Permission) - Method in class org.apache.shiro.authz.SimpleAuthorizationInfo
Adds (assigns) a permission to those directly associated with the account.
addObjectPermissions(Collection<Permission>) - Method in class org.apache.shiro.authc.SimpleAccount
Assigns one or more object-based permissions directly to this Account (not any of its realms).
addObjectPermissions(Collection<Permission>) - Method in class org.apache.shiro.authz.SimpleAuthorizationInfo
Adds (assigns) multiple permissions to those associated directly with the account.
addRole(String) - Method in class org.apache.shiro.authc.SimpleAccount
Adds a role to this Account's set of assigned roles.
addRole(Collection<String>) - Method in class org.apache.shiro.authc.SimpleAccount
Adds one or more roles to this Account's set of assigned roles.
addRole(String) - Method in class org.apache.shiro.authz.SimpleAuthorizationInfo
Adds (assigns) a role to those associated with the account.
addRole(String) - Method in class org.apache.shiro.realm.SimpleAccountRealm
 
addRoles(Collection<String>) - Method in class org.apache.shiro.authz.SimpleAuthorizationInfo
Adds (assigns) multiple roles to those associated with the account.
addSection(String) - Method in class org.apache.shiro.config.Ini
Ensures a section with the specified name exists, adding a new one if it does not yet exist.
addStringPermission(String) - Method in class org.apache.shiro.authc.SimpleAccount
Assigns a String-based permission directly to this Account (not to any of its realms).
addStringPermission(String) - Method in class org.apache.shiro.authz.SimpleAuthorizationInfo
Adds (assigns) a permission to those directly associated with the account.
addStringPermissions(Collection<String>) - Method in class org.apache.shiro.authc.SimpleAccount
Assigns one or more string-based permissions directly to this Account (not to any of its realms).
addStringPermissions(Collection<String>) - Method in class org.apache.shiro.authz.SimpleAuthorizationInfo
Adds (assigns) multiple permissions to those associated directly with the account.
addToChain(String, String) - Method in class org.apache.shiro.web.filter.mgt.DefaultFilterChainManager
 
addToChain(String, String, String) - Method in class org.apache.shiro.web.filter.mgt.DefaultFilterChainManager
 
addToChain(String, String) - Method in interface org.apache.shiro.web.filter.mgt.FilterChainManager
Adds (appends) a filter to the filter chain identified by the given chainName.
addToChain(String, String, String) - Method in interface org.apache.shiro.web.filter.mgt.FilterChainManager
Adds (appends) a filter to the filter chain identified by the given chainName.
AdviceFilter - Class in org.apache.shiro.web.servlet
A Servlet Filter that enables AOP-style "around" advice for a ServletRequest via preHandle, postHandle, and afterCompletion hooks.
AdviceFilter() - Constructor for class org.apache.shiro.web.servlet.AdviceFilter
 
AesCipherService - Class in org.apache.shiro.crypto
CipherService using the AES cipher algorithm for all encryption, decryption, and key operations.
AesCipherService() - Constructor for class org.apache.shiro.crypto.AesCipherService
Creates a new CipherService instance using the AES cipher algorithm with the following important cipher default attributes: Attribute Value keySize 128 bits blockSize 128 bits (required for AES mode CBC* paddingScheme PKCS5 initializationVectorSize 128 bits generateInitializationVectors true**

* The CBC operation mode is used instead of the JDK default ECB to ensure strong encryption.

afterAllAttempts(AuthenticationToken, AuthenticationInfo) - Method in class org.apache.shiro.authc.pam.AbstractAuthenticationStrategy
Simply returns the aggregate argument without modification.
afterAllAttempts(AuthenticationToken, AuthenticationInfo) - Method in class org.apache.shiro.authc.pam.AtLeastOneSuccessfulStrategy
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.
afterAllAttempts(AuthenticationToken, AuthenticationInfo) - Method in interface org.apache.shiro.authc.pam.AuthenticationStrategy
Method invoked by the ModularAuthenticator signifying that all of its configured Realms have been consulted for account data, allowing post-proccessing after all realms have completed.
afterAttempt(Realm, AuthenticationToken, AuthenticationInfo, AuthenticationInfo, Throwable) - Method in class org.apache.shiro.authc.pam.AbstractAuthenticationStrategy
Base implementation that will aggregate the specified singleRealmInfo into the aggregateInfo and then returns the aggregate.
afterAttempt(Realm, AuthenticationToken, AuthenticationInfo, AuthenticationInfo, Throwable) - Method in class org.apache.shiro.authc.pam.AllSuccessfulStrategy
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
afterAttempt(Realm, AuthenticationToken, AuthenticationInfo, AuthenticationInfo, Throwable) - Method in interface org.apache.shiro.authc.pam.AuthenticationStrategy
Method invoked by the ModularAuthenticator just after the given realm has been consulted for authentication, allowing post-authentication-attempt logic for that realm only.
afterBound(String, Object) - Method in class org.apache.shiro.web.servlet.ShiroHttpSession
 
afterCacheManagerSet() - Method in class org.apache.shiro.mgt.CachingSecurityManager
Template callback to notify subclasses that a CacheManager has been set and is available for use via the getCacheManager() method.
afterCacheManagerSet() - Method in class org.apache.shiro.mgt.RealmSecurityManager
Simply calls applyCacheManagerToRealms() to allow the newly set CacheManager to be propagated to the internal collection of Realm that would need to use it.
afterCacheManagerSet() - Method in class org.apache.shiro.mgt.SessionsSecurityManager
Calls super.afterCacheManagerSet() and then immediately calls applyCacheManagerToSessionManager() to ensure the CacheManager is applied to the SessionManager as necessary.
afterCacheManagerSet() - Method in class org.apache.shiro.realm.AuthenticatingRealm
This implementation attempts to acquire an authentication cache if one is not already configured.
afterCacheManagerSet() - Method in class org.apache.shiro.realm.AuthorizingRealm
 
afterCacheManagerSet() - Method in class org.apache.shiro.realm.CachingRealm
Template method that may be implemented by subclasses should they wish to react to a CacheManager instance being set on the realm instance via the CachingRealm.setCacheManager(org.apache.shiro.cache.CacheManager) mutator.
afterCompletion(ServletRequest, ServletResponse, Exception) - Method in class org.apache.shiro.web.servlet.AdviceFilter
Called in all cases in a finally block even if preHandle returns false or if an exception is thrown during filter chain processing.
afterExpired(Session) - Method in class org.apache.shiro.session.mgt.AbstractValidatingSessionManager
 
afterExpired(Session) - Method in class org.apache.shiro.session.mgt.DefaultSessionManager
 
afterRealmsSet() - Method in class org.apache.shiro.mgt.AuthenticatingSecurityManager
Passes on the realms to the internal delegate Authenticator instance so that it may use them during authentication attempts.
afterRealmsSet() - Method in class org.apache.shiro.mgt.AuthorizingSecurityManager
First calls super.afterRealmsSet() and then sets these same Realm objects on this instance's wrapped Authorizer.
afterRealmsSet() - Method in class org.apache.shiro.mgt.RealmSecurityManager
 
afterRoleCacheSet() - Method in class org.apache.shiro.realm.text.PropertiesRealm
 
afterSessionManagerSet() - Method in class org.apache.shiro.mgt.SessionsSecurityManager
 
afterSessionManagerSet() - Method in class org.apache.shiro.web.mgt.DefaultWebSecurityManager
 
afterSessionValidationEnabled() - Method in class org.apache.shiro.session.mgt.AbstractValidatingSessionManager
 
afterStopped(Session) - Method in class org.apache.shiro.session.mgt.AbstractNativeSessionManager
 
afterStopped(Session) - Method in class org.apache.shiro.session.mgt.DefaultSessionManager
 
afterUnbound(String, Object) - Method in class org.apache.shiro.web.servlet.ShiroHttpSession
 
ALGORITHM_NAME - Static variable in class org.apache.shiro.crypto.hash.Md2Hash
 
ALGORITHM_NAME - Static variable in class org.apache.shiro.crypto.hash.Md5Hash
 
ALGORITHM_NAME - Static variable in class org.apache.shiro.crypto.hash.Sha1Hash
 
ALGORITHM_NAME - Static variable in class org.apache.shiro.crypto.hash.Sha256Hash
 
ALGORITHM_NAME - Static variable in class org.apache.shiro.crypto.hash.Sha384Hash
 
ALGORITHM_NAME - Static variable in class org.apache.shiro.crypto.hash.Sha512Hash
 
AllowAllCredentialsMatcher - Class in org.apache.shiro.authc.credential
A credentials matcher that always returns true when matching credentials no matter what arguments are passed in.
AllowAllCredentialsMatcher() - Constructor for class org.apache.shiro.authc.credential.AllowAllCredentialsMatcher
 
AllPermission - Class in org.apache.shiro.authz.permission
An all AllPermission instance is one that always implies any other permission; that is, its implies method always returns true.
AllPermission() - Constructor for class org.apache.shiro.authz.permission.AllPermission
 
AllSuccessfulStrategy - Class in org.apache.shiro.authc.pam
AuthenticationStrategy implementation that requires all configured realms to successfully process the submitted AuthenticationToken during the log-in attempt.
AllSuccessfulStrategy() - Constructor for class org.apache.shiro.authc.pam.AllSuccessfulStrategy
 
ALREADY_FILTERED_SUFFIX - Static variable in class org.apache.shiro.web.servlet.OncePerRequestFilter
Suffix that gets appended to the filter name for the "already filtered" request attribute.
annotationClass - Variable in class org.apache.shiro.aop.AnnotationHandler
The type of annotation this handler will process.
AnnotationHandler - Class in org.apache.shiro.aop
Base support class for implementations that reads and processes JSR-175 annotations.
AnnotationHandler(Class<? extends Annotation>) - Constructor for class org.apache.shiro.aop.AnnotationHandler
Constructs an AnnotationHandler who processes annotations of the specified type.
AnnotationMethodInterceptor - Class in org.apache.shiro.aop
MethodInterceptor that inspects a specific annotation on the method invocation before continuing its execution.
AnnotationMethodInterceptor(AnnotationHandler) - Constructor for class org.apache.shiro.aop.AnnotationMethodInterceptor
Constructs an AnnotationMethodInterceptor with the AnnotationHandler that will be used to process annotations of a corresponding type.
AnnotationMethodInterceptor(AnnotationHandler, AnnotationResolver) - Constructor for class org.apache.shiro.aop.AnnotationMethodInterceptor
Constructs an AnnotationMethodInterceptor with the AnnotationHandler that will be used to process annotations of a corresponding type, using the specified AnnotationResolver to acquire annotations at runtime.
AnnotationResolver - Interface in org.apache.shiro.aop
Defines an AOP-framework-independent way of determining if an Annotation exists on a Method.
AnnotationsAuthorizingMethodInterceptor - Class in org.apache.shiro.authz.aop
An AnnotationsAuthorizingMethodInterceptor is a MethodInterceptor that asserts a given method is authorized to execute based on one or more configured AuthorizingAnnotationMethodInterceptors.
AnnotationsAuthorizingMethodInterceptor() - Constructor for class org.apache.shiro.authz.aop.AnnotationsAuthorizingMethodInterceptor
Default no-argument constructor that defaults the methodInterceptors attribute to contain two interceptors by default - the RoleAnnotationMethodInterceptor and the PermissionAnnotationMethodInterceptor to support role and permission annotations.
ANON - Static variable in class org.apache.shiro.guice.web.ShiroWebModule
 
AnonymousFilter - Class in org.apache.shiro.web.filter.authc
Filter that allows access to a path immeidately without performing security checks of any kind.
AnonymousFilter() - Constructor for class org.apache.shiro.web.filter.authc.AnonymousFilter
 
AntPathMatcher - Class in org.apache.shiro.util
PathMatcher implementation for Ant-style path patterns.
AntPathMatcher() - Constructor for class org.apache.shiro.util.AntPathMatcher
 
AopAllianceAnnotationsAuthorizingMethodInterceptor - Class in org.apache.shiro.spring.security.interceptor
Allows Shiro Annotations to work in any AOP Alliance specific implementation environment (for example, Spring).
AopAllianceAnnotationsAuthorizingMethodInterceptor() - Constructor for class org.apache.shiro.spring.security.interceptor.AopAllianceAnnotationsAuthorizingMethodInterceptor
 
appendQueryProperties(StringBuilder, Map, String) - Method in class org.apache.shiro.web.util.RedirectView
Append query properties to the redirect URL.
appliedPaths - Variable in class org.apache.shiro.web.filter.PathMatchingFilter
A collection of path-to-config entries where the key is a path which this filter should process and the value is the (possibly null) configuration element specific to this Filter for that specific path.
applyCacheManagerToRealms() - Method in class org.apache.shiro.mgt.RealmSecurityManager
Sets the internal CacheManager on any internal configured Realms that implement the CacheManagerAware interface.
applyCacheManagerToSessionManager() - Method in class org.apache.shiro.mgt.SessionsSecurityManager
Ensures the internal delegate SessionManager is injected with the newly set CacheManager so it may use it for its internal caching needs.
applyChainConfig(String, Filter, String) - Method in class org.apache.shiro.web.filter.mgt.DefaultFilterChainManager
 
applyFilterChainResolver(Ini, Map<String, ?>) - Method in class org.apache.shiro.web.servlet.IniShiroFilter
Deprecated.  
applyGlobalProperty(Map, String, String) - Method in class org.apache.shiro.config.ReflectionBuilder
 
applyGlobalSessionTimeout(Session) - Method in class org.apache.shiro.session.mgt.AbstractNativeSessionManager
 
applyInitParams() - Method in class org.apache.shiro.web.servlet.IniShiroFilter
Deprecated.  
applyPermissionResolverToRealms() - Method in class org.apache.shiro.authz.ModularRealmAuthorizer
Sets the internal ModularRealmAuthorizer.getPermissionResolver() on any internal configured Realms that implement the PermissionResolverAware interface.
applyProperty(String, String, Map) - Method in class org.apache.shiro.config.ReflectionBuilder
 
applyProperty(Object, String, Object) - Method in class org.apache.shiro.config.ReflectionBuilder
 
applyProperty(Object, String, String) - Method in class org.apache.shiro.config.ReflectionBuilder
 
applyRealmsToSecurityManager(Collection<Realm>, SecurityManager) - Method in class org.apache.shiro.config.IniSecurityManagerFactory
 
applyRolePermissionResolverToRealms() - Method in class org.apache.shiro.authz.ModularRealmAuthorizer
Sets the internal ModularRealmAuthorizer.getRolePermissionResolver() on any internal configured Realms that implement the RolePermissionResolverAware interface.
applySecurityManager(Ini) - Method in class org.apache.shiro.web.servlet.IniShiroFilter
Deprecated.  
applySingleProperty(Map, String, String, String) - Method in class org.apache.shiro.config.ReflectionBuilder
 
asList() - Method in interface org.apache.shiro.subject.PrincipalCollection
Returns a single Subject's principals retrieved from all configured Realms as a List, or an empty List if there are not any principals.
asList() - Method in class org.apache.shiro.subject.SimplePrincipalCollection
 
asList() - Method in class org.apache.shiro.subject.SimplePrincipalMap
 
asList(E...) - Static method in class org.apache.shiro.util.CollectionUtils
 
AspectjAnnotationsAuthorizingMethodInterceptor - Class in org.apache.shiro.aspectj
Extends the annotations authorizing method interceptor class hierarchie to adapt an aspectj JoinPoint into a MethodInvocation amd to perform the authorization of method invocations.
AspectjAnnotationsAuthorizingMethodInterceptor() - Constructor for class org.apache.shiro.aspectj.AspectjAnnotationsAuthorizingMethodInterceptor
 
assertAuthorized(MethodInvocation) - Method in class org.apache.shiro.authz.aop.AnnotationsAuthorizingMethodInterceptor
Iterates over the internal methodInterceptors collection, and for each one, ensures that if the interceptor supports the invocation, that the interceptor asserts that the invocation is authorized to proceed.
assertAuthorized(Annotation) - Method in class org.apache.shiro.authz.aop.AuthenticatedAnnotationHandler
Ensures that the calling Subject is authenticated, and if not, throws an UnauthenticatedException indicating the method is not allowed to be executed.
assertAuthorized(Annotation) - Method in class org.apache.shiro.authz.aop.AuthorizingAnnotationHandler
Ensures the calling Subject is authorized to execute based on the directive(s) found in the given annotation.
assertAuthorized(MethodInvocation) - Method in class org.apache.shiro.authz.aop.AuthorizingAnnotationMethodInterceptor
Ensures the calling Subject is authorized to execute the specified MethodInvocation.
assertAuthorized(MethodInvocation) - Method in class org.apache.shiro.authz.aop.AuthorizingMethodInterceptor
Asserts that the specified MethodInvocation is allowed to continue by performing any necessary authorization (access control) checks first.
assertAuthorized(Annotation) - Method in class org.apache.shiro.authz.aop.GuestAnnotationHandler
Ensures that the calling Subject is NOT a user, that is, they do not have an identity before continuing.
assertAuthorized(Annotation) - Method in class org.apache.shiro.authz.aop.PermissionAnnotationHandler
Ensures that the calling Subject has the Annotation's specified permissions, and if not, throws an AuthorizingException indicating access is denied.
assertAuthorized(Annotation) - Method in class org.apache.shiro.authz.aop.RoleAnnotationHandler
Ensures that the calling Subject has the Annotation's specified roles, and if not, throws an AuthorizingException indicating that access is denied.
assertAuthorized(Annotation) - Method in class org.apache.shiro.authz.aop.UserAnnotationHandler
Ensures that the calling Subject is a user, that is, they are either authenticated or remembered via remember me services before allowing access, and if not, throws an AuthorizingException indicating access is not allowed.
assertAuthzCheckPossible() - Method in class org.apache.shiro.subject.support.DelegatingSubject
 
assertCredentialsMatch(AuthenticationToken, AuthenticationInfo) - Method in class org.apache.shiro.realm.AuthenticatingRealm
Asserts that the submitted AuthenticationToken's credentials match the stored account AuthenticationInfo's credentials, and if not, throws an AuthenticationException.
assertHashFormatImpl(Class) - Method in class org.apache.shiro.crypto.hash.format.DefaultHashFormatFactory
 
assertRealmsConfigured() - Method in class org.apache.shiro.authc.pam.ModularRealmAuthenticator
 
assertRealmsConfigured() - Method in class org.apache.shiro.authz.ModularRealmAuthorizer
Used by the Authorizer implementation methods to ensure that the realms has been set.
asSet() - Method in interface org.apache.shiro.subject.PrincipalCollection
Returns a single Subject's principals retrieved from all configured Realms as a Set, or an empty Set if there are not any principals.
asSet() - Method in class org.apache.shiro.subject.SimplePrincipalCollection
 
asSet() - Method in class org.apache.shiro.subject.SimplePrincipalMap
 
asSet(E...) - Static method in class org.apache.shiro.util.CollectionUtils
 
assignSessionId(Session, Serializable) - Method in class org.apache.shiro.session.mgt.eis.AbstractSessionDAO
Utility method available to subclasses that wish to assign a generated session ID to the session instance directly.
associateWith(Callable<V>) - Method in interface org.apache.shiro.subject.Subject
Returns a Callable instance matching the given argument while additionally ensuring that it will retain and execute under this Subject's identity.
associateWith(Runnable) - Method in interface org.apache.shiro.subject.Subject
Returns a Runnable instance matching the given argument while additionally ensuring that it will retain and execute under this Subject's identity.
associateWith(Callable<V>) - Method in class org.apache.shiro.subject.support.DelegatingSubject
 
associateWith(Runnable) - Method in class org.apache.shiro.subject.support.DelegatingSubject
 
associateWithSubject(Runnable) - Method in class org.apache.shiro.concurrent.SubjectAwareExecutor
Utility method for subclasses to associate the argument Runnable with the currently executing subject and then return the associated Runnable.
associateWithSubject(Callable<T>) - Method in class org.apache.shiro.concurrent.SubjectAwareExecutorService
 
associateWithSubject(Collection<? extends Callable<T>>) - Method in class org.apache.shiro.concurrent.SubjectAwareExecutorService
 
AtLeastOneSuccessfulStrategy - Class in org.apache.shiro.authc.pam
AuthenticationStrategy implementation that requires at least one configured realm to successfully process the submitted AuthenticationToken during the log-in attempt.
AtLeastOneSuccessfulStrategy() - Constructor for class org.apache.shiro.authc.pam.AtLeastOneSuccessfulStrategy
 
ATTRIBUTE_DELIMITER - Static variable in class org.apache.shiro.web.servlet.SimpleCookie
 
AUTHC - Static variable in class org.apache.shiro.guice.web.ShiroWebModule
 
AUTHC_BASIC - Static variable in class org.apache.shiro.guice.web.ShiroWebModule
 
authenticate(AuthenticationToken) - Method in class org.apache.shiro.authc.AbstractAuthenticator
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 propogate 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
authenticate(AuthenticationToken) - Method in interface org.apache.shiro.authc.Authenticator
Authenticates a user based on the submitted AuthenticationToken.
authenticate(AuthenticationToken) - Method in class org.apache.shiro.mgt.AuthenticatingSecurityManager
Delegates to the wrapped Authenticator for authentication.
AUTHENTICATE_HEADER - Static variable in class org.apache.shiro.web.filter.authc.BasicHttpAuthenticationFilter
HTTP Authentication header, equal to WWW-Authenticate
authenticated(boolean) - Method in class org.apache.shiro.subject.Subject.Builder
Ensures the Subject being built will be considered authenticated.
authenticated - Variable in class org.apache.shiro.subject.support.DelegatingSubject
 
AUTHENTICATED_SESSION_KEY - Static variable in class org.apache.shiro.subject.support.DefaultSubjectContext
The session key that is used to store whether or not the user is authenticated.
AuthenticatedAnnotationHandler - Class in org.apache.shiro.authz.aop
Handles RequiresAuthentication annotations and ensures the calling subject is authenticated before allowing access.
AuthenticatedAnnotationHandler() - Constructor for class org.apache.shiro.authz.aop.AuthenticatedAnnotationHandler
Default no-argument constructor that ensures this handler to process RequiresAuthentication annotations.
AuthenticatedAnnotationMethodInterceptor - Class in org.apache.shiro.authz.aop
Checks to see if a @RequiresAuthenticated annotation is declared, and if so, ensures the calling Subject.isAuthenticated() before invoking the method.
AuthenticatedAnnotationMethodInterceptor() - Constructor for class org.apache.shiro.authz.aop.AuthenticatedAnnotationMethodInterceptor
Default no-argument constructor that ensures this interceptor looks for RequiresAuthentication annotations in a method declaration.
AuthenticatedAnnotationMethodInterceptor(AnnotationResolver) - Constructor for class org.apache.shiro.authz.aop.AuthenticatedAnnotationMethodInterceptor
 
AuthenticatedTag - Class in org.apache.shiro.web.tags
JSP tag that renders the tag body only if the current user has executed a successful authentication attempt during their current session.
AuthenticatedTag() - Constructor for class org.apache.shiro.web.tags.AuthenticatedTag
 
AuthenticatingFilter - Class in org.apache.shiro.web.filter.authc
An AuthenticationFilter that is capable of automatically performing an authentication attempt based on the incoming request.
AuthenticatingFilter() - Constructor for class org.apache.shiro.web.filter.authc.AuthenticatingFilter
 
AuthenticatingRealm - Class in org.apache.shiro.realm
A top-level abstract implementation of the Realm interface that only implements authentication support (log-in) operations and leaves authorization (access control) behavior to subclasses.
AuthenticatingRealm() - Constructor for class org.apache.shiro.realm.AuthenticatingRealm
 
AuthenticatingRealm(CacheManager) - Constructor for class org.apache.shiro.realm.AuthenticatingRealm
 
AuthenticatingRealm(CredentialsMatcher) - Constructor for class org.apache.shiro.realm.AuthenticatingRealm
 
AuthenticatingRealm(CacheManager, CredentialsMatcher) - Constructor for class org.apache.shiro.realm.AuthenticatingRealm
 
AuthenticatingSecurityManager - Class in org.apache.shiro.mgt
Shiro support of a SecurityManager class hierarchy that delegates all authentication operations to a wrapped Authenticator instance.
AuthenticatingSecurityManager() - Constructor for class org.apache.shiro.mgt.AuthenticatingSecurityManager
Default no-arg constructor that initializes its internal authenticator instance to a ModularRealmAuthenticator.
authentication - Variable in class org.apache.shiro.realm.ldap.DefaultLdapContextFactory
Deprecated.  
AuthenticationException - Exception in org.apache.shiro.authc
General exception thrown due to an error during the Authentication process.
AuthenticationException() - Constructor for exception org.apache.shiro.authc.AuthenticationException
Creates a new AuthenticationException.
AuthenticationException(String) - Constructor for exception org.apache.shiro.authc.AuthenticationException
Constructs a new AuthenticationException.
AuthenticationException(Throwable) - Constructor for exception org.apache.shiro.authc.AuthenticationException
Constructs a new AuthenticationException.
AuthenticationException(String, Throwable) - Constructor for exception org.apache.shiro.authc.AuthenticationException
Constructs a new AuthenticationException.
AuthenticationFilter - Class in org.apache.shiro.web.filter.authc
Base class for all Filters that require the current user to be authenticated.
AuthenticationFilter() - Constructor for class org.apache.shiro.web.filter.authc.AuthenticationFilter
 
AuthenticationInfo - Interface in org.apache.shiro.authc
AuthenticationInfo represents a Subject's (aka user's) stored account information relevant to the authentication/log-in process only.
AuthenticationListener - Interface in org.apache.shiro.authc
An AuthenticationListener listens for notifications while Subjects authenticate with the system.
authenticationQuery - Variable in class org.apache.shiro.realm.jdbc.JdbcRealm
 
AuthenticationStrategy - Interface in org.apache.shiro.authc.pam
A AuthenticationStrategy implementation assists the ModularRealmAuthenticator during the log-in process in a pluggable realm (PAM) environment.
AuthenticationToken - Interface in org.apache.shiro.authc
An AuthenticationToken is a consolidation of an account's principals and supporting credentials submitted by a user during an authentication attempt.
Authenticator - Interface in org.apache.shiro.authc
An Authenticator is responsible for authenticating accounts in an application.
AUTHORIZATION_HEADER - Static variable in class org.apache.shiro.web.filter.authc.BasicHttpAuthenticationFilter
HTTP Authorization header, equal to Authorization
AuthorizationAttributeSourceAdvisor - Class in org.apache.shiro.spring.security.interceptor
TODO - complete JavaDoc
AuthorizationAttributeSourceAdvisor() - Constructor for class org.apache.shiro.spring.security.interceptor.AuthorizationAttributeSourceAdvisor
Create a new AuthorizationAttributeSourceAdvisor.
AuthorizationException - Exception in org.apache.shiro.authz
Exception thrown if there is a problem during authorization (access control check).
AuthorizationException() - Constructor for exception org.apache.shiro.authz.AuthorizationException
Creates a new AuthorizationException.
AuthorizationException(String) - Constructor for exception org.apache.shiro.authz.AuthorizationException
Constructs a new AuthorizationException.
AuthorizationException(Throwable) - Constructor for exception org.apache.shiro.authz.AuthorizationException
Constructs a new AuthorizationException.
AuthorizationException(String, Throwable) - Constructor for exception org.apache.shiro.authz.AuthorizationException
Constructs a new AuthorizationException.
AuthorizationFilter - Class in org.apache.shiro.web.filter.authz
Superclass for authorization-related filters.
AuthorizationFilter() - Constructor for class org.apache.shiro.web.filter.authz.AuthorizationFilter
 
AuthorizationInfo - Interface in org.apache.shiro.authz
AuthorizationInfo represents a single Subject's stored authorization data (roles, permissions, etc) used during authorization (access control) checks only.
Authorizer - Interface in org.apache.shiro.authz
An Authorizer performs authorization (access control) operations for any given Subject (aka 'application user').
AuthorizingAnnotationHandler - Class in org.apache.shiro.authz.aop
An AnnotationHandler that executes authorization (access control) behavior based on directive(s) found in a JSR-175 Annotation.
AuthorizingAnnotationHandler(Class<? extends Annotation>) - Constructor for class org.apache.shiro.authz.aop.AuthorizingAnnotationHandler
Constructs an AuthorizingAnnotationHandler who processes annotations of the specified type.
AuthorizingAnnotationMethodInterceptor - Class in org.apache.shiro.authz.aop
An AnnotationMethodInterceptor that asserts the calling code is authorized to execute the method before allowing the invocation to continue by inspecting code annotations to perform an access control check.
AuthorizingAnnotationMethodInterceptor(AuthorizingAnnotationHandler) - Constructor for class org.apache.shiro.authz.aop.AuthorizingAnnotationMethodInterceptor
Constructor that ensures the internal handler is set which will be used to perform the authorization assertion checks when a supported annotation is encountered.
AuthorizingAnnotationMethodInterceptor(AuthorizingAnnotationHandler, AnnotationResolver) - Constructor for class org.apache.shiro.authz.aop.AuthorizingAnnotationMethodInterceptor
 
AuthorizingMethodInterceptor - Class in org.apache.shiro.authz.aop
Basic abstract class to support intercepting methods that perform authorization (access control) checks.
AuthorizingMethodInterceptor() - Constructor for class org.apache.shiro.authz.aop.AuthorizingMethodInterceptor
 
AuthorizingRealm - Class in org.apache.shiro.realm
An AuthorizingRealm extends the AuthenticatingRealm's capabilities by adding Authorization (access control) support.
AuthorizingRealm() - Constructor for class org.apache.shiro.realm.AuthorizingRealm
 
AuthorizingRealm(CacheManager) - Constructor for class org.apache.shiro.realm.AuthorizingRealm
 
AuthorizingRealm(CredentialsMatcher) - Constructor for class org.apache.shiro.realm.AuthorizingRealm
 
AuthorizingRealm(CacheManager, CredentialsMatcher) - Constructor for class org.apache.shiro.realm.AuthorizingRealm
 
AuthorizingSecurityManager - Class in org.apache.shiro.mgt
Shiro support of a SecurityManager class hierarchy that delegates all authorization (access control) operations to a wrapped Authorizer instance.
AuthorizingSecurityManager() - Constructor for class org.apache.shiro.mgt.AuthorizingSecurityManager
Default no-arg constructor that initializes an internal default ModularRealmAuthorizer.
awaitTermination(long, TimeUnit) - Method in class org.apache.shiro.concurrent.SubjectAwareExecutorService
 

B

Base64 - Class in org.apache.shiro.codec
Provides Base 64 encoding and decoding as defined by RFC 2045.
Base64() - Constructor for class org.apache.shiro.codec.Base64
 
Base64Format - Class in org.apache.shiro.crypto.hash.format
HashFormat that outputs only the hash's digest bytes in Base64 format.
Base64Format() - Constructor for class org.apache.shiro.crypto.hash.format.Base64Format
 
BasicHttpAuthenticationFilter - Class in org.apache.shiro.web.filter.authc
Requires the requesting user to be authenticated for the request to continue, and if they're not, requires the user to login via the HTTP Basic protocol-specific challenge.
BasicHttpAuthenticationFilter() - Constructor for class org.apache.shiro.web.filter.authc.BasicHttpAuthenticationFilter
 
BeforeAdviceMethodInvocationAdapter - Class in org.apache.shiro.aspectj
Helper class that adapts an AspectJ JoinPoint.
BeforeAdviceMethodInvocationAdapter(Object, Method, Object[]) - Constructor for class org.apache.shiro.aspectj.BeforeAdviceMethodInvocationAdapter
Creates a new BeforeAdviceMethodInvocationAdapter instance.
beforeAllAttempts(Collection<? extends Realm>, AuthenticationToken) - Method in class org.apache.shiro.authc.pam.AbstractAuthenticationStrategy
Simply returns new SimpleAuthenticationInfo();, which supports aggregating account data across realms.
beforeAllAttempts(Collection<? extends Realm>, AuthenticationToken) - Method in interface org.apache.shiro.authc.pam.AuthenticationStrategy
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.
beforeAllAttempts(Collection<? extends Realm>, AuthenticationToken) - Method in class org.apache.shiro.authc.pam.FirstSuccessfulStrategy
Returns null immediately, relying on this class's merge implementation to return only the first info object it encounters, ignoring all subsequent ones.
beforeAttempt(Realm, AuthenticationToken, AuthenticationInfo) - Method in class org.apache.shiro.authc.pam.AbstractAuthenticationStrategy
Simply returns the aggregate method argument, without modification.
beforeAttempt(Realm, AuthenticationToken, AuthenticationInfo) - Method in class org.apache.shiro.authc.pam.AllSuccessfulStrategy
Because all realms in this strategy must complete successfully, this implementation ensures that the given Realm supports the given token argument.
beforeAttempt(Realm, AuthenticationToken, AuthenticationInfo) - Method in interface org.apache.shiro.authc.pam.AuthenticationStrategy
Method invoked by the ModularAuthenticator just prior to the realm being consulted for account data, allowing pre-authentication-attempt logic for that realm only.
beforeInvalidNotification(Session) - Method in class org.apache.shiro.session.mgt.AbstractNativeSessionManager
Returns the session instance to use to pass to registered SessionListeners for notification that the session has been invalidated (stopped or expired).
beforeLogout(Subject) - Method in class org.apache.shiro.mgt.DefaultSecurityManager
 
beforeLogout(Subject) - Method in class org.apache.shiro.web.mgt.DefaultWebSecurityManager
 
beforeSessionValidationDisabled() - Method in class org.apache.shiro.session.mgt.AbstractValidatingSessionManager
 
bind(String, Object) - Method in class org.apache.shiro.jndi.JndiTemplate
Bind the given object to the current JNDI context, using the given name.
bind(Subject) - Method in class org.apache.shiro.mgt.DefaultSecurityManager
Deprecated. in favor of save(subject).
bind() - Method in class org.apache.shiro.subject.support.SubjectThreadState
Binds a Subject and SecurityManager to the ThreadContext so they can be retrieved later by any SecurityUtils.getSubject() calls that might occur during the thread's execution.
bind(SecurityManager) - Static method in class org.apache.shiro.util.ThreadContext
Convenience method that simplifies binding the application's SecurityManager instance to the ThreadContext.
bind(Subject) - Static method in class org.apache.shiro.util.ThreadContext
Convenience method that simplifies binding a Subject to the ThreadContext.
bind() - Method in interface org.apache.shiro.util.ThreadState
Binds any state that should be made accessible during a thread's execution.
bindBeanType(TypeLiteral<T>, Key<? extends T>) - Method in class org.apache.shiro.guice.ShiroModule
Binds a key to use for injecting setters in shiro classes.
bindEnvironment(AnnotatedBindingBuilder<Environment>) - Method in class org.apache.shiro.guice.ShiroModule
Binds the environment.
bindEnvironment(AnnotatedBindingBuilder<Environment>) - Method in class org.apache.shiro.guice.web.ShiroWebModule
 
bindGuiceFilter(Binder) - Static method in class org.apache.shiro.guice.web.ShiroWebModule
 
bindGuiceFilter(String, Binder) - Static method in class org.apache.shiro.guice.web.ShiroWebModule
 
bindRealm() - Method in class org.apache.shiro.guice.ShiroModule
This is the preferred manner to bind a realm.
bindSecurityManager(AnnotatedBindingBuilder<? super SecurityManager>) - Method in class org.apache.shiro.guice.ShiroModule
Binds the security manager.
bindSecurityManager(AnnotatedBindingBuilder<? super SecurityManager>) - Method in class org.apache.shiro.guice.web.ShiroWebModule
 
bindSessionManager(AnnotatedBindingBuilder<SessionManager>) - Method in class org.apache.shiro.guice.ShiroModule
Binds the session manager.
bindSessionManager(AnnotatedBindingBuilder<SessionManager>) - Method in class org.apache.shiro.guice.web.ShiroWebModule
Binds the session manager.
bindShiroInterceptor(AnnotationMethodInterceptor) - Method in class org.apache.shiro.guice.aop.ShiroAopModule
 
bindWebEnvironment(AnnotatedBindingBuilder<? super WebEnvironment>) - Method in class org.apache.shiro.guice.web.ShiroWebModule
 
bindWebSecurityManager(AnnotatedBindingBuilder<? super WebSecurityManager>) - Method in class org.apache.shiro.guice.web.ShiroWebModule
Binds the security manager.
BlowfishCipherService - Class in org.apache.shiro.crypto
CipherService using the Blowfish cipher algorithm for all encryption, decryption, and key operations.
BlowfishCipherService() - Constructor for class org.apache.shiro.crypto.BlowfishCipherService
Creates a new CipherService instance using the Blowfish cipher algorithm with the following important cipher default attributes: Attribute Value keySize 128 bits blockSize 64 bits (required for Blowfish) mode CBC* paddingScheme PKCS5 initializationVectorSize 64 bits generateInitializationVectors true**

* The CBC operation mode is used instead of the JDK default ECB to ensure strong encryption.

build() - Method in class org.apache.shiro.crypto.hash.HashRequest.Builder
Builds a HashRequest instance reflecting the specified configuration.
buildAuthenticationInfo(String, char[]) - Method in class org.apache.shiro.realm.activedirectory.ActiveDirectoryRealm
 
buildAuthorizationInfo(Set<String>) - Method in class org.apache.shiro.realm.activedirectory.ActiveDirectoryRealm
 
buildChains(FilterChainManager, Ini) - Method in class org.apache.shiro.web.config.IniFilterChainResolverFactory
 
buildHashRequest(ByteSource, Hash) - Method in class org.apache.shiro.authc.credential.DefaultPasswordService
 
buildHeaderValue(String, String, String, String, String, int, int, boolean, boolean) - Method in class org.apache.shiro.web.servlet.SimpleCookie
 
buildObjects(Map<String, String>) - Method in class org.apache.shiro.config.ReflectionBuilder
 
buildPermissions(HttpServletRequest, String[], String) - Method in class org.apache.shiro.web.filter.authz.HttpMethodPermissionFilter
Returns a collection of String permissions with which to perform a permission check to determine if the filter will allow the request to continue.
buildPermissions(String[], String) - Method in class org.apache.shiro.web.filter.authz.HttpMethodPermissionFilter
Builds a new array of permission strings based on the original argument, appending the specified action verb to each one per WildcardPermission conventions.
buildSubject() - Method in class org.apache.shiro.subject.Subject.Builder
Creates and returns a new Subject instance reflecting the cumulative state acquired by the other methods in this class.
buildWebSubject() - Method in class org.apache.shiro.web.subject.WebSubject.Builder
Returns super.buildSubject(), but additionally ensures that the returned instance is an instanceof WebSubject and to support a type-safe method so a caller does not have to cast.
byId(String) - Static method in enum org.apache.shiro.crypto.hash.format.ProvidedHashFormat
 
bytes(byte[]) - Static method in class org.apache.shiro.util.ByteSource.Util
Returns a new ByteSource instance representing the specified byte array.
bytes(char[]) - Static method in class org.apache.shiro.util.ByteSource.Util
Returns a new ByteSource instance representing the specified character array's bytes.
bytes(String) - Static method in class org.apache.shiro.util.ByteSource.Util
Returns a new ByteSource instance representing the specified string's bytes.
bytes(ByteSource) - Static method in class org.apache.shiro.util.ByteSource.Util
Returns a new ByteSource instance representing the specified ByteSource.
bytes(File) - Static method in class org.apache.shiro.util.ByteSource.Util
Returns a new ByteSource instance representing the specified File's bytes.
bytes(InputStream) - Static method in class org.apache.shiro.util.ByteSource.Util
Returns a new ByteSource instance representing the specified InputStream's bytes.
bytes(Object) - Static method in class org.apache.shiro.util.ByteSource.Util
Returns a ByteSource instance representing the specified byte source argument.
ByteSource - Interface in org.apache.shiro.util
A ByteSource wraps a byte array and provides additional encoding operations.
ByteSource.Util - Class in org.apache.shiro.util
Utility class that can construct ByteSource instances.
ByteSource.Util() - Constructor for class org.apache.shiro.util.ByteSource.Util
 
byType(Class<T>) - Method in interface org.apache.shiro.subject.PrincipalCollection
Returns all principals assignable from the specified type, or an empty Collection if no principals of that type are contained.
byType(Class<T>) - Method in class org.apache.shiro.subject.SimplePrincipalCollection
 
byType(Class<T>) - Method in class org.apache.shiro.subject.SimplePrincipalMap
 

C

Cache<K,V> - Interface in org.apache.shiro.cache
A Cache efficiently stores temporary objects primarily to improve an application's performance.
cache(Session, Serializable) - Method in class org.apache.shiro.session.mgt.eis.CachingSessionDAO
Caches the specified session under the cache entry key of sessionId.
cache(Session, Serializable, Cache<Serializable, Session>) - Method in class org.apache.shiro.session.mgt.eis.CachingSessionDAO
Caches the specified session in the given cache under the key of sessionId.
CacheException - Exception in org.apache.shiro.cache
Root class of all Shiro exceptions related to caching operations.
CacheException() - Constructor for exception org.apache.shiro.cache.CacheException
Creates a new CacheException.
CacheException(String) - Constructor for exception org.apache.shiro.cache.CacheException
Creates a new CacheException.
CacheException(Throwable) - Constructor for exception org.apache.shiro.cache.CacheException
Creates a new CacheException.
CacheException(String, Throwable) - Constructor for exception org.apache.shiro.cache.CacheException
Creates a new CacheException.
CacheManager - Interface in org.apache.shiro.cache
A CacheManager provides and maintains the lifecycles of Cache instances.
CacheManagerAware - Interface in org.apache.shiro.cache
Interface implemented by components that utilize a CacheManager and wish that CacheManager to be supplied if one is available.
CachingRealm - Class in org.apache.shiro.realm
A very basic abstract extension point for the Realm interface that provides caching support for subclasses.
CachingRealm() - Constructor for class org.apache.shiro.realm.CachingRealm
Default no-argument constructor that defaults cachingEnabled (for general caching) to true and sets a default name based on the class name.
CachingSecurityManager - Class in org.apache.shiro.mgt
A very basic starting point for the SecurityManager interface that merely provides logging and caching support.
CachingSecurityManager() - Constructor for class org.apache.shiro.mgt.CachingSecurityManager
Default no-arg constructor that will automatically attempt to initialize a default cacheManager
CachingSessionDAO - Class in org.apache.shiro.session.mgt.eis
An CachingSessionDAO is a SessionDAO that provides a transparent caching layer between the components that use it and the underlying EIS (Enterprise Information System) session backing store (for example, filesystem, database, enterprise grid/cloud, etc).
CachingSessionDAO() - Constructor for class org.apache.shiro.session.mgt.eis.CachingSessionDAO
Default no-arg constructor.
call() - Method in class org.apache.shiro.subject.support.SubjectCallable
 
CasAuthenticationException - Exception in org.apache.shiro.cas
 
CasAuthenticationException() - Constructor for exception org.apache.shiro.cas.CasAuthenticationException
 
CasAuthenticationException(String) - Constructor for exception org.apache.shiro.cas.CasAuthenticationException
 
CasAuthenticationException(Throwable) - Constructor for exception org.apache.shiro.cas.CasAuthenticationException
 
CasAuthenticationException(String, Throwable) - Constructor for exception org.apache.shiro.cas.CasAuthenticationException
 
CasFilter - Class in org.apache.shiro.cas
This filter validates the CAS service ticket to authenticate the user.
CasFilter() - Constructor for class org.apache.shiro.cas.CasFilter
 
CasRealm - Class in org.apache.shiro.cas
This realm implementation acts as a CAS client to a CAS server for authentication and basic authorization.
CasRealm() - Constructor for class org.apache.shiro.cas.CasRealm
 
CasSubjectFactory - Class in org.apache.shiro.cas
Subject implementation to be used in CAS-enabled applications.
CasSubjectFactory() - Constructor for class org.apache.shiro.cas.CasSubjectFactory
 
CasToken - Class in org.apache.shiro.cas
This class represents a token for a CAS authentication (service ticket + user id + remember me).
CasToken(String) - Constructor for class org.apache.shiro.cas.CasToken
 
checkForNullOrEmptyLiteral(String) - Method in class org.apache.shiro.config.ReflectionBuilder
 
checkHashFormatDurability() - Method in class org.apache.shiro.authc.credential.DefaultPasswordService
 
checkPermission(PrincipalCollection, String) - Method in interface org.apache.shiro.authz.Authorizer
Ensures the corresponding Subject/user implies the specified permission String.
checkPermission(PrincipalCollection, Permission) - Method in interface org.apache.shiro.authz.Authorizer
Ensures a subject/user Permission.implies(Permission) implies} the specified Permission.
checkPermission(PrincipalCollection, String) - Method in class org.apache.shiro.authz.ModularRealmAuthorizer
If !isPermitted(permission), throws an UnauthorizedException otherwise returns quietly.
checkPermission(PrincipalCollection, Permission) - Method in class org.apache.shiro.authz.ModularRealmAuthorizer
If !isPermitted(permission), throws an UnauthorizedException otherwise returns quietly.
checkPermission(PrincipalCollection, String) - Method in class org.apache.shiro.mgt.AuthorizingSecurityManager
 
checkPermission(PrincipalCollection, Permission) - Method in class org.apache.shiro.mgt.AuthorizingSecurityManager
 
checkPermission(PrincipalCollection, String) - Method in class org.apache.shiro.realm.AuthorizingRealm
 
checkPermission(PrincipalCollection, Permission) - Method in class org.apache.shiro.realm.AuthorizingRealm
 
checkPermission(Permission, AuthorizationInfo) - Method in class org.apache.shiro.realm.AuthorizingRealm
 
checkPermission(String) - Method in interface org.apache.shiro.subject.Subject
Ensures this Subject implies the specified permission String.
checkPermission(Permission) - Method in interface org.apache.shiro.subject.Subject
Ensures this Subject implies the specified Permission.
checkPermission(String) - Method in class org.apache.shiro.subject.support.DelegatingSubject
 
checkPermission(Permission) - Method in class org.apache.shiro.subject.support.DelegatingSubject
 
checkPermissions(PrincipalCollection, String...) - Method in interface org.apache.shiro.authz.Authorizer
Ensures the corresponding Subject/user implies all of the specified permission strings.
checkPermissions(PrincipalCollection, Collection<Permission>) - Method in interface org.apache.shiro.authz.Authorizer
Ensures the corresponding Subject/user implies all of the specified permission strings.
checkPermissions(PrincipalCollection, String...) - Method in class org.apache.shiro.authz.ModularRealmAuthorizer
If !isPermitted(permission), throws an UnauthorizedException otherwise returns quietly.
checkPermissions(PrincipalCollection, Collection<Permission>) - Method in class org.apache.shiro.authz.ModularRealmAuthorizer
If !isPermitted(permission) for all the given Permissions, throws an UnauthorizedException otherwise returns quietly.
checkPermissions(PrincipalCollection, String...) - Method in class org.apache.shiro.mgt.AuthorizingSecurityManager
 
checkPermissions(PrincipalCollection, Collection<Permission>) - Method in class org.apache.shiro.mgt.AuthorizingSecurityManager
 
checkPermissions(PrincipalCollection, String...) - Method in class org.apache.shiro.realm.AuthorizingRealm
 
checkPermissions(PrincipalCollection, Collection<Permission>) - Method in class org.apache.shiro.realm.AuthorizingRealm
 
checkPermissions(Collection<Permission>, AuthorizationInfo) - Method in class org.apache.shiro.realm.AuthorizingRealm
 
checkPermissions(String...) - Method in interface org.apache.shiro.subject.Subject
Ensures this Subject implies all of the specified permission strings.
checkPermissions(Collection<Permission>) - Method in interface org.apache.shiro.subject.Subject
Ensures this Subject implies all of the specified permission strings.
checkPermissions(String...) - Method in class org.apache.shiro.subject.support.DelegatingSubject
 
checkPermissions(Collection<Permission>) - Method in class org.apache.shiro.subject.support.DelegatingSubject
 
checkRole(PrincipalCollection, String) - Method in interface org.apache.shiro.authz.Authorizer
Asserts the corresponding Subject/user has the specified role by returning quietly if they do or throwing an AuthorizationException if they do not.
checkRole(PrincipalCollection, String) - Method in class org.apache.shiro.authz.ModularRealmAuthorizer
If !hasRole(role), throws an UnauthorizedException otherwise returns quietly.
checkRole(PrincipalCollection, String) - Method in class org.apache.shiro.mgt.AuthorizingSecurityManager
 
checkRole(PrincipalCollection, String) - Method in class org.apache.shiro.realm.AuthorizingRealm
 
checkRole(String, AuthorizationInfo) - Method in class org.apache.shiro.realm.AuthorizingRealm
 
checkRole(String) - Method in interface org.apache.shiro.subject.Subject
Asserts this Subject has the specified role by returning quietly if they do or throwing an AuthorizationException if they do not.
checkRole(String) - Method in class org.apache.shiro.subject.support.DelegatingSubject
 
checkRoles(PrincipalCollection, Collection<String>) - Method in interface org.apache.shiro.authz.Authorizer
Asserts the corresponding Subject/user has all of the specified roles by returning quietly if they do or throwing an AuthorizationException if they do not.
checkRoles(PrincipalCollection, String...) - Method in interface org.apache.shiro.authz.Authorizer
Same as checkRoles(PrincipalCollection subjectPrincipal, Collection<String> roleIdentifiers) but doesn't require a collection as an argument.
checkRoles(PrincipalCollection, Collection<String>) - Method in class org.apache.shiro.authz.ModularRealmAuthorizer
Calls {@link #checkRoles(PrincipalCollection principals, String...
checkRoles(PrincipalCollection, String...) - Method in class org.apache.shiro.authz.ModularRealmAuthorizer
Calls checkRole for each role specified.
checkRoles(PrincipalCollection, Collection<String>) - Method in class org.apache.shiro.mgt.AuthorizingSecurityManager
 
checkRoles(PrincipalCollection, String...) - Method in class org.apache.shiro.mgt.AuthorizingSecurityManager
 
checkRoles(PrincipalCollection, Collection<String>) - Method in class org.apache.shiro.realm.AuthorizingRealm
 
checkRoles(PrincipalCollection, String...) - Method in class org.apache.shiro.realm.AuthorizingRealm
 
checkRoles(Collection<String>, AuthorizationInfo) - Method in class org.apache.shiro.realm.AuthorizingRealm
 
checkRoles(Collection<String>) - Method in interface org.apache.shiro.subject.Subject
Asserts this Subject has all of the specified roles by returning quietly if they do or throwing an AuthorizationException if they do not.
checkRoles(String...) - Method in interface org.apache.shiro.subject.Subject
Same as checkRoles(Collection roleIdentifiers) but doesn't require a collection as a an argument.
checkRoles(String...) - Method in class org.apache.shiro.subject.support.DelegatingSubject
 
checkRoles(Collection<String>) - Method in class org.apache.shiro.subject.support.DelegatingSubject
 
checkValid(SessionKey) - Method in class org.apache.shiro.session.mgt.AbstractNativeSessionManager
 
checkValid(SessionKey) - Method in interface org.apache.shiro.session.mgt.NativeSessionManager
Returns quietly if the associated session is valid (it exists and is not stopped or expired) or throws an InvalidSessionException indicating that the session id is invalid.
CipherService - Interface in org.apache.shiro.crypto
A CipherService uses a cryptographic algorithm called a Cipher to convert an original input source using a key to an uninterpretable format.
CLASSPATH_PREFIX - Static variable in class org.apache.shiro.io.ResourceUtils
Resource path prefix that specifies to load from a classpath location, value is classpath:
ClassResolvingObjectInputStream - Class in org.apache.shiro.io
Enables correct ClassLoader lookup in various environments (e.g.
ClassResolvingObjectInputStream(InputStream) - Constructor for class org.apache.shiro.io.ClassResolvingObjectInputStream
 
ClassUtils - Class in org.apache.shiro.util
Utility method library used to conveniently interact with Classes, such as acquiring them from the application ClassLoaders and instantiating Objects from them.
ClassUtils() - Constructor for class org.apache.shiro.util.ClassUtils
 
clean(String) - Static method in class org.apache.shiro.util.StringUtils
Returns a 'cleaned' representation of the specified argument.
cleanup(ServletRequest, ServletResponse, Exception) - Method in class org.apache.shiro.web.filter.authc.AuthenticatingFilter
Overrides the default behavior to call AccessControlFilter.onAccessDenied(javax.servlet.ServletRequest, javax.servlet.ServletResponse, java.lang.Object) and swallow the exception if the exception is UnauthenticatedException.
cleanup(ServletRequest, ServletResponse, Exception) - Method in class org.apache.shiro.web.servlet.AdviceFilter
Executes cleanup logic in the finally code block in the doFilterInternal implementation.
clear() - Method in class org.apache.shiro.authc.UsernamePasswordToken
Clears out (nulls) the username, password, rememberMe, and inetAddress.
clear() - Method in interface org.apache.shiro.cache.Cache
Clear all entries from the cache.
clear() - Method in class org.apache.shiro.cache.ehcache.EhCache
Removes all elements in the cache, but leaves the cache in a useable state.
clear() - Method in class org.apache.shiro.cache.MapCache
 
clear() - Method in class org.apache.shiro.config.Ini
 
clear() - Method in class org.apache.shiro.config.Ini.Section
 
clear() - Method in interface org.apache.shiro.subject.MutablePrincipalCollection
Removes all Principals in this collection.
clear() - Method in class org.apache.shiro.subject.SimplePrincipalCollection
 
clear() - Method in class org.apache.shiro.subject.SimplePrincipalMap
 
clear() - Method in class org.apache.shiro.subject.support.SubjectThreadState
Completely removes the ThreadContext state.
clear() - Method in class org.apache.shiro.util.MapContext
 
clear() - Method in class org.apache.shiro.util.SoftHashMap
 
clear() - Method in interface org.apache.shiro.util.ThreadState
Completely clears/removes the ThreadContext state.
clear() - Method in class org.apache.shiro.web.filter.mgt.SimpleNamedFilterList
 
clearCache(PrincipalCollection) - Method in class org.apache.shiro.realm.CachingRealm
Clears out any cached data associated with the specified account identity/identities.
clearCachedAuthenticationInfo(PrincipalCollection) - Method in class org.apache.shiro.realm.AuthenticatingRealm
Clears out the AuthenticationInfo cache entry for the specified account.
clearCachedAuthorizationInfo(PrincipalCollection) - Method in class org.apache.shiro.realm.AuthorizingRealm
Clears out the AuthorizationInfo cache entry for the specified account.
close(InputStream) - Static method in class org.apache.shiro.io.ResourceUtils
Convenience method that closes the specified InputStream, logging any IOException that might occur.
closeConnection(Connection) - Static method in class org.apache.shiro.util.JdbcUtils
Close the given JDBC Connection and ignore any thrown exception.
closeContext(LdapContext) - Static method in class org.apache.shiro.realm.ldap.LdapUtils
Closes an LDAP context, logging any errors, but not throwing an exception if there is a failure.
closeEnumeration(NamingEnumeration) - Static method in class org.apache.shiro.realm.ldap.LdapUtils
 
closeResultSet(ResultSet) - Static method in class org.apache.shiro.util.JdbcUtils
Close the given JDBC ResultSet and ignore any thrown exception.
closeStatement(Statement) - Static method in class org.apache.shiro.util.JdbcUtils
Close the given JDBC Statement and ignore any thrown exception.
CodecException - Exception in org.apache.shiro.codec
Root exception related to issues during encoding or decoding.
CodecException() - Constructor for exception org.apache.shiro.codec.CodecException
Creates a new CodecException.
CodecException(String) - Constructor for exception org.apache.shiro.codec.CodecException
Creates a new CodecException.
CodecException(Throwable) - Constructor for exception org.apache.shiro.codec.CodecException
Creates a new CodecException.
CodecException(String, Throwable) - Constructor for exception org.apache.shiro.codec.CodecException
Creates a new CodecException.
CodecSupport - Class in org.apache.shiro.codec
Base abstract class that provides useful encoding and decoding operations, especially for character data.
CodecSupport() - Constructor for class org.apache.shiro.codec.CodecSupport
 
CollectionUtils - Class in org.apache.shiro.util
Static helper class for use dealing with Collections.
CollectionUtils() - Constructor for class org.apache.shiro.util.CollectionUtils
 
combine(ByteSource, ByteSource) - Method in class org.apache.shiro.crypto.hash.DefaultHashService
Combines the specified 'private' salt bytes with the specified additional extra bytes to use as the total salt during hash computation.
COMMENT_ATTRIBUTE_NAME - Static variable in class org.apache.shiro.web.servlet.SimpleCookie
 
COMMENT_POUND - Static variable in class org.apache.shiro.config.Ini
 
COMMENT_SEMICOLON - Static variable in class org.apache.shiro.config.Ini
 
computeHash(HashRequest) - Method in class org.apache.shiro.crypto.hash.DefaultHashService
Computes and responds with a hash based on the specified request.
computeHash(HashRequest) - Method in interface org.apache.shiro.crypto.hash.HashService
Computes a hash based on the given request.
ConcurrentAccessException - Exception in org.apache.shiro.authc
Thrown when an authentication attempt has been received for an account that has already been authenticated (i.e.
ConcurrentAccessException() - Constructor for exception org.apache.shiro.authc.ConcurrentAccessException
Creates a new ConcurrentAccessException.
ConcurrentAccessException(String) - Constructor for exception org.apache.shiro.authc.ConcurrentAccessException
Constructs a new ConcurrentAccessException.
ConcurrentAccessException(Throwable) - Constructor for exception org.apache.shiro.authc.ConcurrentAccessException
Constructs a new ConcurrentAccessException.
ConcurrentAccessException(String, Throwable) - Constructor for exception org.apache.shiro.authc.ConcurrentAccessException
Constructs a new ConcurrentAccessException.
config(Key<T>, String) - Static method in class org.apache.shiro.guice.web.ShiroWebModule
 
config(TypeLiteral<T>, String) - Static method in class org.apache.shiro.guice.web.ShiroWebModule
 
config(Class<T>, String) - Static method in class org.apache.shiro.guice.web.ShiroWebModule
 
CONFIG_INIT_PARAM_NAME - Static variable in class org.apache.shiro.web.servlet.IniShiroFilter
Deprecated.  
CONFIG_LOCATIONS_PARAM - Static variable in class org.apache.shiro.web.env.EnvironmentLoader
Servlet Context config param for the resource path to use for configuring the WebEnvironment instance: shiroConfigLocations
CONFIG_PATH_INIT_PARAM_NAME - Static variable in class org.apache.shiro.web.servlet.IniShiroFilter
Deprecated.  
ConfigurableHashService - Interface in org.apache.shiro.crypto.hash
A HashService that allows configuration of its strategy via JavaBeans-compatible setter methods.
ConfigurationException - Exception in org.apache.shiro.config
Root exception indicating there was a problem parsing or processing the Shiro configuration.
ConfigurationException() - Constructor for exception org.apache.shiro.config.ConfigurationException
Creates a new ConfigurationException.
ConfigurationException(String) - Constructor for exception org.apache.shiro.config.ConfigurationException
Constructs a new ConfigurationException.
ConfigurationException(Throwable) - Constructor for exception org.apache.shiro.config.ConfigurationException
Constructs a new ConfigurationException.
ConfigurationException(String, Throwable) - Constructor for exception org.apache.shiro.config.ConfigurationException
Constructs a new ConfigurationException.
configure() - Method in class org.apache.shiro.guice.aop.ShiroAopModule
 
configure() - Method in class org.apache.shiro.guice.ShiroModule
 
configure() - Method in class org.apache.shiro.web.env.IniWebEnvironment
 
configure() - Method in class org.apache.shiro.web.servlet.IniShiroFilter
Deprecated.  
configureDefaultInterceptors(AnnotationResolver) - Method in class org.apache.shiro.guice.aop.ShiroAopModule
 
configureInterceptors(AnnotationResolver) - Method in class org.apache.shiro.guice.aop.ShiroAopModule
 
configureShiro() - Method in class org.apache.shiro.guice.ShiroModule
Implement this method in order to configure your realms and any other Shiro customization you may need.
configureShiro() - Method in class org.apache.shiro.guice.web.ShiroWebModule
 
configureShiroWeb() - Method in class org.apache.shiro.guice.web.ShiroWebModule
 
CONTAINER_PREFIX - Static variable in class org.apache.shiro.jndi.JndiLocator
JNDI prefix used in a J2EE container
contains(Object) - Method in class org.apache.shiro.web.filter.mgt.SimpleNamedFilterList
 
containsAll(Collection<?>) - Method in class org.apache.shiro.web.filter.mgt.SimpleNamedFilterList
 
containsKey(Object) - Method in class org.apache.shiro.config.Ini
 
containsKey(Object) - Method in class org.apache.shiro.config.Ini.Section
 
containsKey(Object) - Method in class org.apache.shiro.subject.SimplePrincipalMap
 
containsKey(Object) - Method in class org.apache.shiro.util.MapContext
 
containsKey(Object) - Method in class org.apache.shiro.util.SoftHashMap
 
containsValue(Object) - Method in class org.apache.shiro.config.Ini
 
containsValue(Object) - Method in class org.apache.shiro.config.Ini.Section
 
containsValue(Object) - Method in class org.apache.shiro.subject.SimplePrincipalMap
 
containsValue(Object) - Method in class org.apache.shiro.util.MapContext
 
containsValue(Object) - Method in class org.apache.shiro.util.SoftHashMap
 
contextAttribute(String, Object) - Method in class org.apache.shiro.subject.Subject.Builder
Allows custom attributes to be added to the underlying context Map used to construct the Subject instance.
contextDestroyed(ServletContextEvent) - Method in class org.apache.shiro.web.env.EnvironmentLoaderListener
Destroys any previously created/bound WebEnvironment instance created by the EnvironmentLoaderListener.contextInitialized(javax.servlet.ServletContextEvent) method.
contextFactoryClassName - Variable in class org.apache.shiro.realm.ldap.DefaultLdapContextFactory
Deprecated.  
contextInitialized(ServletContextEvent) - Method in class org.apache.shiro.web.env.EnvironmentLoaderListener
Initializes the Shiro WebEnvironment and binds it to the ServletContext at application startup for future reference.
continueInvocation(Object) - Method in class org.apache.shiro.spring.security.interceptor.AopAllianceAnnotationsAuthorizingMethodInterceptor
Simply casts the method argument to an org.aopalliance.intercept.MethodInvocation and then calls methodInvocation.proceed()
convertBytesToPrincipals(byte[], SubjectContext) - Method in class org.apache.shiro.mgt.AbstractRememberMeManager
If a cipherService is available, it will be used to first decrypt the byte array.
convertConfigToIni(String) - Method in class org.apache.shiro.web.servlet.IniShiroFilter
Deprecated.  
convertJndiName(String) - Method in class org.apache.shiro.jndi.JndiLocator
Convert the given JNDI name into the actual JNDI name to use.
convertPathToIni(String) - Method in class org.apache.shiro.web.servlet.IniShiroFilter
Deprecated. Converts the specified file path to an Ini instance.
convertPrincipalsToBytes(PrincipalCollection) - Method in class org.apache.shiro.mgt.AbstractRememberMeManager
Converts the given principal collection the byte array that will be persisted to be 'remembered' later.
convertSaltToBytes(Object) - Method in class org.apache.shiro.crypto.hash.SimpleHash
Acquires the specified salt argument's bytes and returns them in the form of a ByteSource instance.
convertSourceToBytes(Object) - Method in class org.apache.shiro.crypto.hash.SimpleHash
Acquires the specified source argument's bytes and returns them in the form of a ByteSource instance.
Cookie - Interface in org.apache.shiro.web.servlet
Interface representing HTTP cookie operations, supporting pojo-style getters and setters for all attributes which includes HttpOnly support.
COOKIE_DATE_FORMAT_STRING - Static variable in class org.apache.shiro.web.servlet.SimpleCookie
 
COOKIE_HEADER_NAME - Static variable in class org.apache.shiro.web.servlet.SimpleCookie
 
COOKIE_SESSION_ID_SOURCE - Static variable in class org.apache.shiro.web.servlet.ShiroHttpServletRequest
 
CookieRememberMeManager - Class in org.apache.shiro.web.mgt
Remembers a Subject's identity by saving the Subject's principals to a Cookie for later retrieval.
CookieRememberMeManager() - Constructor for class org.apache.shiro.web.mgt.CookieRememberMeManager
Constructs a new CookieRememberMeManager with a default rememberMe cookie template.
copy(SubjectContext) - Method in class org.apache.shiro.mgt.DefaultSecurityManager
 
copy(SubjectContext) - Method in class org.apache.shiro.web.mgt.DefaultWebSecurityManager
 
create(Session) - Method in class org.apache.shiro.session.mgt.DefaultSessionManager
Persists the given session instance to an underlying EIS (Enterprise Information System).
create(Session) - Method in class org.apache.shiro.session.mgt.eis.AbstractSessionDAO
Creates the session by delegating EIS creation to subclasses via the AbstractSessionDAO.doCreate(org.apache.shiro.session.Session) method, and then asserting that the returned sessionId is not null.
create(Session) - Method in class org.apache.shiro.session.mgt.eis.CachingSessionDAO
Calls super.create(session), then caches the session keyed by the returned sessionId, and then returns this sessionId.
create(Session) - Method in interface org.apache.shiro.session.mgt.eis.SessionDAO
Inserts a new Session record into the underling EIS (e.g.
createActiveSessionsCache() - Method in class org.apache.shiro.session.mgt.eis.CachingSessionDAO
Creates a cache instance used to store active sessions.
createAnnotationResolver() - Method in class org.apache.shiro.guice.aop.ShiroAopModule
 
createAuthenticationInfo(AuthenticationToken, Object, Object, LdapContext) - Method in class org.apache.shiro.realm.ldap.JndiLdapRealm
Returns the AuthenticationInfo resulting from a Subject's successful LDAP authentication attempt.
createByteSource(Object) - Method in class org.apache.shiro.authc.credential.DefaultPasswordService
 
createCache(String) - Method in class org.apache.shiro.cache.AbstractCacheManager
Creates a new Cache instance associated with the specified name.
createCache(String) - Method in class org.apache.shiro.cache.MemoryConstrainedCacheManager
Returns a new MapCache instance backed by a SoftHashMap.
createChain(String, String) - Method in class org.apache.shiro.web.filter.mgt.DefaultFilterChainManager
 
createChain(String, String) - Method in interface org.apache.shiro.web.filter.mgt.FilterChainManager
Creates a filter chain for the given chainName with the specified chainDefinition String.
createChains(Map<String, String>, FilterChainManager) - Method in class org.apache.shiro.web.config.IniFilterChainResolverFactory
 
createDefaultInstance() - Method in class org.apache.shiro.config.IniFactorySupport
 
createDefaultInstance() - Method in class org.apache.shiro.config.IniSecurityManagerFactory
 
createDefaultInstance() - Method in class org.apache.shiro.web.config.IniFilterChainResolverFactory
 
createDefaultInstance() - Method in class org.apache.shiro.web.config.WebIniSecurityManagerFactory
Simply returns new DefaultWebSecurityManager(); to ensure a web-capable SecurityManager is available by default.
createDefaults(Ini, Ini.Section) - Method in class org.apache.shiro.config.IniSecurityManagerFactory
 
createDefaults(Ini, Ini.Section) - Method in class org.apache.shiro.web.config.WebIniSecurityManagerFactory
 
createDefaultSecurityManager() - Method in class org.apache.shiro.web.servlet.AbstractShiroFilter
 
createEnvironment(ServletContext) - Method in class org.apache.shiro.web.env.EnvironmentLoader
Instantiates a WebEnvironment based on the specified ServletContext.
createExposedSession(Session, SessionContext) - Method in class org.apache.shiro.session.mgt.AbstractNativeSessionManager
 
createExposedSession(Session, SessionKey) - Method in class org.apache.shiro.session.mgt.AbstractNativeSessionManager
 
createExposedSession(Session, SessionContext) - Method in class org.apache.shiro.web.session.mgt.DefaultWebSessionManager
 
createExposedSession(Session, SessionKey) - Method in class org.apache.shiro.web.session.mgt.DefaultWebSessionManager
 
createFilterChainManager() - Method in class org.apache.shiro.spring.web.ShiroFilterFactoryBean
 
createFilterChainResolver() - Method in class org.apache.shiro.web.env.IniWebEnvironment
 
createFrom(JoinPoint) - Static method in class org.apache.shiro.aspectj.BeforeAdviceMethodInvocationAdapter
Factory method that creates a new BeforeAdviceMethodInvocationAdapter instance using the AspectJ JoinPoint provided.
createHashRequest(ByteSource) - Method in class org.apache.shiro.authc.credential.DefaultPasswordService
 
createIni(String, boolean) - Method in class org.apache.shiro.web.env.IniWebEnvironment
Creates an Ini instance reflecting the specified path, or null if the path does not exist and is not required.
createInitialContext() - Method in class org.apache.shiro.jndi.JndiTemplate
Create a new JNDI initial context.
createInstance() - Method in class org.apache.shiro.config.IniFactorySupport
Creates a new object instance by using a configured INI source.
createInstance(Ini) - Method in class org.apache.shiro.config.IniFactorySupport
 
createInstance(Ini) - Method in class org.apache.shiro.config.IniSecurityManagerFactory
 
createInstance() - Method in class org.apache.shiro.spring.web.ShiroFilterFactoryBean
This implementation: Ensures the required securityManager property has been set Creates a FilterChainManager instance that reflects the configured filters and filter chain definitions Wraps the FilterChainManager with a suitable FilterChainResolver since the Shiro Filter implementations do not know of FilterChainManagers Sets both the SecurityManager and FilterChainResolver instances on a new Shiro Filter instance and returns that filter instance.
createInstance() - Method in class org.apache.shiro.util.AbstractFactory
 
createInstance(Ini) - Method in class org.apache.shiro.web.config.IniFilterChainResolverFactory
 
createInstanceMap(FilterConfig) - Static method in enum org.apache.shiro.web.filter.mgt.DefaultFilter
 
createLdapContext(Hashtable) - Method in class org.apache.shiro.realm.ldap.DefaultLdapContextFactory
Deprecated. Creates and returns a new InitialLdapContext instance.
createLdapContext(Hashtable) - Method in class org.apache.shiro.realm.ldap.JndiLdapContextFactory
Creates and returns a new InitialLdapContext instance.
createMethodInvocation(Object) - Method in class org.apache.shiro.spring.security.interceptor.AopAllianceAnnotationsAuthorizingMethodInterceptor
Creates a MethodInvocation that wraps an org.aopalliance.intercept.MethodInvocation instance, enabling Shiro Annotations in AOP Alliance environments (Spring, etc).
createNewInstance(Map<String, Object>, String, String) - Method in class org.apache.shiro.config.ReflectionBuilder
 
createRealm(Ini) - Method in class org.apache.shiro.config.IniSecurityManagerFactory
Creates a Realm from the Ini instance containing account data.
createRemoteInvocation(MethodInvocation) - Method in class org.apache.shiro.spring.remoting.SecureRemoteInvocationFactory
Creates a RemoteInvocation with the current session ID as an attribute.
createSession(SessionContext) - Method in class org.apache.shiro.session.mgt.AbstractNativeSessionManager
Creates a new Session Session instance based on the specified (possibly null) initialization data.
createSession(SessionContext) - Method in class org.apache.shiro.session.mgt.AbstractValidatingSessionManager
 
createSession(SessionContext) - Method in interface org.apache.shiro.session.mgt.SessionFactory
Creates a new Session instance based on the specified contextual initialization data.
createSession(SessionContext) - Method in class org.apache.shiro.session.mgt.SimpleSessionFactory
Creates a new SimpleSession instance retaining the context's host if one can be found.
createSession(SessionContext) - Method in class org.apache.shiro.web.session.mgt.ServletContainerSessionManager
 
createSession(HttpSession, String) - Method in class org.apache.shiro.web.session.mgt.ServletContainerSessionManager
 
createSessionContext(SubjectContext) - Method in class org.apache.shiro.mgt.DefaultSecurityManager
 
createSessionContext() - Method in class org.apache.shiro.subject.support.DelegatingSubject
 
createSessionContext(SubjectContext) - Method in class org.apache.shiro.web.mgt.DefaultWebSecurityManager
 
createSessionContext() - Method in class org.apache.shiro.web.subject.support.WebDelegatingSubject
 
createSessionManager(String) - Method in class org.apache.shiro.web.mgt.DefaultWebSecurityManager
 
createSessionValidationScheduler() - Method in class org.apache.shiro.session.mgt.AbstractValidatingSessionManager
 
createSubject(SubjectContext) - Method in class org.apache.shiro.cas.CasSubjectFactory
 
createSubject(AuthenticationToken, AuthenticationInfo, Subject) - Method in class org.apache.shiro.mgt.DefaultSecurityManager
Creates a Subject instance for the user represented by the given method arguments.
createSubject(SubjectContext) - Method in class org.apache.shiro.mgt.DefaultSecurityManager
This implementation functions as follows:

Ensures the SubjectContext is as populated as it can be, using heuristics to acquire data that may not have already been available to it (such as a referenced session or remembered principals). Calls DefaultSecurityManager.doCreateSubject(org.apache.shiro.subject.SubjectContext) to actually perform the Subject instance creation. calls save(subject) to ensure the constructed Subject's state is accessible for future requests/invocations if necessary. returns the constructed Subject instance.

createSubject(SubjectContext) - Method in class org.apache.shiro.mgt.DefaultSubjectFactory
 
createSubject(SubjectContext) - Method in interface org.apache.shiro.mgt.SecurityManager
Creates a Subject instance reflecting the specified contextual data.
createSubject(SubjectContext) - Method in interface org.apache.shiro.mgt.SubjectFactory
Creates a new Subject instance reflecting the state of the specified contextual data.
createSubject(SubjectContext) - Method in class org.apache.shiro.web.mgt.DefaultWebSubjectFactory
 
createSubject(ServletRequest, ServletResponse) - Method in class org.apache.shiro.web.servlet.AbstractShiroFilter
Creates a WebSubject instance to associate with the incoming request/response pair which will be used throughout the request/response execution.
createSubjectContext() - Method in class org.apache.shiro.mgt.DefaultSecurityManager
 
createSubjectContext() - Method in class org.apache.shiro.web.mgt.DefaultWebSecurityManager
 
createTicketValidator() - Method in class org.apache.shiro.cas.CasRealm
 
createToken(ServletRequest, ServletResponse) - Method in class org.apache.shiro.cas.CasFilter
The token created for this authentication is a CasToken containing the CAS service ticket received on the CAS service url (on which the filter must be configured).
createToken(ServletRequest, ServletResponse) - Method in class org.apache.shiro.web.filter.authc.AuthenticatingFilter
 
createToken(String, String, ServletRequest, ServletResponse) - Method in class org.apache.shiro.web.filter.authc.AuthenticatingFilter
 
createToken(String, String, boolean, String) - Method in class org.apache.shiro.web.filter.authc.AuthenticatingFilter
 
createToken(ServletRequest, ServletResponse) - Method in class org.apache.shiro.web.filter.authc.BasicHttpAuthenticationFilter
Creates an AuthenticationToken for use during login attempt with the provided credentials in the http header.
createToken(ServletRequest, ServletResponse) - Method in class org.apache.shiro.web.filter.authc.FormAuthenticationFilter
 
createWebSecurityManager() - Method in class org.apache.shiro.web.env.IniWebEnvironment
 
credentials - Variable in class org.apache.shiro.authc.SimpleAuthenticationInfo
The credentials verifying the account principals.
CredentialsException - Exception in org.apache.shiro.authc
Exception thrown due to a problem with the credential(s) submitted for an account during the authentication process.
CredentialsException() - Constructor for exception org.apache.shiro.authc.CredentialsException
Creates a new CredentialsException.
CredentialsException(String) - Constructor for exception org.apache.shiro.authc.CredentialsException
Constructs a new CredentialsException.
CredentialsException(Throwable) - Constructor for exception org.apache.shiro.authc.CredentialsException
Constructs a new CredentialsException.
CredentialsException(String, Throwable) - Constructor for exception org.apache.shiro.authc.CredentialsException
Constructs a new CredentialsException.
CredentialsMatcher - Interface in org.apache.shiro.authc.credential
Interface implemented by classes that can determine if an AuthenticationToken's provided credentials matches a corresponding account's credentials stored in the system.
credentialsSalt - Variable in class org.apache.shiro.authc.SimpleAuthenticationInfo
Any salt used in hashing the credentials.
CryptoException - Exception in org.apache.shiro.crypto
Base Shiro exception for problems encountered during cryptographic operations.
CryptoException(String) - Constructor for exception org.apache.shiro.crypto.CryptoException
 
CryptoException(Throwable) - Constructor for exception org.apache.shiro.crypto.CryptoException
 
CryptoException(String, Throwable) - Constructor for exception org.apache.shiro.crypto.CryptoException
 
currentRequest - Variable in class org.apache.shiro.web.servlet.ShiroHttpSession
 
customizeEnvironment(WebEnvironment) - Method in class org.apache.shiro.web.env.EnvironmentLoader
 

D

DataAccessException - Exception in org.apache.shiro.dao
Generic exception representing a problem when attempting to access data.
DataAccessException(String) - Constructor for exception org.apache.shiro.dao.DataAccessException
Constructs a DataAccessException with a message explaining the cause of the exception.
DataAccessException(String, Throwable) - Constructor for exception org.apache.shiro.dao.DataAccessException
Constructs a DataAccessException with a message explaining the cause of the exception.
dataSource - Variable in class org.apache.shiro.realm.jdbc.JdbcRealm
 
DAY_MILLIS - Static variable in class org.apache.shiro.web.servlet.SimpleCookie
 
decode(String) - Static method in class org.apache.shiro.codec.Base64
Converts the specified UTF-8 Base64 encoded String and decodes it to a raw Base64 decoded byte array.
decode(byte[]) - Static method in class org.apache.shiro.codec.Base64
Decodes Base64 data into octects
decode(byte[]) - Static method in class org.apache.shiro.codec.Hex
Converts an array of character bytes representing hexidecimal values into an array of bytes of those same values.
decode(String) - Static method in class org.apache.shiro.codec.Hex
Converts the specified Hex-encoded String into a raw byte array.
decode(char[]) - Static method in class org.apache.shiro.codec.Hex
Converts an array of characters representing hexidecimal values into an array of bytes of those same values.
decodeRequestString(HttpServletRequest, String) - Static method in class org.apache.shiro.web.util.WebUtils
Decode the given source string with a URLDecoder.
decodeToString(String) - Static method in class org.apache.shiro.codec.Base64
Converts the specified UTF-8 Base64 encoded String and decodes it to a resultant UTF-8 encoded string.
decodeToString(byte[]) - Static method in class org.apache.shiro.codec.Base64
Decodes the specified Base64 encoded byte array and returns the decoded result as a UTF-8 encoded.
decorate(Session) - Method in class org.apache.shiro.subject.support.DelegatingSubject
 
decrypt(byte[], byte[]) - Method in interface org.apache.shiro.crypto.CipherService
Decrypts encrypted data via the specified cipher key and returns the original (pre-encrypted) data.
decrypt(InputStream, OutputStream, byte[]) - Method in interface org.apache.shiro.crypto.CipherService
Receives encrypted data from the given InputStream, decrypts it, and sends the resulting decrypted data to the given OutputStream.
decrypt(byte[], byte[]) - Method in class org.apache.shiro.crypto.JcaCipherService
 
decrypt(InputStream, OutputStream, byte[]) - Method in class org.apache.shiro.crypto.JcaCipherService
 
decrypt(byte[]) - Method in class org.apache.shiro.mgt.AbstractRememberMeManager
Decrypts the byte array using the configured cipherService.
DEFAULT_AUTHENTICATION_QUERY - Static variable in class org.apache.shiro.realm.jdbc.JdbcRealm
The default query used to retrieve account data for the user.
DEFAULT_CASE_SENSITIVE - Static variable in class org.apache.shiro.authz.permission.WildcardPermission
 
DEFAULT_CHARACTER_ENCODING - Static variable in class org.apache.shiro.web.util.WebUtils
Default character encoding to use when request.getCharacterEncoding returns null, according to the Servlet spec.
DEFAULT_CHARSET_NAME - Static variable in class org.apache.shiro.config.Ini
 
DEFAULT_CONTEXT_FACTORY_CLASS_NAME - Static variable in class org.apache.shiro.realm.ldap.JndiLdapContextFactory
 
DEFAULT_DELIMITER_CHAR - Static variable in class org.apache.shiro.util.StringUtils
Constant representing the default delimiter character (comma), equal to ','
DEFAULT_ENCODING_SCHEME - Static variable in class org.apache.shiro.web.util.RedirectView
The default encoding scheme: UTF-8
DEFAULT_ERROR_KEY_ATTRIBUTE_NAME - Static variable in class org.apache.shiro.web.filter.authc.FormAuthenticationFilter
 
DEFAULT_GLOBAL_SESSION_TIMEOUT - Static variable in class org.apache.shiro.session.mgt.AbstractSessionManager
Default main session timeout value, equal to 30 minutes.
DEFAULT_HASH_ALGORITHM - Static variable in class org.apache.shiro.authc.credential.DefaultPasswordService
 
DEFAULT_HASH_ITERATIONS - Static variable in class org.apache.shiro.authc.credential.DefaultPasswordService
 
DEFAULT_HTTP_PORT - Static variable in class org.apache.shiro.web.filter.authz.PortFilter
 
DEFAULT_HTTPS_PORT - Static variable in class org.apache.shiro.web.filter.authz.SslFilter
 
DEFAULT_INI_RESOURCE_PATH - Static variable in class org.apache.shiro.config.IniFactorySupport
 
DEFAULT_LOGIN_URL - Static variable in class org.apache.shiro.web.filter.AccessControlFilter
Simple default login URL equal to /login.jsp, which can be overridden by calling the setLoginUrl method.
DEFAULT_MAX_AGE - Static variable in class org.apache.shiro.web.servlet.SimpleCookie
-1, indicating the cookie should expire when the browser closes.
DEFAULT_NEXT_BYTES_SIZE - Static variable in class org.apache.shiro.crypto.SecureRandomNumberGenerator
 
DEFAULT_PASSWORD_PARAM - Static variable in class org.apache.shiro.web.filter.authc.FormAuthenticationFilter
 
DEFAULT_PATH_SEPARATOR - Static variable in class org.apache.shiro.util.AntPathMatcher
Default path separator: "/"
DEFAULT_PERMISSIONS_QUERY - Static variable in class org.apache.shiro.realm.jdbc.JdbcRealm
The default query used to retrieve permissions that apply to a particular role.
DEFAULT_QUOTE_CHAR - Static variable in class org.apache.shiro.util.StringUtils
Constant representing the default quote character (double quote), equal to '"'
DEFAULT_REDIRECT_URL - Static variable in class org.apache.shiro.web.filter.authc.LogoutFilter
The default redirect URL to where the user will be redirected after logout.
DEFAULT_REFERRAL - Static variable in class org.apache.shiro.realm.ldap.JndiLdapContextFactory
 
DEFAULT_REMEMBER_ME_ATTRIBUTE_NAME - Static variable in class org.apache.shiro.cas.CasRealm
 
DEFAULT_REMEMBER_ME_COOKIE_NAME - Static variable in class org.apache.shiro.web.mgt.CookieRememberMeManager
The default name of the underlying rememberMe cookie which is rememberMe.
DEFAULT_REMEMBER_ME_PARAM - Static variable in class org.apache.shiro.web.filter.authc.FormAuthenticationFilter
 
DEFAULT_SALTED_AUTHENTICATION_QUERY - Static variable in class org.apache.shiro.realm.jdbc.JdbcRealm
The default query used to retrieve account data for the user when JdbcRealm.saltStyle is COLUMN.
DEFAULT_SECTION_NAME - Static variable in class org.apache.shiro.config.Ini
 
DEFAULT_SECURITY_MANAGER_KEY - Static variable in class org.apache.shiro.env.DefaultEnvironment
The default name under which the application's SecurityManager instance may be acquired, equal to securityManager.
DEFAULT_SESSION_ID_NAME - Static variable in class org.apache.shiro.web.servlet.ShiroHttpSession
 
DEFAULT_SESSION_VALIDATION_INTERVAL - Static variable in class org.apache.shiro.session.mgt.AbstractValidatingSessionManager
The default interval at which sessions will be validated (1 hour); This can be overridden by calling AbstractValidatingSessionManager.setSessionValidationInterval(long)
DEFAULT_SESSION_VALIDATION_INTERVAL - Static variable in class org.apache.shiro.session.mgt.quartz.QuartzSessionValidationScheduler
The default interval at which sessions will be validated (1 hour); This can be overridden by calling QuartzSessionValidationScheduler.setSessionValidationInterval(long)
DEFAULT_SUCCESS_URL - Static variable in class org.apache.shiro.web.filter.authc.AuthenticationFilter
 
DEFAULT_USER_ROLES_QUERY - Static variable in class org.apache.shiro.realm.jdbc.JdbcRealm
The default query used to retrieve the roles that apply to a user.
DEFAULT_USERNAME_PARAM - Static variable in class org.apache.shiro.web.filter.authc.FormAuthenticationFilter
 
DEFAULT_VALIDATION_PROTOCOL - Static variable in class org.apache.shiro.cas.CasRealm
 
DEFAULT_VERSION - Static variable in class org.apache.shiro.web.servlet.SimpleCookie
-1 indicating that no version property should be set on the cookie.
DEFAULT_WEB_INI_RESOURCE_PATH - Static variable in class org.apache.shiro.web.env.IniWebEnvironment
 
DEFAULT_WEB_INI_RESOURCE_PATH - Static variable in class org.apache.shiro.web.servlet.IniShiroFilter
Deprecated.  
DefaultAnnotationResolver - Class in org.apache.shiro.aop
Default AnnotationResolver implementation that merely inspects the MethodInvocation's target method, and returns targetMethod.getAnnotation(class).
DefaultAnnotationResolver() - Constructor for class org.apache.shiro.aop.DefaultAnnotationResolver
 
DefaultBlockCipherService - Class in org.apache.shiro.crypto
Base abstract class for block cipher algorithms.
DefaultBlockCipherService(String) - Constructor for class org.apache.shiro.crypto.DefaultBlockCipherService
Creates a new DefaultBlockCipherService using the specified block cipher algorithmName.
DefaultEnvironment - Class in org.apache.shiro.env
Simple/default Environment implementation that stores Shiro objects as key-value pairs in a Map instance.
DefaultEnvironment() - Constructor for class org.apache.shiro.env.DefaultEnvironment
Creates a new instance with a thread-safe ConcurrentHashMap backing map.
DefaultEnvironment(Map<String, ?>) - Constructor for class org.apache.shiro.env.DefaultEnvironment
Creates a new instance with the specified backing map.
DefaultFilter - Enum in org.apache.shiro.web.filter.mgt
Enum representing all of the default Shiro Filter instances available to web applications.
DefaultFilterChainManager - Class in org.apache.shiro.web.filter.mgt
Default FilterChainManager implementation maintaining a map of Filter instances (key: filter name, value: Filter) as well as a map of NamedFilterLists created from these Filters (key: filter chain name, value: NamedFilterList).
DefaultFilterChainManager() - Constructor for class org.apache.shiro.web.filter.mgt.DefaultFilterChainManager
 
DefaultFilterChainManager(FilterConfig) - Constructor for class org.apache.shiro.web.filter.mgt.DefaultFilterChainManager
 
DefaultHashFormatFactory - Class in org.apache.shiro.crypto.hash.format
This default HashFormatFactory implementation heuristically determines a HashFormat class to instantiate based on the input argument and returns a new instance of the discovered class.
DefaultHashFormatFactory() - Constructor for class org.apache.shiro.crypto.hash.format.DefaultHashFormatFactory
 
DefaultHashService - Class in org.apache.shiro.crypto.hash
Default implementation of the HashService interface, supporting a customizable hash algorithm name, secure-random salt generation, multiple hash iterations and an optional internal privateSalt.
DefaultHashService() - Constructor for class org.apache.shiro.crypto.hash.DefaultHashService
Constructs a new DefaultHashService instance with the following defaults: hashAlgorithmName = SHA-512 hashIterations = 1 randomNumberGenerator = new SecureRandomNumberGenerator() generatePublicSalt = false

If this hashService will be used for password hashing it is recommended to set the privateSalt and significantly increase the number of hashIterations.

DefaultLdapContextFactory - Class in org.apache.shiro.realm.ldap
Deprecated. replaced by the JndiLdapContextFactory implementation. This implementation will be removed prior to Shiro 2.0
DefaultLdapContextFactory() - Constructor for class org.apache.shiro.realm.ldap.DefaultLdapContextFactory
Deprecated.  
DefaultPasswordService - Class in org.apache.shiro.authc.credential
Default implementation of the PasswordService interface that relies on an internal HashService, HashFormat, and HashFormatFactory to function:
DefaultPasswordService() - Constructor for class org.apache.shiro.authc.credential.DefaultPasswordService
 
DefaultSecurityManager - Class in org.apache.shiro.mgt
The Shiro framework's default concrete implementation of the SecurityManager interface, based around a collection of Realms.
DefaultSecurityManager() - Constructor for class org.apache.shiro.mgt.DefaultSecurityManager
Default no-arg constructor.
DefaultSecurityManager(Realm) - Constructor for class org.apache.shiro.mgt.DefaultSecurityManager
Supporting constructor for a single-realm application.
DefaultSecurityManager(Collection<Realm>) - Constructor for class org.apache.shiro.mgt.DefaultSecurityManager
Supporting constructor for multiple realms.
DefaultSerializer<T> - Class in org.apache.shiro.io
Serializer implementation that uses the default JVM serialization mechanism (Object Input/Output Streams).
DefaultSerializer() - Constructor for class org.apache.shiro.io.DefaultSerializer
 
DefaultSessionContext - Class in org.apache.shiro.session.mgt
Default implementation of the SessionContext interface which provides getters and setters that wrap interaction with the underlying backing context map.
DefaultSessionContext() - Constructor for class org.apache.shiro.session.mgt.DefaultSessionContext
 
DefaultSessionContext(Map<String, Object>) - Constructor for class org.apache.shiro.session.mgt.DefaultSessionContext
 
DefaultSessionKey - Class in org.apache.shiro.session.mgt
Default implementation of the SessionKey interface, which allows setting and retrieval of a concrete sessionId that the SessionManager implementation can use to look up a Session instance.
DefaultSessionKey() - Constructor for class org.apache.shiro.session.mgt.DefaultSessionKey
 
DefaultSessionKey(Serializable) - Constructor for class org.apache.shiro.session.mgt.DefaultSessionKey
 
DefaultSessionManager - Class in org.apache.shiro.session.mgt
Default business-tier implementation of a ValidatingSessionManager.
DefaultSessionManager() - Constructor for class org.apache.shiro.session.mgt.DefaultSessionManager
 
DefaultSessionStorageEvaluator - Class in org.apache.shiro.mgt
A Default SessionStorageEvaluator that provides reasonable control over if and how Sessions may be used for storing Subject state.
DefaultSessionStorageEvaluator() - Constructor for class org.apache.shiro.mgt.DefaultSessionStorageEvaluator
 
DefaultSubjectContext - Class in org.apache.shiro.subject.support
Default implementation of the SubjectContext interface.
DefaultSubjectContext() - Constructor for class org.apache.shiro.subject.support.DefaultSubjectContext
 
DefaultSubjectContext(SubjectContext) - Constructor for class org.apache.shiro.subject.support.DefaultSubjectContext
 
DefaultSubjectDAO - Class in org.apache.shiro.mgt
Default SubjectDAO implementation that stores Subject state in the Subject's Session by default (but this can be disabled - see below).
DefaultSubjectDAO() - Constructor for class org.apache.shiro.mgt.DefaultSubjectDAO
 
DefaultSubjectFactory - Class in org.apache.shiro.mgt
Default SubjectFactory implementation that creates DelegatingSubject instances.
DefaultSubjectFactory() - Constructor for class org.apache.shiro.mgt.DefaultSubjectFactory
 
DefaultWebEnvironment - Class in org.apache.shiro.web.env
Default WebEnvironment implementation based on a backing Map instance.
DefaultWebEnvironment() - Constructor for class org.apache.shiro.web.env.DefaultWebEnvironment
 
DefaultWebSecurityManager - Class in org.apache.shiro.web.mgt
Default WebSecurityManager implementation used in web-based applications or any application that requires HTTP connectivity (SOAP, http remoting, etc).
DefaultWebSecurityManager() - Constructor for class org.apache.shiro.web.mgt.DefaultWebSecurityManager
 
DefaultWebSecurityManager(Realm) - Constructor for class org.apache.shiro.web.mgt.DefaultWebSecurityManager
 
DefaultWebSecurityManager(Collection<Realm>) - Constructor for class org.apache.shiro.web.mgt.DefaultWebSecurityManager
 
DefaultWebSessionContext - Class in org.apache.shiro.web.session.mgt
Default implementation of the WebSessionContext interface which provides getters and setters that wrap interaction with the underlying backing context map.
DefaultWebSessionContext() - Constructor for class org.apache.shiro.web.session.mgt.DefaultWebSessionContext
 
DefaultWebSessionContext(Map<String, Object>) - Constructor for class org.apache.shiro.web.session.mgt.DefaultWebSessionContext
 
DefaultWebSessionManager - Class in org.apache.shiro.web.session.mgt
Web-application capable SessionManager implementation.
DefaultWebSessionManager() - Constructor for class org.apache.shiro.web.session.mgt.DefaultWebSessionManager
 
DefaultWebSessionStorageEvaluator - Class in org.apache.shiro.web.mgt
A web-specific SessionStorageEvaluator that performs the same logic as the parent class DefaultSessionStorageEvaluator but additionally checks for a request-specific flag that may enable or disable session access.
DefaultWebSessionStorageEvaluator() - Constructor for class org.apache.shiro.web.mgt.DefaultWebSessionStorageEvaluator
 
DefaultWebSubjectContext - Class in org.apache.shiro.web.subject.support
Default WebSubjectContext implementation that provides for additional storage and retrieval of a ServletRequest and ServletResponse.
DefaultWebSubjectContext() - Constructor for class org.apache.shiro.web.subject.support.DefaultWebSubjectContext
 
DefaultWebSubjectContext(WebSubjectContext) - Constructor for class org.apache.shiro.web.subject.support.DefaultWebSubjectContext
 
DefaultWebSubjectFactory - Class in org.apache.shiro.web.mgt
A SubjectFactory implementation that creates WebDelegatingSubject instances.
DefaultWebSubjectFactory() - Constructor for class org.apache.shiro.web.mgt.DefaultWebSubjectFactory
 
delegate - Variable in class org.apache.shiro.session.ProxiedSession
The proxied instance
DelegatingSession - Class in org.apache.shiro.session.mgt
A DelegatingSession is a client-tier representation of a server side Session.
DelegatingSession(NativeSessionManager, SessionKey) - Constructor for class org.apache.shiro.session.mgt.DelegatingSession
 
DelegatingSubject - Class in org.apache.shiro.subject.support
Implementation of the Subject interface that delegates method calls to an underlying SecurityManager instance for security checks.
DelegatingSubject(SecurityManager) - Constructor for class org.apache.shiro.subject.support.DelegatingSubject
 
DelegatingSubject(PrincipalCollection, boolean, String, Session, SecurityManager) - Constructor for class org.apache.shiro.subject.support.DelegatingSubject
 
DelegatingSubject(PrincipalCollection, boolean, String, Session, boolean, SecurityManager) - Constructor for class org.apache.shiro.subject.support.DelegatingSubject
 
delete(Subject) - Method in class org.apache.shiro.mgt.DefaultSecurityManager
Removes (or 'unbinds') the Subject's state from the application, typically called during DefaultSecurityManager.logout(org.apache.shiro.subject.Subject)..
delete(Subject) - Method in class org.apache.shiro.mgt.DefaultSubjectDAO
Removes any existing subject state from the subject's session (if the session exists).
delete(Subject) - Method in interface org.apache.shiro.mgt.SubjectDAO
Removes any persisted state for the specified Subject instance.
delete(Session) - Method in class org.apache.shiro.session.mgt.DefaultSessionManager
 
delete(Session) - Method in class org.apache.shiro.session.mgt.eis.CachingSessionDAO
Removes the specified session from any cache and then permanently deletes the session from the EIS by delegating to CachingSessionDAO.doDelete(org.apache.shiro.session.Session).
delete(Session) - Method in class org.apache.shiro.session.mgt.eis.MemorySessionDAO
 
delete(Session) - Method in interface org.apache.shiro.session.mgt.eis.SessionDAO
Deletes the associated EIS record of the specified session.
DELETED_COOKIE_VALUE - Static variable in interface org.apache.shiro.web.servlet.Cookie
The value of deleted cookie (with the maxAge 0).
deserialize(byte[]) - Method in class org.apache.shiro.io.DefaultSerializer
This implementation deserializes the byte array using a ObjectInputStream using a source ByteArrayInputStream constructed with the argument byte array.
deserialize(byte[]) - Method in interface org.apache.shiro.io.Serializer
Converts the specified raw byte[] array back into an original Object form.
deserialize(byte[]) - Method in class org.apache.shiro.io.XmlSerializer
Deserializes the specified serialized source back into an Object by using a ByteArrayInputStream to wrap the argument and then decode this stream via an XMLDecoder, where the readObject call results in the original Object to return.
deserialize(byte[]) - Method in class org.apache.shiro.mgt.AbstractRememberMeManager
De-serializes the given byte array by using the serializer's deserialize method.
destroy() - Method in class org.apache.shiro.cache.AbstractCacheManager
Cleanup method that first destroys all of it's managed caches and then clears out the internally referenced cache map.
destroy() - Method in class org.apache.shiro.cache.ehcache.EhCacheManager
Shuts-down the wrapped Ehcache CacheManager only if implicitly created.
destroy() - Method in class org.apache.shiro.env.DefaultEnvironment
 
destroy() - Method in class org.apache.shiro.guice.ShiroModule
Destroys all beans created within this module that implement Destroyable.
destroy() - Method in class org.apache.shiro.mgt.AuthenticatingSecurityManager
 
destroy() - Method in class org.apache.shiro.mgt.AuthorizingSecurityManager
 
destroy() - Method in class org.apache.shiro.mgt.CachingSecurityManager
Destroys the cacheManager via LifecycleUtils.destroy.
destroy() - Method in class org.apache.shiro.mgt.RealmSecurityManager
 
destroy() - Method in class org.apache.shiro.mgt.SessionsSecurityManager
 
destroy() - Method in class org.apache.shiro.realm.text.PropertiesRealm
Destroy reload scheduler if one exists.
destroy() - Method in class org.apache.shiro.session.mgt.AbstractValidatingSessionManager
 
destroy() - Method in interface org.apache.shiro.util.Destroyable
Called when this object is being destroyed, allowing any necessary cleanup of internal resources.
destroy(Object) - Static method in class org.apache.shiro.util.LifecycleUtils
 
destroy(Destroyable) - Static method in class org.apache.shiro.util.LifecycleUtils
 
destroy(Collection) - Static method in class org.apache.shiro.util.LifecycleUtils
Calls destroy for each object in the collection.
destroy() - Method in class org.apache.shiro.web.servlet.AbstractFilter
Default no-op implementation that can be overridden by subclasses for custom cleanup behavior.
Destroyable - Interface in org.apache.shiro.util
Shiro container-agnostic interface that indicates that this object requires a callback during destruction.
destroyEnvironment(ServletContext) - Method in class org.apache.shiro.web.env.EnvironmentLoader
Destroys the WebEnvironment for the given servlet context.
determineEncoding(HttpServletRequest) - Static method in class org.apache.shiro.web.util.WebUtils
Determine the encoding for the given request.
determineWebEnvironmentClass(ServletContext) - Method in class org.apache.shiro.web.env.EnvironmentLoader
Return the WebEnvironment implementation class to use, either the default IniWebEnvironment or a custom class if specified.
DisabledAccountException - Exception in org.apache.shiro.authc
Thrown when attempting to authenticate and the corresponding account has been disabled for some reason.
DisabledAccountException() - Constructor for exception org.apache.shiro.authc.DisabledAccountException
Creates a new DisabledAccountException.
DisabledAccountException(String) - Constructor for exception org.apache.shiro.authc.DisabledAccountException
Constructs a new DisabledAccountException.
DisabledAccountException(Throwable) - Constructor for exception org.apache.shiro.authc.DisabledAccountException
Constructs a new DisabledAccountException.
DisabledAccountException(String, Throwable) - Constructor for exception org.apache.shiro.authc.DisabledAccountException
Constructs a new DisabledAccountException.
DisabledSessionException - Exception in org.apache.shiro.subject.support
Exception thrown if attempting to create a new Subject session, but that Subject's sessions are disabled.
DisabledSessionException(String) - Constructor for exception org.apache.shiro.subject.support.DisabledSessionException
 
disableSessionValidation() - Method in class org.apache.shiro.session.mgt.AbstractValidatingSessionManager
 
disableSessionValidation() - Method in class org.apache.shiro.session.mgt.ExecutorServiceSessionValidationScheduler
 
disableSessionValidation() - Method in class org.apache.shiro.session.mgt.quartz.QuartzSessionValidationScheduler
 
disableSessionValidation() - Method in interface org.apache.shiro.session.mgt.SessionValidationScheduler
Disables the session validation job.
doAuthenticate(AuthenticationToken) - Method in class org.apache.shiro.authc.AbstractAuthenticator
Template design pattern hook for subclasses to implement specific authentication behavior.
doAuthenticate(AuthenticationToken) - Method in class org.apache.shiro.authc.pam.ModularRealmAuthenticator
Attempts to authenticate the given token by iterating over the internal collection of Realms.
doCall(Callable<V>) - Method in class org.apache.shiro.subject.support.SubjectCallable
 
doClearCache(PrincipalCollection) - Method in class org.apache.shiro.realm.AuthenticatingRealm
This implementation clears out any cached authentication data by calling AuthenticatingRealm.clearCachedAuthenticationInfo(org.apache.shiro.subject.PrincipalCollection).
doClearCache(PrincipalCollection) - Method in class org.apache.shiro.realm.AuthorizingRealm
Calls super.doClearCache to ensure any cached authentication data is removed and then calls AuthorizingRealm.clearCachedAuthorizationInfo(org.apache.shiro.subject.PrincipalCollection) to remove any cached authorization data.
doClearCache(PrincipalCollection) - Method in class org.apache.shiro.realm.CachingRealm
This implementation does nothing - it is a template to be overridden by subclasses if necessary.
doCreate(Session) - Method in class org.apache.shiro.session.mgt.eis.AbstractSessionDAO
Subclass hook to actually persist the given Session instance to the underlying EIS.
doCreate(Session) - Method in class org.apache.shiro.session.mgt.eis.EnterpriseCacheSessionDAO
 
doCreate(Session) - Method in class org.apache.shiro.session.mgt.eis.MemorySessionDAO
 
doCreateSession(SessionContext) - Method in class org.apache.shiro.session.mgt.AbstractValidatingSessionManager
 
doCreateSession(SessionContext) - Method in class org.apache.shiro.session.mgt.DefaultSessionManager
 
doCreateSubject(SubjectContext) - Method in class org.apache.shiro.mgt.DefaultSecurityManager
Actually creates a Subject instance by delegating to the internal subjectFactory.
doCredentialsMatch(AuthenticationToken, AuthenticationInfo) - Method in class org.apache.shiro.authc.credential.AllowAllCredentialsMatcher
Returns true always no matter what the method arguments are.
doCredentialsMatch(AuthenticationToken, AuthenticationInfo) - Method in interface org.apache.shiro.authc.credential.CredentialsMatcher
Returns true if the provided token credentials match the stored account credentials, false otherwise.
doCredentialsMatch(AuthenticationToken, AuthenticationInfo) - Method in class org.apache.shiro.authc.credential.HashedCredentialsMatcher
This implementation first hashes the token's credentials, potentially using a salt if the info argument is a SaltedAuthenticationInfo.
doCredentialsMatch(AuthenticationToken, AuthenticationInfo) - Method in class org.apache.shiro.authc.credential.PasswordMatcher
 
doCredentialsMatch(AuthenticationToken, AuthenticationInfo) - Method in class org.apache.shiro.authc.credential.SimpleCredentialsMatcher
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.
doDelete(Session) - Method in class org.apache.shiro.session.mgt.eis.CachingSessionDAO
Subclass implementation hook to permanently delete the given Session from the underlying EIS.
doDelete(Session) - Method in class org.apache.shiro.session.mgt.eis.EnterpriseCacheSessionDAO
 
doFilter(ServletRequest, ServletResponse, FilterChain) - Method in class org.apache.shiro.web.servlet.OncePerRequestFilter
This doFilter implementation stores a request attribute for "already filtered", proceeding without filtering again if the attribute is already there.
doFilter(ServletRequest, ServletResponse) - Method in class org.apache.shiro.web.servlet.ProxiedFilterChain
 
doFilterInternal(ServletRequest, ServletResponse, FilterChain) - Method in class org.apache.shiro.web.servlet.AbstractShiroFilter
doFilterInternal implementation that sets-up, executes, and cleans-up a Shiro-filtered request.
doFilterInternal(ServletRequest, ServletResponse, FilterChain) - Method in class org.apache.shiro.web.servlet.AdviceFilter
Actually implements the chain execution logic, utilizing pre, post, and after advice hooks.
doFilterInternal(ServletRequest, ServletResponse, FilterChain) - Method in class org.apache.shiro.web.servlet.OncePerRequestFilter
Same contract as for OncePerRequestFilter.doFilter(javax.servlet.ServletRequest, javax.servlet.ServletResponse, javax.servlet.FilterChain), but guaranteed to be invoked only once per request.
doGetAuthenticationInfo(AuthenticationToken) - Method in class org.apache.shiro.cas.CasRealm
Authenticates a user and retrieves its information.
doGetAuthenticationInfo(AuthenticationToken) - Method in class org.apache.shiro.realm.AuthenticatingRealm
Retrieves authentication data from an implementation-specific datasource (RDBMS, LDAP, etc) for the given authentication token.
doGetAuthenticationInfo(AuthenticationToken) - Method in class org.apache.shiro.realm.jdbc.JdbcRealm
 
doGetAuthenticationInfo(AuthenticationToken) - Method in class org.apache.shiro.realm.ldap.AbstractLdapRealm
 
doGetAuthenticationInfo(AuthenticationToken) - Method in class org.apache.shiro.realm.ldap.JndiLdapRealm
Delegates to JndiLdapRealm.queryForAuthenticationInfo(org.apache.shiro.authc.AuthenticationToken, LdapContextFactory), wrapping any NamingExceptions in a Shiro AuthenticationException to satisfy the parent method signature.
doGetAuthenticationInfo(AuthenticationToken) - Method in class org.apache.shiro.realm.SimpleAccountRealm
 
doGetAuthorizationInfo(PrincipalCollection) - Method in class org.apache.shiro.cas.CasRealm
Retrieves the AuthorizationInfo for the given principals (the CAS previously authenticated user : id + attributes).
doGetAuthorizationInfo(PrincipalCollection) - Method in class org.apache.shiro.realm.AuthorizingRealm
Retrieves the AuthorizationInfo for the given principals from the underlying data store.
doGetAuthorizationInfo(PrincipalCollection) - Method in class org.apache.shiro.realm.jdbc.JdbcRealm
This implementation of the interface expects the principals collection to return a String username keyed off of this realm's name
doGetAuthorizationInfo(PrincipalCollection) - Method in class org.apache.shiro.realm.ldap.AbstractLdapRealm
 
doGetAuthorizationInfo(PrincipalCollection) - Method in class org.apache.shiro.realm.ldap.JndiLdapRealm
 
doGetAuthorizationInfo(PrincipalCollection) - Method in class org.apache.shiro.realm.SimpleAccountRealm
 
doGetSession(SessionKey) - Method in class org.apache.shiro.session.mgt.AbstractNativeSessionManager
 
doGetSession(SessionKey) - Method in class org.apache.shiro.session.mgt.AbstractValidatingSessionManager
 
doInContext(Context) - Method in interface org.apache.shiro.jndi.JndiCallback
Do something with the given JNDI context.
DOMAIN_ATTRIBUTE_NAME - Static variable in class org.apache.shiro.web.servlet.SimpleCookie
 
DomainPermission - Class in org.apache.shiro.authz.permission
Provides a base Permission class from which type-safe/domain-specific subclasses may extend.
DomainPermission() - Constructor for class org.apache.shiro.authz.permission.DomainPermission
Creates a domain permission with *all* actions for *all* targets;
DomainPermission(String) - Constructor for class org.apache.shiro.authz.permission.DomainPermission
 
DomainPermission(String, String) - Constructor for class org.apache.shiro.authz.permission.DomainPermission
 
DomainPermission(Set<String>, Set<String>) - Constructor for class org.apache.shiro.authz.permission.DomainPermission
 
doMatch(String, String, boolean) - Method in class org.apache.shiro.util.AntPathMatcher
Actually match the given path against the given pattern.
doMultiRealmAuthentication(Collection<Realm>, AuthenticationToken) - Method in class org.apache.shiro.authc.pam.ModularRealmAuthenticator
Performs the multi-realm authentication attempt by calling back to a AuthenticationStrategy object as each realm is consulted for AuthenticationInfo for the specified token.
doReadSession(Serializable) - Method in class org.apache.shiro.session.mgt.eis.AbstractSessionDAO
Subclass implementation hook that retrieves the Session object from the underlying EIS or null if a session with that ID could not be found.
doReadSession(Serializable) - Method in class org.apache.shiro.session.mgt.eis.EnterpriseCacheSessionDAO
 
doReadSession(Serializable) - Method in class org.apache.shiro.session.mgt.eis.MemorySessionDAO
 
doRun(Runnable) - Method in class org.apache.shiro.subject.support.SubjectRunnable
Simply calls the target Runnable's run() method.
doSingleRealmAuthentication(Realm, AuthenticationToken) - Method in class org.apache.shiro.authc.pam.ModularRealmAuthenticator
Performs the authentication attempt by interacting with the single configured realm, which is significantly simpler than performing multi-realm logic.
doStartTag() - Method in class org.apache.shiro.web.tags.SecureTag
 
doUpdate(Session) - Method in class org.apache.shiro.session.mgt.eis.CachingSessionDAO
Subclass implementation hook to actually persist the Session's state to the underlying EIS.
doUpdate(Session) - Method in class org.apache.shiro.session.mgt.eis.EnterpriseCacheSessionDAO
 
doValidate(Session) - Method in class org.apache.shiro.session.mgt.AbstractValidatingSessionManager
 

E

EhCache<K,V> - Class in org.apache.shiro.cache.ehcache
Shiro Cache implementation that wraps an Ehcache instance.
EhCache(Ehcache) - Constructor for class org.apache.shiro.cache.ehcache.EhCache
Constructs a new EhCache instance with the given cache.
EhCacheManager - Class in org.apache.shiro.cache.ehcache
Shiro CacheManager implementation utilizing the Ehcache framework for all cache functionality.
EhCacheManager() - Constructor for class org.apache.shiro.cache.ehcache.EhCacheManager
Default no argument constructor
EMPTY_STRING - Static variable in class org.apache.shiro.util.StringUtils
Constant representing the empty string, equal to ""
enableSessionValidation() - Method in class org.apache.shiro.session.mgt.AbstractValidatingSessionManager
 
enableSessionValidation() - Method in class org.apache.shiro.session.mgt.ExecutorServiceSessionValidationScheduler
Creates a single thread ScheduledExecutorService to validate sessions at fixed intervals and enables this scheduler.
enableSessionValidation() - Method in class org.apache.shiro.session.mgt.quartz.QuartzSessionValidationScheduler
Starts session validation by creating a Quartz simple trigger, linking it to the QuartzSessionValidationJob, and scheduling it with the Quartz scheduler.
enableSessionValidation() - Method in interface org.apache.shiro.session.mgt.SessionValidationScheduler
Enables the session validation job.
encode(byte[]) - Static method in class org.apache.shiro.codec.Base64
Encodes a byte[] containing binary data, into a byte[] containing characters in the Base64 alphabet.
encode(byte[], boolean) - Static method in class org.apache.shiro.codec.Base64
Encodes binary data using the base64 algorithm, optionally chunking the output into 76 character blocks.
encode(byte[]) - Static method in class org.apache.shiro.codec.Hex
Converts an array of bytes into an array of characters representing the hexidecimal values of each byte in order.
encodeChunked(byte[]) - Static method in class org.apache.shiro.codec.Base64
Encodes binary data using the base64 algorithm and chunks the encoded output into 76 character blocks
encodeRedirectURL(String) - Method in class org.apache.shiro.web.servlet.ShiroHttpServletResponse
Encode the session identifier associated with this response into the specified redirect URL, if necessary.
encodeRedirectUrl(String) - Method in class org.apache.shiro.web.servlet.ShiroHttpServletResponse
 
encodeToString(byte[]) - Static method in class org.apache.shiro.codec.Base64
Base64 encodes the specified byte array and then encodes it as a String using Shiro's preferred character encoding (UTF-8).
encodeToString(byte[]) - Static method in class org.apache.shiro.codec.H64
Encodes the specified bytes to an H64-encoded String.
encodeToString(byte[]) - Static method in class org.apache.shiro.codec.Hex
Encodes the specifed byte array to a character array and then returns that character array as a String.
encodeURL(String) - Method in class org.apache.shiro.web.servlet.ShiroHttpServletResponse
Encode the session identifier associated with this response into the specified URL, if necessary.
encodeUrl(String) - Method in class org.apache.shiro.web.servlet.ShiroHttpServletResponse
 
encrypt(byte[], byte[]) - Method in interface org.apache.shiro.crypto.CipherService
Encrypts data via the specified cipher key.
encrypt(InputStream, OutputStream, byte[]) - Method in interface org.apache.shiro.crypto.CipherService
Receives the data from the given InputStream, encrypts it, and sends the resulting encrypted data to the given OutputStream.
encrypt(byte[], byte[]) - Method in class org.apache.shiro.crypto.JcaCipherService
 
encrypt(InputStream, OutputStream, byte[]) - Method in class org.apache.shiro.crypto.JcaCipherService
 
encrypt(byte[]) - Method in class org.apache.shiro.mgt.AbstractRememberMeManager
Encrypts the byte array by using the configured cipherService.
encryptPassword(Object) - Method in class org.apache.shiro.authc.credential.DefaultPasswordService
 
encryptPassword(Object) - Method in interface org.apache.shiro.authc.credential.PasswordService
Converts the specified plaintext password (usually acquired from your application's 'new user' or 'password reset' workflow) into a formatted string safe for storage.
ensureChain(String) - Method in class org.apache.shiro.web.filter.mgt.DefaultFilterChainManager
 
ensureCombinedPrincipals() - Method in class org.apache.shiro.subject.SimplePrincipalMap
 
ensureSecureRandom() - Method in class org.apache.shiro.crypto.JcaCipherService
 
ensureSecurityManager(SubjectContext) - Method in class org.apache.shiro.mgt.DefaultSecurityManager
Determines if there is a SecurityManager instance in the context, and if not, adds 'this' to the context.
ensureTicketValidator() - Method in class org.apache.shiro.cas.CasRealm
 
EnterpriseCacheSessionDAO - Class in org.apache.shiro.session.mgt.eis
SessionDAO implementation that relies on an enterprise caching product as the EIS system of record for all sessions.
EnterpriseCacheSessionDAO() - Constructor for class org.apache.shiro.session.mgt.eis.EnterpriseCacheSessionDAO
 
entrySet() - Method in class org.apache.shiro.config.Ini
 
entrySet() - Method in class org.apache.shiro.config.Ini.Section
 
entrySet() - Method in class org.apache.shiro.subject.SimplePrincipalMap
 
entrySet() - Method in class org.apache.shiro.util.MapContext
 
entrySet() - Method in class org.apache.shiro.util.SoftHashMap
 
Environment - Interface in org.apache.shiro.env
An Environment instance encapsulates all of the objects that Shiro requires to function.
ENVIRONMENT_ATTRIBUTE_KEY - Static variable in class org.apache.shiro.web.env.EnvironmentLoader
 
ENVIRONMENT_CLASS_PARAM - Static variable in class org.apache.shiro.web.env.EnvironmentLoader
Servlet Context config param for specifying the WebEnvironment implementation class to use: shiroEnvironmentClass
EnvironmentException - Exception in org.apache.shiro.env
Exception thrown for errors related to Environment instances or configuration.
EnvironmentException(String) - Constructor for exception org.apache.shiro.env.EnvironmentException
 
EnvironmentException(String, Throwable) - Constructor for exception org.apache.shiro.env.EnvironmentException
 
EnvironmentLoader - Class in org.apache.shiro.web.env
An EnvironmentLoader is responsible for loading a web application's Shiro WebEnvironment (which includes the web app's WebSecurityManager) into the ServletContext at application startup.
EnvironmentLoader() - Constructor for class org.apache.shiro.web.env.EnvironmentLoader
 
EnvironmentLoaderListener - Class in org.apache.shiro.web.env
Bootstrap listener to startup and shutdown the web application's Shiro WebEnvironment at ServletContext startup and shutdown respectively.
EnvironmentLoaderListener() - Constructor for class org.apache.shiro.web.env.EnvironmentLoaderListener
 
equals(Object, Object) - Method in class org.apache.shiro.authc.credential.SimpleCredentialsMatcher
Returns true if the tokenCredentials argument is logically equal to the accountCredentials argument.
equals(Object) - Method in class org.apache.shiro.authc.SimpleAccount
Returns true if the specified object is also a SimpleAccount and its principals are equal to this object's principals, false otherwise.
equals(Object) - Method in class org.apache.shiro.authc.SimpleAuthenticationInfo
Returns true if the Object argument is an instanceof SimpleAuthenticationInfo and its principals are equal to this instance's principals, false otherwise.
equals(Object) - Method in class org.apache.shiro.authz.permission.WildcardPermission
 
equals(Object) - Method in class org.apache.shiro.authz.SimpleRole
 
equals(Object) - Method in class org.apache.shiro.config.Ini
 
equals(Object) - Method in class org.apache.shiro.config.Ini.Section
 
equals(Object) - Method in class org.apache.shiro.crypto.hash.AbstractHash
Deprecated. Returns true if the specified object is a Hash and its byte array is identical to this Hash's byte array, false otherwise.
equals(Object) - Method in class org.apache.shiro.crypto.hash.SimpleHash
Returns true if the specified object is a Hash and its byte array is identical to this Hash's byte array, false otherwise.
equals(Object) - Method in class org.apache.shiro.session.mgt.SimpleSession
Returns true if the specified argument is an instanceof SimpleSession and both ids are equal.
equals(Object) - Method in class org.apache.shiro.subject.SimplePrincipalCollection
 
equals(Object) - Method in class org.apache.shiro.util.SimpleByteSource
 
ESCAPE_TOKEN - Static variable in class org.apache.shiro.config.Ini
 
ExcessiveAttemptsException - Exception in org.apache.shiro.authc
Thrown when a system is configured to only allow a certain number of authentication attempts over a period of time and the current session has failed to authenticate successfully within that number.
ExcessiveAttemptsException() - Constructor for exception org.apache.shiro.authc.ExcessiveAttemptsException
Creates a new ExcessiveAttemptsException.
ExcessiveAttemptsException(String) - Constructor for exception org.apache.shiro.authc.ExcessiveAttemptsException
Constructs a new ExcessiveAttemptsException.
ExcessiveAttemptsException(Throwable) - Constructor for exception org.apache.shiro.authc.ExcessiveAttemptsException
Constructs a new ExcessiveAttemptsException.
ExcessiveAttemptsException(String, Throwable) - Constructor for exception org.apache.shiro.authc.ExcessiveAttemptsException
Constructs a new ExcessiveAttemptsException.
execute(Runnable) - Method in class org.apache.shiro.concurrent.SubjectAwareExecutor
Executes the specified runnable by first associating it with the currently executing Subject and then dispatches the associated Runnable to the underlying target Executor instance.
execute(JndiCallback) - Method in class org.apache.shiro.jndi.JndiTemplate
Execute the given JNDI context callback implementation.
execute(JobExecutionContext) - Method in class org.apache.shiro.session.mgt.quartz.QuartzSessionValidationJob
Called when the job is executed by quartz.
execute(Callable<V>) - Method in interface org.apache.shiro.subject.Subject
Associates the specified Callable with this Subject instance and then executes it on the currently running thread.
execute(Runnable) - Method in interface org.apache.shiro.subject.Subject
Associates the specified Runnable with this Subject instance and then executes it on the currently running thread.
execute(Callable<V>) - Method in class org.apache.shiro.subject.support.DelegatingSubject
 
execute(Runnable) - Method in class org.apache.shiro.subject.support.DelegatingSubject
 
executeChain(ServletRequest, ServletResponse, FilterChain) - Method in class org.apache.shiro.web.servlet.AbstractShiroFilter
Executes a FilterChain for the given request.
executeChain(ServletRequest, ServletResponse, FilterChain) - Method in class org.apache.shiro.web.servlet.AdviceFilter
Actually executes the specified filter chain by calling chain.doFilter(request,response);.
executeLogin(ServletRequest, ServletResponse) - Method in class org.apache.shiro.web.filter.authc.AuthenticatingFilter
 
ExecutionException - Exception in org.apache.shiro.subject
Exception wrapping any potential checked exception thrown when a Subject executes a Callable.
ExecutionException(Throwable) - Constructor for exception org.apache.shiro.subject.ExecutionException
 
ExecutionException(String, Throwable) - Constructor for exception org.apache.shiro.subject.ExecutionException
 
ExecutorServiceSessionValidationScheduler - Class in org.apache.shiro.session.mgt
SessionValidationScheduler implementation that uses a ScheduledExecutorService to call ValidatingSessionManager.validateSessions() every interval milliseconds.
ExecutorServiceSessionValidationScheduler() - Constructor for class org.apache.shiro.session.mgt.ExecutorServiceSessionValidationScheduler
 
ExecutorServiceSessionValidationScheduler(ValidatingSessionManager) - Constructor for class org.apache.shiro.session.mgt.ExecutorServiceSessionValidationScheduler
 
expire() - Method in class org.apache.shiro.session.mgt.SimpleSession
 
ExpiredCredentialsException - Exception in org.apache.shiro.authc
Thrown during the authentication process when the system determines the submitted credential(s) has expired and will not allow login.
ExpiredCredentialsException() - Constructor for exception org.apache.shiro.authc.ExpiredCredentialsException
Creates a new ExpiredCredentialsException.
ExpiredCredentialsException(String) - Constructor for exception org.apache.shiro.authc.ExpiredCredentialsException
Constructs a new ExpiredCredentialsException.
ExpiredCredentialsException(Throwable) - Constructor for exception org.apache.shiro.authc.ExpiredCredentialsException
Constructs a new ExpiredCredentialsException.
ExpiredCredentialsException(String, Throwable) - Constructor for exception org.apache.shiro.authc.ExpiredCredentialsException
Constructs a new ExpiredCredentialsException.
ExpiredSessionException - Exception in org.apache.shiro.session
A special case of a StoppedSessionException.
ExpiredSessionException() - Constructor for exception org.apache.shiro.session.ExpiredSessionException
Creates a new ExpiredSessionException.
ExpiredSessionException(String) - Constructor for exception org.apache.shiro.session.ExpiredSessionException
Constructs a new ExpiredSessionException.
ExpiredSessionException(Throwable) - Constructor for exception org.apache.shiro.session.ExpiredSessionException
Constructs a new ExpiredSessionException.
ExpiredSessionException(String, Throwable) - Constructor for exception org.apache.shiro.session.ExpiredSessionException
Constructs a new ExpiredSessionException.
EXPIRES_ATTRIBUTE_NAME - Static variable in class org.apache.shiro.web.servlet.SimpleCookie
 
extractPathWithinPattern(String, String) - Method in class org.apache.shiro.util.AntPathMatcher
Given a pattern and a full path, determine the pattern-mapped part.

F

Factory<T> - Interface in org.apache.shiro.util
Generics-aware interface supporting the Factory Method design pattern.
FILE_PREFIX - Static variable in class org.apache.shiro.io.ResourceUtils
Resource path prefix that specifies to load from a file location, value is file:
fileLastModified - Variable in class org.apache.shiro.realm.text.PropertiesRealm
 
FilterChainManager - Interface in org.apache.shiro.web.filter.mgt
A FilterChainManager manages the creation and modification of Filter chains from an available pool of Filter instances.
FilterChainResolver - Interface in org.apache.shiro.web.filter.mgt
A FilterChainResolver can resolve an appropriate FilterChain to execute during a ServletRequest.
filterConfig - Variable in class org.apache.shiro.web.servlet.AbstractFilter
FilterConfig provided by the Servlet container at start-up.
FILTERS - Static variable in class org.apache.shiro.web.config.IniFilterChainResolverFactory
 
FirstSuccessfulStrategy - Class in org.apache.shiro.authc.pam
AuthenticationStrategy implementation that only accepts the account data from the first successfully consulted Realm and ignores all subsequent realms.
FirstSuccessfulStrategy() - Constructor for class org.apache.shiro.authc.pam.FirstSuccessfulStrategy
 
forgetIdentity(Subject) - Method in class org.apache.shiro.mgt.AbstractRememberMeManager
Forgets (removes) any remembered identity data for the specified Subject instance.
forgetIdentity(SubjectContext) - Method in interface org.apache.shiro.mgt.RememberMeManager
Forgets any remembered identity corresponding to the subject context map being used to build a subject instance.
forgetIdentity(Subject) - Method in class org.apache.shiro.web.mgt.CookieRememberMeManager
Removes the 'rememberMe' cookie from the associated WebSubject's request/response pair.
forgetIdentity(SubjectContext) - Method in class org.apache.shiro.web.mgt.CookieRememberMeManager
Removes the 'rememberMe' cookie from the associated WebSubjectContext's request/response pair.
format(Hash) - Method in class org.apache.shiro.crypto.hash.format.Base64Format
Returns hash != null ? hash.toBase64() : null.
format(Hash) - Method in interface org.apache.shiro.crypto.hash.format.HashFormat
Returns a formatted string representing the specified Hash instance.
format(Hash) - Method in class org.apache.shiro.crypto.hash.format.HexFormat
Returns hash != null ? hash.toHex() : null.
format(Hash) - Method in class org.apache.shiro.crypto.hash.format.Shiro1CryptFormat
 
FormAuthenticationFilter - Class in org.apache.shiro.web.filter.authc
Requires the requesting user to be authenticated for the request to continue, and if they are not, forces the user to login via by redirecting them to the loginUrl you configure.
FormAuthenticationFilter() - Constructor for class org.apache.shiro.web.filter.authc.FormAuthenticationFilter
 
forName(String) - Static method in class org.apache.shiro.util.ClassUtils
Attempts to load the specified class name from the current thread's context class loader, then the current ClassLoader (ClassUtils.class.getClassLoader()), then the system/application ClassLoader (ClassLoader.getSystemClassLoader(), in that order.
FORWARD_CONTEXT_PATH_ATTRIBUTE - Static variable in class org.apache.shiro.web.util.WebUtils
 
FORWARD_PATH_INFO_ATTRIBUTE - Static variable in class org.apache.shiro.web.util.WebUtils
 
FORWARD_QUERY_STRING_ATTRIBUTE - Static variable in class org.apache.shiro.web.util.WebUtils
 
FORWARD_REQUEST_URI_ATTRIBUTE - Static variable in class org.apache.shiro.web.util.WebUtils
Standard Servlet 2.4+ spec request attributes for forward URI and paths.
FORWARD_SERVLET_PATH_ATTRIBUTE - Static variable in class org.apache.shiro.web.util.WebUtils
 
fromBase64String(String) - Static method in class org.apache.shiro.crypto.hash.Md2Hash
 
fromBase64String(String) - Static method in class org.apache.shiro.crypto.hash.Md5Hash
 
fromBase64String(String) - Static method in class org.apache.shiro.crypto.hash.Sha1Hash
 
fromBase64String(String) - Static method in class org.apache.shiro.crypto.hash.Sha256Hash
 
fromBase64String(String) - Static method in class org.apache.shiro.crypto.hash.Sha384Hash
 
fromBase64String(String) - Static method in class org.apache.shiro.crypto.hash.Sha512Hash
 
fromHexString(String) - Static method in class org.apache.shiro.crypto.hash.Md2Hash
 
fromHexString(String) - Static method in class org.apache.shiro.crypto.hash.Md5Hash
 
fromHexString(String) - Static method in class org.apache.shiro.crypto.hash.Sha1Hash
 
fromHexString(String) - Static method in class org.apache.shiro.crypto.hash.Sha256Hash
 
fromHexString(String) - Static method in class org.apache.shiro.crypto.hash.Sha384Hash
 
fromHexString(String) - Static method in class org.apache.shiro.crypto.hash.Sha512Hash
 
fromRealm(String) - Method in interface org.apache.shiro.subject.PrincipalCollection
Returns a single Subject's principals retrieved from the specified Realm only as a Collection, or an empty Collection if there are not any principals from that realm.
fromRealm(String) - Method in class org.apache.shiro.subject.SimplePrincipalCollection
 
fromRealm(String) - Method in class org.apache.shiro.subject.SimplePrincipalMap
 
fromResourcePath(String) - Static method in class org.apache.shiro.config.Ini
Creates a new Ini instance loaded with the INI-formatted data in the resource at the given path.

G

generateId(Session) - Method in class org.apache.shiro.session.mgt.eis.JavaUuidSessionIdGenerator
Ignores the method argument and simply returns UUID.randomUUID().toString().
generateId(Session) - Method in class org.apache.shiro.session.mgt.eis.RandomSessionIdGenerator
Returns the String value of the configured Random's nextLong() invocation.
generateId(Session) - Method in interface org.apache.shiro.session.mgt.eis.SessionIdGenerator
Generates a new ID to be applied to the specified Session instance.
generateInitializationVector(boolean) - Method in class org.apache.shiro.crypto.DefaultBlockCipherService
 
generateInitializationVector(boolean) - Method in class org.apache.shiro.crypto.JcaCipherService
 
generateNewKey() - Method in class org.apache.shiro.crypto.AbstractSymmetricCipherService
Generates a new Key suitable for this CipherService's algorithm by calling generateNewKey(128) (uses a 128 bit size by default).
generateNewKey(int) - Method in class org.apache.shiro.crypto.AbstractSymmetricCipherService
Generates a new Key of the specified size suitable for this CipherService (based on the algorithmName using the JDK KeyGenerator.
generateSessionId(Session) - Method in class org.apache.shiro.session.mgt.eis.AbstractSessionDAO
Generates a new ID to be applied to the specified session instance.
get(K) - Method in interface org.apache.shiro.cache.Cache
Returns the Cached value stored under the specified key or null if there is no Cache entry for that key.
get(K) - Method in class org.apache.shiro.cache.ehcache.EhCache
Gets a value of an element which matches the given key.
get(K) - Method in class org.apache.shiro.cache.MapCache
 
get(Object) - Method in class org.apache.shiro.config.Ini
 
get(Object) - Method in class org.apache.shiro.config.Ini.Section
 
get(Object) - Method in class org.apache.shiro.subject.SimplePrincipalMap
 
get(Object) - Method in class org.apache.shiro.util.MapContext
 
get(Object) - Method in class org.apache.shiro.util.SoftHashMap
 
get(Object) - Static method in class org.apache.shiro.util.ThreadContext
Returns the object for the specified key that is bound to the current thread.
get(int) - Method in class org.apache.shiro.web.filter.mgt.SimpleNamedFilterList
 
GET_METHOD - Static variable in class org.apache.shiro.web.filter.AccessControlFilter
Constant representing the HTTP 'GET' request method, equal to GET.
getActions() - Method in class org.apache.shiro.authz.permission.DomainPermission
 
getActiveSessions() - Method in class org.apache.shiro.session.mgt.AbstractValidatingSessionManager
 
getActiveSessions() - Method in class org.apache.shiro.session.mgt.DefaultSessionManager
 
getActiveSessions() - Method in class org.apache.shiro.session.mgt.eis.CachingSessionDAO
Returns all active sessions in the system.
getActiveSessions() - Method in class org.apache.shiro.session.mgt.eis.MemorySessionDAO
 
getActiveSessions() - Method in interface org.apache.shiro.session.mgt.eis.SessionDAO
Returns all sessions in the EIS that are considered active, meaning all sessions that haven't been stopped/expired.
getActiveSessionsCache() - Method in class org.apache.shiro.session.mgt.eis.CachingSessionDAO
Returns the cache instance to use for storing active sessions.
getActiveSessionsCacheName() - Method in class org.apache.shiro.session.mgt.eis.CachingSessionDAO
Returns the name of the actives sessions cache to be returned by the CacheManager.
getAlgorithmName() - Method in class org.apache.shiro.crypto.hash.AbstractHash
Deprecated. Implemented by subclasses, this specifies the MessageDigest algorithm name to use when performing the hash.
getAlgorithmName(HashRequest) - Method in class org.apache.shiro.crypto.hash.DefaultHashService
 
getAlgorithmName() - Method in interface org.apache.shiro.crypto.hash.Hash
Returns the name of the algorithm used to hash the input source, for example, SHA-256, MD5, etc.
getAlgorithmName() - Method in interface org.apache.shiro.crypto.hash.HashRequest
Returns the name of the hash algorithm the HashService should use when computing the Hash, or null if the default algorithm configuration of the HashService should be used.
getAlgorithmName() - Method in class org.apache.shiro.crypto.hash.SimpleHash
Returns the MessageDigest algorithm name to use when performing the hash.
getAlgorithmName() - Method in class org.apache.shiro.crypto.hash.SimpleHashRequest
 
getAlgorithmName() - Method in class org.apache.shiro.crypto.JcaCipherService
Returns the cipher algorithm name that will be used for all encryption, decryption, and key operations (for example, 'AES', 'Blowfish', 'RSA', 'DSA', 'TripleDES', etc).
getAllAttributeValues(Attribute) - Static method in class org.apache.shiro.realm.ldap.LdapUtils
Helper method used to retrieve all attribute values from a particular context attribute.
getAlreadyFilteredAttributeName() - Method in class org.apache.shiro.web.servlet.OncePerRequestFilter
Return name of the request attribute that identifies that a request has already been filtered.
getAndClearSavedRequest(ServletRequest) - Static method in class org.apache.shiro.web.util.WebUtils
 
getAnnotation(MethodInvocation) - Method in class org.apache.shiro.aop.AnnotationMethodInterceptor
Returns the Annotation that this interceptor will process for the specified method invocation.
getAnnotation(MethodInvocation, Class<? extends Annotation>) - Method in interface org.apache.shiro.aop.AnnotationResolver
Returns an Annotation instance of the specified type based on the given MethodInvocation argument, or null if no annotation of that type could be found.
getAnnotation(MethodInvocation, Class<? extends Annotation>) - Method in class org.apache.shiro.aop.DefaultAnnotationResolver
Returns methodInvocation.getMethod().getAnnotation(clazz).
getAnnotation(MethodInvocation, Class<? extends Annotation>) - Method in class org.apache.shiro.spring.aop.SpringAnnotationResolver
 
getAnnotationClass() - Method in class org.apache.shiro.aop.AnnotationHandler
Returns the type of annotation this handler inspects and processes.
getAnnotationValue(Annotation) - Method in class org.apache.shiro.authz.aop.PermissionAnnotationHandler
Returns the annotation value, from which the Permission will be constructed.
getApplicationName() - Method in class org.apache.shiro.web.filter.authc.BasicHttpAuthenticationFilter
Returns the name to use in the ServletResponse's WWW-Authenticate header.
getArguments() - Method in interface org.apache.shiro.aop.MethodInvocation
Returns the (possibly null) arguments to be supplied to the method invocation.
getArguments() - Method in class org.apache.shiro.aspectj.BeforeAdviceMethodInvocationAdapter
 
getAttribute(SessionKey, Object) - Method in class org.apache.shiro.session.mgt.AbstractNativeSessionManager
 
getAttribute(Object) - Method in class org.apache.shiro.session.mgt.DelegatingSession
 
getAttribute(SessionKey, Object) - Method in interface org.apache.shiro.session.mgt.NativeSessionManager
Returns the object bound to the associated session identified by the specified attribute key.
getAttribute(Object) - Method in class org.apache.shiro.session.mgt.SimpleSession
 
getAttribute(Object) - Method in class org.apache.shiro.session.ProxiedSession
Immediately delegates to the underlying proxied session.
getAttribute(Object) - Method in interface org.apache.shiro.session.Session
Returns the object bound to this session identified by the specified key.
getAttribute(String) - Method in class org.apache.shiro.web.servlet.ShiroHttpSession
 
getAttribute(Object) - Method in class org.apache.shiro.web.session.HttpServletSession
 
getAttributeKeys(SessionKey) - Method in class org.apache.shiro.session.mgt.AbstractNativeSessionManager
 
getAttributeKeys() - Method in class org.apache.shiro.session.mgt.DelegatingSession
 
getAttributeKeys(SessionKey) - Method in interface org.apache.shiro.session.mgt.NativeSessionManager
Returns all attribute keys maintained by the target session or an empty collection if there are no attributes.
getAttributeKeys() - Method in class org.apache.shiro.session.mgt.SimpleSession
 
getAttributeKeys() - Method in class org.apache.shiro.session.ProxiedSession
Immediately delegates to the underlying proxied session.
getAttributeKeys() - Method in interface org.apache.shiro.session.Session
Returns the keys of all the attributes stored under this session.
getAttributeKeys() - Method in class org.apache.shiro.web.session.HttpServletSession
 
getAttributeNames() - Method in class org.apache.shiro.web.servlet.ShiroHttpSession
 
getAttributes() - Method in class org.apache.shiro.session.mgt.SimpleSession
 
getAuthcScheme() - Method in class org.apache.shiro.web.filter.authc.BasicHttpAuthenticationFilter
Returns the HTTP WWW-Authenticate header scheme that this filter will use when sending the HTTP Basic challenge response.
getAuthenticationCache() - Method in class org.apache.shiro.realm.AuthenticatingRealm
Returns a Cache instance to use for authentication caching, or null if no cache has been set.
getAuthenticationCacheKey(AuthenticationToken) - Method in class org.apache.shiro.realm.AuthenticatingRealm
Returns the key under which AuthenticationInfo instances are cached if authentication caching is enabled.
getAuthenticationCacheKey(PrincipalCollection) - Method in class org.apache.shiro.realm.AuthenticatingRealm
Returns the key under which AuthenticationInfo instances are cached if authentication caching is enabled.
getAuthenticationCacheName() - Method in class org.apache.shiro.realm.AuthenticatingRealm
Returns the name of a Cache to lookup from any available cacheManager if a cache is not explicitly configured via AuthenticatingRealm.setAuthenticationCache(org.apache.shiro.cache.Cache).
getAuthenticationInfo(AuthenticationToken) - Method in class org.apache.shiro.realm.AuthenticatingRealm
This implementation functions as follows: It attempts to acquire any cached AuthenticationInfo corresponding to the specified AuthenticationToken argument.
getAuthenticationInfo(AuthenticationToken) - Method in interface org.apache.shiro.realm.Realm
Returns an account's authentication-specific information for the specified token, or null if no account could be found based on the token.
getAuthenticationInfo() - Method in interface org.apache.shiro.subject.SubjectContext
 
getAuthenticationInfo() - Method in class org.apache.shiro.subject.support.DefaultSubjectContext
 
getAuthenticationListeners() - Method in class org.apache.shiro.authc.AbstractAuthenticator
Returns the AuthenticationListeners that should be notified during authentication attempts.
getAuthenticationMechanism() - Method in class org.apache.shiro.realm.ldap.JndiLdapContextFactory
Returns the type of LDAP authentication mechanism to use when connecting to the LDAP server.
getAuthenticationStrategy() - Method in class org.apache.shiro.authc.pam.ModularRealmAuthenticator
Returns the AuthenticationStrategy utilized by this modular authenticator during a multi-realm log-in attempt.
getAuthenticationToken() - Method in interface org.apache.shiro.subject.SubjectContext
 
getAuthenticationToken() - Method in class org.apache.shiro.subject.support.DefaultSubjectContext
 
getAuthenticationTokenClass() - Method in class org.apache.shiro.realm.AuthenticatingRealm
Returns the authenticationToken class supported by this realm.
getAuthenticator() - Method in class org.apache.shiro.mgt.AuthenticatingSecurityManager
Returns the delegate Authenticator instance that this SecurityManager uses to perform all authentication operations.
getAuthorizationCache() - Method in class org.apache.shiro.realm.AuthorizingRealm
 
getAuthorizationCacheKey(PrincipalCollection) - Method in class org.apache.shiro.realm.AuthorizingRealm
 
getAuthorizationCacheName() - Method in class org.apache.shiro.realm.AuthorizingRealm
 
getAuthorizationInfo(PrincipalCollection) - Method in class org.apache.shiro.realm.AuthorizingRealm
Returns an account's authorization-specific information for the specified principals, or null if no account could be found.
getAuthorizer() - Method in class org.apache.shiro.mgt.AuthorizingSecurityManager
Returns the underlying wrapped Authorizer instance to which this SecurityManager implementation delegates all of its authorization calls.
getAuthzHeader(ServletRequest) - Method in class org.apache.shiro.web.filter.authc.BasicHttpAuthenticationFilter
Returns the AUTHORIZATION_HEADER from the specified ServletRequest.
getAuthzScheme() - Method in class org.apache.shiro.web.filter.authc.BasicHttpAuthenticationFilter
Returns the HTTP Authorization header value that this filter will respond to as indicating a login request.
getAvailablePrincipal(PrincipalCollection) - Method in class org.apache.shiro.realm.CachingRealm
A utility method for subclasses that returns the first available principal of interest to this particular realm.
getBean(String) - Method in class org.apache.shiro.config.ReflectionBuilder
 
getBean(String, Class<T>) - Method in class org.apache.shiro.config.ReflectionBuilder
 
getBeans() - Method in class org.apache.shiro.config.IniSecurityManagerFactory
 
getBlockSize() - Method in class org.apache.shiro.crypto.DefaultBlockCipherService
Returns the block cipher's block size to be used when constructing Cipher transformation string or 0 if the JCA Provider default block size for the specified algorithm should be used.
getBytes() - Method in class org.apache.shiro.crypto.hash.AbstractHash
Deprecated.  
getBytes() - Method in class org.apache.shiro.crypto.hash.SimpleHash
 
getBytes() - Method in interface org.apache.shiro.util.ByteSource
Returns the wrapped byte array.
getBytes() - Method in class org.apache.shiro.util.SimpleByteSource
 
getCache(String) - Method in class org.apache.shiro.cache.AbstractCacheManager
Returns the cache with the specified name.
getCache(String) - Method in interface org.apache.shiro.cache.CacheManager
Acquires the cache with the specified name.
getCache(String) - Method in class org.apache.shiro.cache.ehcache.EhCacheManager
Loads an existing EhCache from the cache manager, or starts a new cache if one is not found.
getCachedSession(Serializable) - Method in class org.apache.shiro.session.mgt.eis.CachingSessionDAO
Returns the cached session with the corresponding sessionId or null if there is no session cached under that id (or if there is no Cache).
getCachedSession(Serializable, Cache<Serializable, Session>) - Method in class org.apache.shiro.session.mgt.eis.CachingSessionDAO
Returns the Session with the specified id from the specified cache.
getCacheManager() - Method in class org.apache.shiro.cache.ehcache.EhCacheManager
Returns the wrapped Ehcache CacheManager instance.
getCacheManager() - Method in class org.apache.shiro.mgt.CachingSecurityManager
Returns the CacheManager used by this SecurityManager.
getCacheManager() - Method in class org.apache.shiro.realm.CachingRealm
Returns the CacheManager used for data caching to reduce EIS round trips, or null if caching is disabled.
getCacheManager() - Method in class org.apache.shiro.session.mgt.eis.CachingSessionDAO
Returns the CacheManager to use for acquiring the activeSessionsCache if one is not configured.
getCacheManagerConfigFile() - Method in class org.apache.shiro.cache.ehcache.EhCacheManager
Returns the resource location of the config file used to initialize a new EhCache CacheManager instance.
getCacheManagerConfigFileInputStream() - Method in class org.apache.shiro.cache.ehcache.EhCacheManager
Acquires the InputStream for the ehcache configuration file using ResourceUtils.getInputStreamForPath with the path returned from getCacheManagerConfigFile().
getCasServerUrlPrefix() - Method in class org.apache.shiro.cas.CasRealm
 
getCasService() - Method in class org.apache.shiro.cas.CasRealm
 
getChain(String) - Method in class org.apache.shiro.web.filter.mgt.DefaultFilterChainManager
 
getChain(String) - Method in interface org.apache.shiro.web.filter.mgt.FilterChainManager
Returns the filter chain identified by the specified chainName or null if there is no chain with that name.
getChain(ServletRequest, ServletResponse, FilterChain) - Method in interface org.apache.shiro.web.filter.mgt.FilterChainResolver
Returns the filter chain that should be executed for the given request, or null if the original chain should be used.
getChain(ServletRequest, ServletResponse, FilterChain) - Method in class org.apache.shiro.web.filter.mgt.PathMatchingFilterChainResolver
 
getChainNames() - Method in class org.apache.shiro.web.filter.mgt.DefaultFilterChainManager
 
getChainNames() - Method in interface org.apache.shiro.web.filter.mgt.FilterChainManager
Returns the names of all configured chains or an empty Set if no chains have been configured.
getCipherKey() - Method in class org.apache.shiro.mgt.AbstractRememberMeManager
Convenience method that returns the cipher key to use for both encryption and decryption.
getCipherService() - Method in class org.apache.shiro.mgt.AbstractRememberMeManager
Returns the CipherService to use for encrypting and decrypting serialized identity data to prevent easy inspection of Subject identity data.
getCleanParam(ServletRequest, String) - Static method in class org.apache.shiro.web.util.WebUtils
Convenience method that returns a request parameter value, first running it through StringUtils.clean(String).
getComment() - Method in interface org.apache.shiro.web.servlet.Cookie
 
getComment() - Method in class org.apache.shiro.web.servlet.SimpleCookie
 
getConfig() - Method in class org.apache.shiro.web.servlet.IniShiroFilter
Deprecated. Returns the actual INI configuration text to use to build the SecurityManager and FilterChainResolver used by the web application or null if the configPath should be used to load a fallback INI source.
getConfigLocations() - Method in class org.apache.shiro.web.env.ResourceBasedWebEnvironment
 
getConfigPath() - Method in class org.apache.shiro.web.servlet.IniShiroFilter
Deprecated. Returns the config path to be used to load a .ini file for configuration if a configuration is not specified via the config attribute.
getConstructor(Class, Class...) - Static method in class org.apache.shiro.util.ClassUtils
 
getContext() - Method in class org.apache.shiro.web.servlet.ShiroHttpServletResponse
 
getContextAttribute(String) - Method in class org.apache.shiro.web.servlet.ServletContextSupport
 
getContextFactory() - Method in class org.apache.shiro.realm.ldap.JndiLdapRealm
Returns the LdapContextFactory instance used to acquire connections to the LDAP directory during authentication attempts and authorization queries.
getContextFactoryClassName() - Method in class org.apache.shiro.realm.ldap.JndiLdapContextFactory
Sets the name of the ContextFactory class to use.
getContextInitParam(String) - Method in class org.apache.shiro.web.servlet.ServletContextSupport
 
getContextPath(HttpServletRequest) - Static method in class org.apache.shiro.web.util.WebUtils
Return the context path for the given request, detecting an include request URL if called within a RequestDispatcher include.
getCookie() - Method in class org.apache.shiro.web.mgt.CookieRememberMeManager
Returns the cookie 'template' that will be used to set all attributes of outgoing rememberMe cookies created by this RememberMeManager.
getCreationTime() - Method in class org.apache.shiro.web.servlet.ShiroHttpSession
 
getCredentials() - Method in interface org.apache.shiro.authc.AuthenticationInfo
Returns the credentials associated with the corresponding Subject.
getCredentials() - Method in interface org.apache.shiro.authc.AuthenticationToken
Returns the credentials submitted by the user during the authentication process that verifies the submitted account identity.
getCredentials(AuthenticationInfo) - Method in class org.apache.shiro.authc.credential.HashedCredentialsMatcher
Returns a Hash instance representing the already-hashed AuthenticationInfo credentials stored in the system.
getCredentials(AuthenticationToken) - Method in class org.apache.shiro.authc.credential.SimpleCredentialsMatcher
Returns the token's credentials.
getCredentials(AuthenticationInfo) - Method in class org.apache.shiro.authc.credential.SimpleCredentialsMatcher
Returns the account's credentials.
getCredentials() - Method in class org.apache.shiro.authc.SimpleAccount
Simply returns this.authcInfo.getCredentials.
getCredentials() - Method in class org.apache.shiro.authc.SimpleAuthenticationInfo
 
getCredentials() - Method in class org.apache.shiro.authc.UsernamePasswordToken
Returns the password char array.
getCredentials() - Method in class org.apache.shiro.cas.CasToken
 
getCredentialsMatcher() - Method in class org.apache.shiro.realm.AuthenticatingRealm
Returns the CredentialsMatcher used during an authentication attempt to verify submitted credentials with those stored in the system.
getCredentialsSalt() - Method in interface org.apache.shiro.authc.SaltedAuthenticationInfo
Returns the salt used to salt the account's credentials or null if no salt was used.
getCredentialsSalt() - Method in class org.apache.shiro.authc.SimpleAccount
Returns the salt used to hash this Account's credentials (eg for password hashing), or null if no salt was used or credentials were not hashed at all.
getCredentialsSalt() - Method in class org.apache.shiro.authc.SimpleAuthenticationInfo
Returns the salt used to hash the credentials, or null if no salt was used or credentials were not hashed at all.
getDecryptionCipherKey() - Method in class org.apache.shiro.mgt.AbstractRememberMeManager
Returns the decryption cipher key to use for decryption operations.
getDefaultConfigLocations() - Method in class org.apache.shiro.web.env.IniWebEnvironment
Returns an array with two elements, /WEB-INF/shiro.ini and classpath:shiro.ini.
getDefaultIni() - Method in class org.apache.shiro.web.env.IniWebEnvironment
 
getDefaultNextBytesSize() - Method in class org.apache.shiro.crypto.SecureRandomNumberGenerator
Returns the size of the generated byte array for calls to nextBytes().
getDefaultPermissions() - Method in class org.apache.shiro.cas.CasRealm
 
getDefaultRoles() - Method in class org.apache.shiro.cas.CasRealm
 
getDefaultSecureRandom() - Static method in class org.apache.shiro.crypto.JcaCipherService
 
getDefaultValue() - Method in class org.apache.shiro.web.tags.PrincipalTag
 
getDigest(String) - Method in class org.apache.shiro.crypto.hash.AbstractHash
Deprecated. Returns the JDK MessageDigest instance to use for executing the hash.
getDigest(String) - Method in class org.apache.shiro.crypto.hash.SimpleHash
Returns the JDK MessageDigest instance to use for executing the hash.
getDiskStoreSize() - Method in class org.apache.shiro.cache.ehcache.EhCache
Returns the size (in bytes) that this EhCache's disk store is consuming or -1 if that number is unknown or cannot be calculated.
getDomain(Class<? extends DomainPermission>) - Method in class org.apache.shiro.authz.permission.DomainPermission
 
getDomain() - Method in class org.apache.shiro.authz.permission.DomainPermission
 
getDomain() - Method in interface org.apache.shiro.web.servlet.Cookie
 
getDomain() - Method in class org.apache.shiro.web.servlet.SimpleCookie
 
getEncryptionCipherKey() - Method in class org.apache.shiro.mgt.AbstractRememberMeManager
Returns the cipher key to use for encryption operations.
getEnvironment() - Method in class org.apache.shiro.jndi.JndiTemplate
Return the environment for the JNDI InitialContext, or null if none should be used.
getEnvironment() - Method in class org.apache.shiro.realm.ldap.JndiLdapContextFactory
Returns the base JNDI environment template to use when acquiring an LDAP connection (an LdapContext).
getExecutionChain(ServletRequest, ServletResponse, FilterChain) - Method in class org.apache.shiro.web.servlet.AbstractShiroFilter
Returns the FilterChain to execute for the given request.
getFailureKeyAttribute() - Method in class org.apache.shiro.web.filter.authc.FormAuthenticationFilter
 
getFilter(String) - Method in class org.apache.shiro.web.filter.mgt.DefaultFilterChainManager
 
getFilterChainDefinitionMap() - Method in class org.apache.shiro.spring.web.ShiroFilterFactoryBean
Returns the chainName-to-chainDefinition map of chain definitions to use for creating filter chains intercepted by the Shiro Filter.
getFilterChainManager() - Method in class org.apache.shiro.web.filter.mgt.PathMatchingFilterChainResolver
 
getFilterChainResolver() - Method in class org.apache.shiro.web.env.DefaultWebEnvironment
 
getFilterChainResolver() - Method in interface org.apache.shiro.web.env.WebEnvironment
Returns the web application's FilterChainResolver if one has been configured or null if one is not available.
getFilterChainResolver() - Method in class org.apache.shiro.web.servlet.AbstractShiroFilter
 
getFilterChains() - Method in class org.apache.shiro.web.filter.mgt.DefaultFilterChainManager
 
getFilterClass() - Method in enum org.apache.shiro.web.filter.mgt.DefaultFilter
 
getFilterConfig() - Method in class org.apache.shiro.web.config.IniFilterChainResolverFactory
 
getFilterConfig() - Method in class org.apache.shiro.web.filter.mgt.DefaultFilterChainManager
Returns the FilterConfig provided by the Servlet container at webapp startup.
getFilterConfig() - Method in class org.apache.shiro.web.servlet.AbstractFilter
Returns the servlet container specified FilterConfig instance provided at startup.
getFilters() - Method in class org.apache.shiro.spring.web.ShiroFilterFactoryBean
Returns the filterName-to-Filter map of filters available for reference when defining filter chain definitions.
getFilters(Map<String, String>, Map<String, ?>) - Method in class org.apache.shiro.web.config.IniFilterChainResolverFactory
 
getFilters() - Method in class org.apache.shiro.web.filter.mgt.DefaultFilterChainManager
 
getFilters() - Method in interface org.apache.shiro.web.filter.mgt.FilterChainManager
Returns the pool of available Filters managed by this manager, keyed by name.
getFormatClassNames() - Method in class org.apache.shiro.crypto.hash.format.DefaultHashFormatFactory
Returns a hashFormatAlias-to-fullyQualifiedHashFormatClassNameImplementation map.
getGlobalSessionTimeout() - Method in class org.apache.shiro.session.mgt.AbstractSessionManager
Returns the system-wide default time in milliseconds that any session may remain idle before expiring.
getHandler() - Method in class org.apache.shiro.aop.AnnotationMethodInterceptor
Returns the AnnotationHandler used to perform authorization behavior based on an annotation discovered at runtime.
getHashAlgorithmName() - Method in class org.apache.shiro.authc.credential.HashedCredentialsMatcher
Returns the Hash algorithmName to use when performing hashes for credentials matching.
getHashAlgorithmName() - Method in class org.apache.shiro.crypto.hash.DefaultHashService
 
getHashFormat() - Method in class org.apache.shiro.authc.credential.DefaultPasswordService
 
getHashFormatClass(String) - Method in class org.apache.shiro.crypto.hash.format.DefaultHashFormatFactory
Heuristically determine the fully qualified HashFormat implementation class name based on the specified token.
getHashFormatClass(String, String) - Method in class org.apache.shiro.crypto.hash.format.DefaultHashFormatFactory
Heuristically determine the fully qualified HashFormat implementation class name in the specified package based on the provided token.
getHashFormatFactory() - Method in class org.apache.shiro.authc.credential.DefaultPasswordService
 
getHashIterations() - Method in class org.apache.shiro.authc.credential.HashedCredentialsMatcher
Returns the number of times a submitted AuthenticationToken's credentials will be hashed before comparing to the credentials stored in the system.
getHashIterations() - Method in class org.apache.shiro.crypto.hash.DefaultHashService
 
getHashService() - Method in class org.apache.shiro.authc.credential.DefaultPasswordService
 
getHost() - Method in interface org.apache.shiro.authc.HostAuthenticationToken
Returns the host name of the client from where the authentication attempt originates or if the Shiro environment cannot or chooses not to resolve the hostname to improve performance, this method returns the String representation of the client's IP address.
getHost() - Method in class org.apache.shiro.authc.UsernamePasswordToken
Returns the host name or IP string from where the authentication attempt occurs.
getHost() - Method in exception org.apache.shiro.authz.HostUnauthorizedException
Returns the host associated with this exception.
getHost(SessionKey) - Method in class org.apache.shiro.session.mgt.AbstractNativeSessionManager
 
getHost() - Method in class org.apache.shiro.session.mgt.DefaultSessionContext
 
getHost() - Method in class org.apache.shiro.session.mgt.DelegatingSession
 
getHost(SessionKey) - Method in interface org.apache.shiro.session.mgt.NativeSessionManager
Returns the host name or IP string of the host where the session was started, if known.
getHost() - Method in interface org.apache.shiro.session.mgt.SessionContext
Returns the originating host name or IP address (as a String) from where the Subject is initiating the Session.
getHost() - Method in class org.apache.shiro.session.mgt.SimpleSession
 
getHost() - Method in class org.apache.shiro.session.ProxiedSession
Immediately delegates to the underlying proxied session.
getHost() - Method in interface org.apache.shiro.session.Session
Returns the host name or IP string of the host that originated this session, or null if the host is unknown.
getHost() - Method in interface org.apache.shiro.subject.SubjectContext
Returns the host name or IP that should reflect the constructed Subject's originating location.
getHost() - Method in class org.apache.shiro.subject.support.DefaultSubjectContext
 
getHost() - Method in class org.apache.shiro.subject.support.DelegatingSubject
Returns the host name or IP associated with the client who created/is interacting with this Subject.
getHost(ServletRequest) - Method in class org.apache.shiro.web.filter.authc.AuthenticatingFilter
Returns the host name or IP associated with the current subject.
getHost() - Method in class org.apache.shiro.web.session.HttpServletSession
 
getHttpMethodAction(ServletRequest) - Method in class org.apache.shiro.web.filter.authz.HttpMethodPermissionFilter
Determines the action (verb) attempting to be performed on the filtered resource by the current request.
getHttpMethodAction(String) - Method in class org.apache.shiro.web.filter.authz.HttpMethodPermissionFilter
Determines the corresponding application action that will be performed on the filtered resource based on the specified HTTP method (GET, POST, etc).
getHttpMethodActions() - Method in class org.apache.shiro.web.filter.authz.HttpMethodPermissionFilter
Returns the HTTP Method name (key) to action verb (value) mapping used to resolve actions based on an incoming HttpServletRequest.
getHttpRequest(Object) - Static method in class org.apache.shiro.web.util.WebUtils
 
getHttpResponse(Object) - Static method in class org.apache.shiro.web.util.WebUtils
 
getId(String) - Method in class org.apache.shiro.config.ReflectionBuilder
 
getId() - Method in interface org.apache.shiro.crypto.hash.format.ModularCryptFormat
Returns the Modular Crypt Format identifier that indicates how the formatted String should be parsed.
getId() - Method in class org.apache.shiro.crypto.hash.format.Shiro1CryptFormat
 
getId() - Method in class org.apache.shiro.session.mgt.DelegatingSession
 
getId() - Method in class org.apache.shiro.session.mgt.SimpleSession
 
getId() - Method in class org.apache.shiro.session.ProxiedSession
Immediately delegates to the underlying proxied session.
getId() - Method in interface org.apache.shiro.session.Session
Returns the unique identifier assigned by the system upon session creation.
getId() - Method in class org.apache.shiro.web.servlet.ShiroHttpSession
 
getId() - Method in class org.apache.shiro.web.session.HttpServletSession
 
getIdentityToRemember(Subject, AuthenticationInfo) - Method in class org.apache.shiro.mgt.AbstractRememberMeManager
Returns info.getPrincipals() and ignores the Subject argument.
getIni() - Method in class org.apache.shiro.config.IniFactorySupport
 
getIni() - Method in class org.apache.shiro.realm.text.IniRealm
Returns the Ini instance used to configure this realm.
getIni() - Method in class org.apache.shiro.web.env.IniWebEnvironment
Returns the Ini instance reflecting this WebEnvironment's configuration.
getInitializationVectorSize() - Method in class org.apache.shiro.crypto.JcaCipherService
Returns the algorithm-specific size in bits of generated initialization vectors.
getInitParam(String) - Method in class org.apache.shiro.web.servlet.AbstractFilter
Returns the value for the named init-param, or null if there was no init-param specified by that name.
getInputStreamForPath(String) - Static method in class org.apache.shiro.io.ResourceUtils
Returns the InputStream for the resource represented by the specified path, supporting scheme prefixes that direct how to acquire the input stream (CLASSPATH_PREFIX, URL_PREFIX, or FILE_PREFIX).
getInstance(String) - Method in class org.apache.shiro.crypto.hash.format.DefaultHashFormatFactory
 
getInstance(String) - Method in interface org.apache.shiro.crypto.hash.format.HashFormatFactory
 
getInstance() - Method in class org.apache.shiro.jndi.JndiObjectFactory
 
getInstance() - Method in class org.apache.shiro.util.AbstractFactory
 
getInstance() - Method in interface org.apache.shiro.util.Factory
Returns an instance of the required type.
getInterval() - Method in class org.apache.shiro.session.mgt.ExecutorServiceSessionValidationScheduler
 
getIterations(HashRequest) - Method in class org.apache.shiro.crypto.hash.DefaultHashService
 
getIterations() - Method in interface org.apache.shiro.crypto.hash.Hash
Returns the number of hash iterations used to compute the hash.
getIterations() - Method in interface org.apache.shiro.crypto.hash.HashRequest
Returns the number of requested hash iterations to be performed when computing the final Hash result.
getIterations() - Method in class org.apache.shiro.crypto.hash.SimpleHash
 
getIterations() - Method in class org.apache.shiro.crypto.hash.SimpleHashRequest
 
getJndiEnvironment() - Method in class org.apache.shiro.jndi.JndiLocator
Return the JNDI environment to use for JNDI lookups.
getJndiNames() - Method in class org.apache.shiro.realm.jndi.JndiRealmFactory
Returns the JNDI names that will be used to look up Realm(s) from JNDI.
getJndiTemplate() - Method in class org.apache.shiro.jndi.JndiLocator
Return the JNDI template to use for JNDI lookups.
getKeyNames() - Method in class org.apache.shiro.web.servlet.ShiroHttpSession
 
getKeySize() - Method in class org.apache.shiro.crypto.JcaCipherService
Returns the size in bits (not bytes) of generated cipher keys.
getLastAccessedTime() - Method in class org.apache.shiro.web.servlet.ShiroHttpSession
 
getLastAccessTime(SessionKey) - Method in class org.apache.shiro.session.mgt.AbstractNativeSessionManager
 
getLastAccessTime() - Method in class org.apache.shiro.session.mgt.DelegatingSession
 
getLastAccessTime(SessionKey) - Method in interface org.apache.shiro.session.mgt.NativeSessionManager
Returns the time the associated Session last interacted with the system.
getLastAccessTime() - Method in class org.apache.shiro.session.mgt.SimpleSession
 
getLastAccessTime() - Method in class org.apache.shiro.session.ProxiedSession
Immediately delegates to the underlying proxied session.
getLastAccessTime() - Method in interface org.apache.shiro.session.Session
Returns the last time the application received a request or method invocation from the user associated with this session.
getLastAccessTime() - Method in class org.apache.shiro.web.session.HttpServletSession
 
getLdapContext(String, String) - Method in class org.apache.shiro.realm.ldap.DefaultLdapContextFactory
Deprecated. the DefaultLdapContextFactory.getLdapContext(Object, Object) method should be used in all cases to ensure more than String principals and credentials can be used. Shiro no longer calls this method - it will be removed before the 2.0 release.
getLdapContext(Object, Object) - Method in class org.apache.shiro.realm.ldap.DefaultLdapContextFactory
Deprecated.  
getLdapContext(String, String) - Method in class org.apache.shiro.realm.ldap.JndiLdapContextFactory
Deprecated. the JndiLdapContextFactory.getLdapContext(Object, Object) method should be used in all cases to ensure more than String principals and credentials can be used. Shiro no longer calls this method - it will be removed before the 2.0 release.
getLdapContext(Object, Object) - Method in class org.apache.shiro.realm.ldap.JndiLdapContextFactory
This implementation returns an LdapContext based on the configured JNDI/LDAP environment configuration.
getLdapContext(String, String) - Method in interface org.apache.shiro.realm.ldap.LdapContextFactory
Deprecated. the LdapContextFactory.getLdapContext(Object, Object) method should be used in all cases to ensure more than String principals and credentials can be used.
getLdapContext(Object, Object) - Method in interface org.apache.shiro.realm.ldap.LdapContextFactory
Creates (or retrieves from a pool) an LdapContext connection bound using the specified principal and credentials.
getLdapPrincipal(AuthenticationToken) - Method in class org.apache.shiro.realm.ldap.JndiLdapRealm
Returns the principal to use when creating the LDAP connection for an authentication attempt.
getLoginUrl() - Method in class org.apache.shiro.spring.web.ShiroFilterFactoryBean
Returns the application's login URL to be assigned to all acquired Filters that subclass AccessControlFilter or null if no value should be assigned globally.
getLoginUrl() - Method in class org.apache.shiro.web.filter.AccessControlFilter
Returns the login URL used to authenticate a user.
getMajorVersion() - Static method in class org.apache.shiro.util.JavaEnvironment
Get the major version code.
getMaxAge() - Method in interface org.apache.shiro.web.servlet.Cookie
 
getMaxAge() - Method in class org.apache.shiro.web.servlet.SimpleCookie
 
getMaxInactiveInterval() - Method in class org.apache.shiro.web.servlet.ShiroHttpSession
 
getMemoryStoreSize() - Method in class org.apache.shiro.cache.ehcache.EhCache
Returns the size (in bytes) that this EhCache's memory store is using (RAM), or -1 if that number is unknown or cannot be calculated.
getMemoryUsage() - Method in class org.apache.shiro.cache.ehcache.EhCache
Returns the size (in bytes) that this EhCache is using in memory (RAM), or -1 if that number is unknown or cannot be calculated.
getMethod() - Method in interface org.apache.shiro.aop.MethodInvocation
Returns the actual Method to be invoked.
getMethod() - Method in class org.apache.shiro.aspectj.BeforeAdviceMethodInvocationAdapter
 
getMethod() - Method in class org.apache.shiro.web.util.SavedRequest
 
getMethodInterceptors() - Method in class org.apache.shiro.authz.aop.AnnotationsAuthorizingMethodInterceptor
Returns the method interceptors to execute for the annotated method.
getModeName() - Method in class org.apache.shiro.crypto.DefaultBlockCipherService
Returns the cipher operation mode name (as a String) to be used when constructing Cipher transformation string or null if the JCA Provider default mode for the specified algorithm should be used.
getName() - Method in class org.apache.shiro.authz.SimpleRole
 
getName() - Method in class org.apache.shiro.config.Ini.Section
 
getName() - Method in class org.apache.shiro.realm.CachingRealm
 
getName() - Method in interface org.apache.shiro.realm.Realm
Returns the (application-unique) name assigned to this Realm.
getName(String, String) - Method in class org.apache.shiro.realm.text.PropertiesRealm
 
getName() - Method in interface org.apache.shiro.web.filter.mgt.NamedFilterList
Returns the configuration-unique name assigned to this Filter list.
getName() - Method in class org.apache.shiro.web.filter.mgt.SimpleNamedFilterList
 
getName() - Method in interface org.apache.shiro.web.servlet.Cookie
 
getName() - Method in class org.apache.shiro.web.servlet.NameableFilter
Returns the filter's name.
getName() - Method in class org.apache.shiro.web.servlet.SimpleCookie
 
getName() - Method in class org.apache.shiro.web.tags.PermissionTag
 
getName() - Method in class org.apache.shiro.web.tags.RoleTag
 
getObject(String, Class<T>) - Method in class org.apache.shiro.env.DefaultEnvironment
 
getObject(String, Class<T>) - Method in interface org.apache.shiro.env.NamedObjectEnvironment
Returns the object in Shiro's environment with the specified name and type or null if no object with that name was found.
getObject() - Method in class org.apache.shiro.spring.web.ShiroFilterFactoryBean
Lazily creates and returns a AbstractShiroFilter concrete instance via the ShiroFilterFactoryBean.createInstance() method.
getObjectPermissions() - Method in class org.apache.shiro.authc.SimpleAccount
Returns all object-based permissions assigned directly to this Account (not any of its realms).
getObjectPermissions() - Method in interface org.apache.shiro.authz.AuthorizationInfo
Returns all type-safe Permissions assigned to the corresponding Subject.
getObjectPermissions() - Method in class org.apache.shiro.authz.SimpleAuthorizationInfo
 
getObjects() - Method in class org.apache.shiro.config.ReflectionBuilder
 
getObjects() - Method in class org.apache.shiro.env.DefaultEnvironment
Returns the live (modifiable) internal objects collection.
getObjectType() - Method in class org.apache.shiro.spring.web.ShiroFilterFactoryBean
Returns AbstractShiroFilter.class
getOrder() - Method in class org.apache.shiro.spring.LifecycleBeanPostProcessor
Order value of this BeanPostProcessor.
getPaddingSchemeName() - Method in class org.apache.shiro.crypto.DefaultBlockCipherService
Returns the cipher algorithm padding scheme name (as a String) to be used when constructing Cipher transformation string or null if the JCA Provider default mode for the specified algorithm should be used.
getParts() - Method in class org.apache.shiro.authz.permission.WildcardPermission
 
getPassword() - Method in class org.apache.shiro.authc.UsernamePasswordToken
Returns the password submitted during an authentication attempt as a character array.
getPassword(ServletRequest) - Method in class org.apache.shiro.web.filter.authc.FormAuthenticationFilter
 
getPasswordParam() - Method in class org.apache.shiro.web.filter.authc.FormAuthenticationFilter
 
getPasswordService() - Method in class org.apache.shiro.authc.credential.PasswordMatcher
 
getPath() - Method in interface org.apache.shiro.web.servlet.Cookie
 
getPath() - Method in class org.apache.shiro.web.servlet.SimpleCookie
 
getPathMatcher() - Method in class org.apache.shiro.web.filter.mgt.PathMatchingFilterChainResolver
Returns the PatternMatcher used when determining if an incoming request's path matches a configured filter chain.
getPathWithinApplication(ServletRequest) - Method in class org.apache.shiro.web.filter.mgt.PathMatchingFilterChainResolver
Merely returns WebUtils.getPathWithinApplication(request) and can be overridden by subclasses for custom request-to-application-path resolution behavior.
getPathWithinApplication(ServletRequest) - Method in class org.apache.shiro.web.filter.PathMatchingFilter
Returns the context path within the application based on the specified request.
getPathWithinApplication(HttpServletRequest) - Static method in class org.apache.shiro.web.util.WebUtils
Return the path within the web application for the given request.
getPermissionAttributeNames() - Method in class org.apache.shiro.cas.CasRealm
 
getPermissionResolver() - Method in class org.apache.shiro.authz.ModularRealmAuthorizer
Returns the PermissionResolver to be used on all configured realms, or nullgetPermissionResolver() - Method in class org.apache.shiro.realm.AuthorizingRealm
 
getPermissions() - Method in class org.apache.shiro.authz.SimpleRole
 
getPermissions(Connection, String, Collection<String>) - Method in class org.apache.shiro.realm.jdbc.JdbcRealm
 
getPermissionString() - Method in exception org.apache.shiro.authz.permission.InvalidPermissionStringException
Returns the permission string that was invalid and caused this exception to be thrown.
getPort() - Method in class org.apache.shiro.web.filter.authz.PortFilter
 
getPreviousPrincipals() - Method in interface org.apache.shiro.subject.Subject
Returns the previous 'pre run as' identity of this Subject before assuming the current runAs identity, or null if this Subject is not operating under an assumed identity (normal state).
getPreviousPrincipals() - Method in class org.apache.shiro.subject.support.DelegatingSubject
 
getPrimaryPrincipal() - Method in interface org.apache.shiro.subject.PrincipalCollection
Returns the primary principal used application-wide to uniquely identify the owning account/Subject.
getPrimaryPrincipal() - Method in class org.apache.shiro.subject.SimplePrincipalCollection
Returns the first available principal from any of the Realm principals, or null if there are no principals yet.
getPrimaryPrincipal() - Method in class org.apache.shiro.subject.SimplePrincipalMap
 
getPrincipal() - Method in interface org.apache.shiro.authc.AuthenticationToken
Returns the account identity submitted during the authentication process.
getPrincipal() - Method in class org.apache.shiro.authc.UsernamePasswordToken
Simply returns getUsername().
getPrincipal() - Method in class org.apache.shiro.cas.CasToken
 
getPrincipal() - Method in interface org.apache.shiro.subject.Subject
Returns this Subject's application-wide uniquely identifying principal, or null if this Subject is anonymous because it doesn't yet have any associated account data (for example, if they haven't logged in).
getPrincipal() - Method in class org.apache.shiro.subject.support.DelegatingSubject
 
getPrincipals() - Method in interface org.apache.shiro.authc.AuthenticationInfo
Returns all principals associated with the corresponding Subject.
getPrincipals() - Method in class org.apache.shiro.authc.SimpleAccount
Returns the principals, aka the identifying attributes (username, user id, first name, last name, etc) of this Account.
getPrincipals() - Method in class org.apache.shiro.authc.SimpleAuthenticationInfo
 
getPrincipals() - Method in interface org.apache.shiro.subject.Subject
Returns this Subject's principals (identifying attributes) in the form of a PrincipalCollection or null if this Subject is anonymous because it doesn't yet have any associated account data (for example, if they haven't logged in).
getPrincipals() - Method in interface org.apache.shiro.subject.SubjectContext
Returns the principals (aka identity) that the constructed Subject should reflect.
getPrincipals() - Method in class org.apache.shiro.subject.support.DefaultSubjectContext
 
getPrincipals() - Method in class org.apache.shiro.subject.support.DelegatingSubject
 
getPrincipalsAndCredentials(String, ServletRequest) - Method in class org.apache.shiro.web.filter.authc.BasicHttpAuthenticationFilter
Returns the username obtained from the authorizationHeader.
getPrincipalsAndCredentials(String, String) - Method in class org.apache.shiro.web.filter.authc.BasicHttpAuthenticationFilter
Returns the username and password pair based on the specified encoded String obtained from the request's authorization header.
getPrincipalsLazy(String) - Method in class org.apache.shiro.subject.SimplePrincipalCollection
 
getPrivateSalt() - Method in class org.apache.shiro.crypto.hash.DefaultHashService
 
getProperty() - Method in class org.apache.shiro.web.tags.PrincipalTag
 
getPublicSalt(HashRequest) - Method in class org.apache.shiro.crypto.hash.DefaultHashService
Returns the public salt that should be used to compute a hash based on the specified request or null if no public salt should be used.
getQueryString() - Method in class org.apache.shiro.web.util.SavedRequest
 
getRandom() - Method in class org.apache.shiro.session.mgt.eis.RandomSessionIdGenerator
 
getRandomNumberGenerator() - Method in class org.apache.shiro.crypto.hash.DefaultHashService
 
getRealmNames() - Method in interface org.apache.shiro.subject.PrincipalCollection
Returns the realm names that this collection has principals for.
getRealmNames() - Method in class org.apache.shiro.subject.SimplePrincipalCollection
 
getRealmNames() - Method in class org.apache.shiro.subject.SimplePrincipalMap
 
getRealmPrincipal(String, String) - Method in interface org.apache.shiro.subject.PrincipalMap
 
getRealmPrincipal(String, String) - Method in class org.apache.shiro.subject.SimplePrincipalMap
 
getRealmPrincipals(String) - Method in interface org.apache.shiro.subject.PrincipalMap
 
getRealmPrincipals(String) - Method in class org.apache.shiro.subject.SimplePrincipalMap
 
getRealms() - Method in class org.apache.shiro.authc.pam.ModularRealmAuthenticator
Returns the realm(s) used by this Authenticator during an authentication attempt.
getRealms() - Method in class org.apache.shiro.authz.ModularRealmAuthorizer
Returns the realms wrapped by this Authorizer which are consulted during an authorization check.
getRealms() - Method in class org.apache.shiro.mgt.RealmSecurityManager
Returns the Realms managed by this SecurityManager instance.
getRealms() - Method in class org.apache.shiro.realm.jndi.JndiRealmFactory
Performs the JNDI lookups for each specified JNDI name and returns all discovered Realms in an ordered collection.
getRealms() - Method in interface org.apache.shiro.realm.RealmFactory
Returns a collection of Realm instances that will be used to construct the application's SecurityManager instance.
getRedirectUrl(ServletRequest, ServletResponse, Subject) - Method in class org.apache.shiro.web.filter.authc.LogoutFilter
Returns the redirect URL to send the user after logout.
getRedirectUrl() - Method in class org.apache.shiro.web.filter.authc.LogoutFilter
Returns the URL to where the user will be redirected after logout.
getReferencedObject(String) - Method in class org.apache.shiro.config.ReflectionBuilder
 
getReferral() - Method in class org.apache.shiro.realm.ldap.JndiLdapContextFactory
Returns the LDAP referral behavior when creating a connection.
getRememberedIdentity(SubjectContext) - Method in class org.apache.shiro.mgt.DefaultSecurityManager
 
getRememberedPrincipals(SubjectContext) - Method in class org.apache.shiro.mgt.AbstractRememberMeManager
Implements the interface method by first acquiring the remembered serialized byte array.
getRememberedPrincipals(SubjectContext) - Method in interface org.apache.shiro.mgt.RememberMeManager
Based on the specified subject context map being used to build a Subject instance, returns any previously remembered principals for the subject for automatic identity association (aka 'Remember Me').
getRememberedSerializedIdentity(SubjectContext) - Method in class org.apache.shiro.mgt.AbstractRememberMeManager
Based on the given subject context data, retrieves the previously persisted serialized identity, or null if there is no available data.
getRememberedSerializedIdentity(SubjectContext) - Method in class org.apache.shiro.web.mgt.CookieRememberMeManager
Returns a previously serialized identity byte array or null if the byte array could not be acquired.
getRememberMeAttributeName() - Method in class org.apache.shiro.cas.CasRealm
 
getRememberMeManager() - Method in class org.apache.shiro.mgt.DefaultSecurityManager
 
getRememberMeParam() - Method in class org.apache.shiro.web.filter.authc.FormAuthenticationFilter
 
getRemoteUser() - Method in class org.apache.shiro.web.servlet.ShiroHttpServletRequest
 
getRequest() - Method in class org.apache.shiro.web.servlet.ShiroHttpServletResponse
 
getRequest(Object) - Static method in class org.apache.shiro.web.util.WebUtils
 
getRequestedSessionId() - Method in class org.apache.shiro.web.servlet.ShiroHttpServletRequest
 
getRequestURI() - Method in class org.apache.shiro.web.util.SavedRequest
 
getRequestUri(HttpServletRequest) - Static method in class org.apache.shiro.web.util.WebUtils
Return the request URI for the given request, detecting an include request URL if called within a RequestDispatcher include.
getRequestUrl() - Method in class org.apache.shiro.web.util.SavedRequest
 
getRequiredType() - Method in class org.apache.shiro.jndi.JndiObjectFactory
 
getRequiredWebEnvironment(ServletContext) - Static method in class org.apache.shiro.web.util.WebUtils
Find the Shiro WebEnvironment for this web application, which is typically loaded via the EnvironmentLoaderListener.
getResolver() - Method in class org.apache.shiro.aop.AnnotationMethodInterceptor
Returns the AnnotationResolver to use to acquire annotations from intercepted methods at runtime.
getResourceAsStream(String) - Static method in class org.apache.shiro.util.ClassUtils
Returns the specified resource by checking the current thread's context class loader, then the current ClassLoader (ClassUtils.class.getClassLoader()), then the system/application ClassLoader (ClassLoader.getSystemClassLoader(), in that order, using getResourceAsStream(name).
getResourceName() - Method in class org.apache.shiro.jndi.JndiObjectFactory
 
getResourcePath() - Method in class org.apache.shiro.realm.text.IniRealm
 
getResources() - Static method in class org.apache.shiro.util.ThreadContext
Returns the ThreadLocal Map.
getResponse(Object) - Static method in class org.apache.shiro.web.util.WebUtils
 
getRole(String) - Method in class org.apache.shiro.realm.SimpleAccountRealm
 
getRoleAttributeNames() - Method in class org.apache.shiro.cas.CasRealm
 
getRoleDefinitions() - Method in class org.apache.shiro.realm.text.TextConfigurationRealm
 
getRolename(String) - Method in class org.apache.shiro.realm.text.PropertiesRealm
 
getRoleNamesForGroups(Collection<String>) - Method in class org.apache.shiro.realm.activedirectory.ActiveDirectoryRealm
This method is called by the default implementation to translate Active Directory group names to role names.
getRoleNamesForUser(Connection, String) - Method in class org.apache.shiro.realm.jdbc.JdbcRealm
 
getRolePermissionResolver() - Method in class org.apache.shiro.authz.ModularRealmAuthorizer
Returns the RolePermissionResolver to be used on all configured realms, or nullgetRolePermissionResolver() - Method in class org.apache.shiro.realm.AuthorizingRealm
 
getRoles() - Method in class org.apache.shiro.authc.SimpleAccount
Returns this.authzInfo.getRoles();
getRoles() - Method in interface org.apache.shiro.authz.AuthorizationInfo
Returns the names of all roles assigned to a corresponding Subject.
getRoles() - Method in class org.apache.shiro.authz.SimpleAuthorizationInfo
 
getSalt(AuthenticationToken) - Method in class org.apache.shiro.authc.credential.HashedCredentialsMatcher
Deprecated. since Shiro 1.1. Hash salting is now expected to be based on if the AuthenticationInfo returned from the Realm is a SaltedAuthenticationInfo instance and its getCredentialsSalt() method returns a non-null value. This method and the 1.0 behavior still exists for backwards compatibility if the Realm does not return SaltedAuthenticationInfo instances, but it is highly recommended that Realm implementations that support hashed credentials start returning SaltedAuthenticationInfo instances as soon as possible.

This is because salts should always be obtained from the stored account information and never be interpreted based on user/Subject-entered data. User-entered data is easier to compromise for attackers, whereas account-unique (and secure randomly-generated) salts never disseminated to the end-user are almost impossible to break. This method will be removed in Shiro 2.0.

getSalt() - Method in interface org.apache.shiro.crypto.hash.Hash
Returns a salt used to compute the hash or null if no salt was used.
getSalt() - Method in interface org.apache.shiro.crypto.hash.HashRequest
Returns a salt to be used by the HashService during hash computation, or null if no salt is provided as part of the request.
getSalt() - Method in class org.apache.shiro.crypto.hash.SimpleHash
 
getSalt() - Method in class org.apache.shiro.crypto.hash.SimpleHashRequest
 
getSaltForUser(String) - Method in class org.apache.shiro.realm.jdbc.JdbcRealm
 
getSavedRequest(ServletRequest) - Static method in class org.apache.shiro.web.util.WebUtils
 
getScheduler() - Method in class org.apache.shiro.session.mgt.quartz.QuartzSessionValidationScheduler
 
getScheme(String, int) - Method in class org.apache.shiro.web.filter.authz.PortFilter
 
getScheme(String, int) - Method in class org.apache.shiro.web.filter.authz.SslFilter
 
getSearchPackages() - Method in class org.apache.shiro.crypto.hash.format.DefaultHashFormatFactory
Returns a set of package names that can be searched for HashFormat implementations according to heuristics defined in the getHashFormat(packageName, token) JavaDoc.
getSection(String) - Method in class org.apache.shiro.config.Ini
Returns the Ini.Section with the given name or null if no section with that name exists.
getSectionName(String) - Static method in class org.apache.shiro.config.Ini
 
getSectionNames() - Method in class org.apache.shiro.config.Ini
Returns the names of all sections managed by this Ini instance or an empty collection if there are no sections.
getSectionProperty(String, String) - Method in class org.apache.shiro.config.Ini
Returns the value of the specified section property, or null if the section or property do not exist.
getSectionProperty(String, String, String) - Method in class org.apache.shiro.config.Ini
Returns the value of the specified section property, or the defaultValue if the section or property do not exist.
getSections() - Method in class org.apache.shiro.config.Ini
Returns the sections managed by this Ini instance or an empty collection if there are no sections.
getSecureRandom() - Method in class org.apache.shiro.crypto.JcaCipherService
Returns a source of randomness for encryption operations.
getSecureRandom() - Method in class org.apache.shiro.crypto.SecureRandomNumberGenerator
Returns the SecureRandom backing this instance.
getSecurityManager() - Method in class org.apache.shiro.env.DefaultEnvironment
Returns the application's SecurityManager instance accessible in the backing map using the securityManagerName property as the lookup key.
getSecurityManager() - Method in interface org.apache.shiro.env.Environment
Returns the application's SecurityManager instance.
getSecurityManager() - Static method in class org.apache.shiro.SecurityUtils
Returns the SecurityManager accessible to the calling code.
getSecurityManager() - Method in class org.apache.shiro.spring.security.interceptor.AuthorizationAttributeSourceAdvisor
 
getSecurityManager() - Method in class org.apache.shiro.spring.web.ShiroFilterFactoryBean
Sets the application SecurityManager instance to be used by the constructed Shiro Filter.
getSecurityManager() - Method in interface org.apache.shiro.subject.SubjectContext
Returns the SecurityManager instance that should be used to back the constructed Subject instance or null if one has not yet been provided to this context.
getSecurityManager() - Method in class org.apache.shiro.subject.support.DefaultSubjectContext
 
getSecurityManager() - Method in class org.apache.shiro.subject.support.DelegatingSubject
 
getSecurityManager() - Static method in class org.apache.shiro.util.ThreadContext
Convenience method that simplifies retrieval of the application's SecurityManager instance from the current thread.
getSecurityManager() - Method in class org.apache.shiro.web.env.DefaultWebEnvironment
 
getSecurityManager() - Method in class org.apache.shiro.web.servlet.AbstractShiroFilter
 
getSecurityManagerName() - Method in class org.apache.shiro.env.DefaultEnvironment
Returns the name of the SecurityManager instance in the backing map.
getSerializer() - Method in class org.apache.shiro.mgt.AbstractRememberMeManager
Returns the Serializer used to serialize and deserialize PrincipalCollection instances for persistent remember me storage.
getServletContext() - Method in class org.apache.shiro.web.env.DefaultWebEnvironment
 
getServletContext() - Method in interface org.apache.shiro.web.env.WebEnvironment
Returns the ServletContext associated with this WebEnvironment instance.
getServletContext() - Method in class org.apache.shiro.web.servlet.ServletContextSupport
 
getServletContext() - Method in class org.apache.shiro.web.servlet.ShiroHttpSession
 
getServletContextIniResource(String) - Method in class org.apache.shiro.web.servlet.IniShiroFilter
Deprecated. Returns the INI instance reflecting the specified servlet context resource path or null if no resource was found.
getServletRequest() - Method in class org.apache.shiro.web.session.mgt.DefaultWebSessionContext
 
getServletRequest() - Method in interface org.apache.shiro.web.session.mgt.WebSessionContext
Returns the ServletRequest received by the servlet container triggering the creation of the Session instance.
getServletRequest() - Method in class org.apache.shiro.web.session.mgt.WebSessionKey
 
getServletRequest() - Method in class org.apache.shiro.web.subject.support.DefaultWebSubjectContext
 
getServletRequest() - Method in class org.apache.shiro.web.subject.support.WebDelegatingSubject
 
getServletRequest() - Method in interface org.apache.shiro.web.subject.WebSubject
Returns the ServletRequest accessible when the Subject instance was created.
getServletRequest() - Method in interface org.apache.shiro.web.subject.WebSubjectContext
Returns the ServletRequest received by the servlet container triggering the creation of the Subject instance.
getServletRequest() - Method in interface org.apache.shiro.web.util.RequestPairSource
Returns the incoming ServletRequest associated with the component.
getServletResponse() - Method in class org.apache.shiro.web.session.mgt.DefaultWebSessionContext
 
getServletResponse() - Method in interface org.apache.shiro.web.session.mgt.WebSessionContext
The paired ServletResponse corresponding to the associated servletRequest.
getServletResponse() - Method in class org.apache.shiro.web.session.mgt.WebSessionKey
 
getServletResponse() - Method in class org.apache.shiro.web.subject.support.DefaultWebSubjectContext
 
getServletResponse() - Method in class org.apache.shiro.web.subject.support.WebDelegatingSubject
 
getServletResponse() - Method in interface org.apache.shiro.web.subject.WebSubject
Returns the ServletResponse accessible when the Subject instance was created.
getServletResponse() - Method in interface org.apache.shiro.web.subject.WebSubjectContext
The paired ServletResponse corresponding to the associated servletRequest.
getServletResponse() - Method in interface org.apache.shiro.web.util.RequestPairSource
Returns the outgoing ServletResponse paired with the incoming servletRequest.
getSession(SessionKey) - Method in class org.apache.shiro.mgt.SessionsSecurityManager
 
getSession(SessionKey) - Method in class org.apache.shiro.session.mgt.AbstractNativeSessionManager
 
getSession(SessionKey) - Method in interface org.apache.shiro.session.mgt.SessionManager
Retrieves the session corresponding to the specified contextual data (such as a session ID if applicable), or null if no Session could be found.
getSession() - Method in interface org.apache.shiro.subject.Subject
Returns the application Session associated with this Subject.
getSession(boolean) - Method in interface org.apache.shiro.subject.Subject
Returns the application Session associated with this Subject.
getSession() - Method in interface org.apache.shiro.subject.SubjectContext
Returns the Session to use when building the Subject instance.
getSession() - Method in class org.apache.shiro.subject.support.DefaultSubjectContext
 
getSession() - Method in class org.apache.shiro.subject.support.DelegatingSubject
 
getSession(boolean) - Method in class org.apache.shiro.subject.support.DelegatingSubject
 
getSession(boolean) - Method in class org.apache.shiro.web.servlet.ShiroHttpServletRequest
 
getSession() - Method in class org.apache.shiro.web.servlet.ShiroHttpServletRequest
 
getSession() - Method in class org.apache.shiro.web.servlet.ShiroHttpSession
 
getSession(SessionKey) - Method in class org.apache.shiro.web.session.mgt.ServletContainerSessionManager
 
getSessionContext() - Method in class org.apache.shiro.web.servlet.ShiroHttpSession
 
getSessionDAO() - Method in class org.apache.shiro.session.mgt.DefaultSessionManager
 
getSessionFactory() - Method in class org.apache.shiro.session.mgt.DefaultSessionManager
Returns the SessionFactory used to generate new Session instances.
getSessionId() - Method in class org.apache.shiro.session.mgt.DefaultSessionContext
 
getSessionId() - Method in class org.apache.shiro.session.mgt.DefaultSessionKey
 
getSessionId(SessionKey) - Method in class org.apache.shiro.session.mgt.DefaultSessionManager
 
getSessionId() - Method in interface org.apache.shiro.session.mgt.SessionContext
 
getSessionId() - Method in interface org.apache.shiro.session.mgt.SessionKey
Returns the id of the session to acquire.
getSessionId() - Method in interface org.apache.shiro.subject.SubjectContext
Returns the session id of the session that should be associated with the constructed Subject instance.
getSessionId() - Method in class org.apache.shiro.subject.support.DefaultSubjectContext
 
getSessionId(SessionKey) - Method in class org.apache.shiro.web.session.mgt.DefaultWebSessionManager
 
getSessionId(ServletRequest, ServletResponse) - Method in class org.apache.shiro.web.session.mgt.DefaultWebSessionManager
 
getSessionIdCookie() - Method in class org.apache.shiro.web.session.mgt.DefaultWebSessionManager
 
getSessionIdGenerator() - Method in class org.apache.shiro.session.mgt.eis.AbstractSessionDAO
Returns the SessionIdGenerator used by the AbstractSessionDAO.generateSessionId(org.apache.shiro.session.Session) method.
getSessionKey(SubjectContext) - Method in class org.apache.shiro.mgt.DefaultSecurityManager
 
getSessionKey(SubjectContext) - Method in class org.apache.shiro.web.mgt.DefaultWebSecurityManager
 
getSessionListeners() - Method in class org.apache.shiro.session.mgt.AbstractNativeSessionManager
 
getSessionManager() - Method in class org.apache.shiro.mgt.SessionsSecurityManager
Returns this security manager's internal delegate SessionManager.
getSessionManager() - Method in class org.apache.shiro.session.mgt.ExecutorServiceSessionValidationScheduler
 
getSessionMode() - Method in class org.apache.shiro.web.mgt.DefaultWebSecurityManager
Deprecated. 
getSessionStorageEvaluator() - Method in class org.apache.shiro.mgt.DefaultSubjectDAO
Returns the SessionStorageEvaluator that will determine if a Subject's state may be persisted in the Subject's session.
getSessionValidationInterval() - Method in class org.apache.shiro.session.mgt.AbstractValidatingSessionManager
 
getSessionValidationScheduler() - Method in class org.apache.shiro.session.mgt.AbstractValidatingSessionManager
 
getSource() - Method in interface org.apache.shiro.crypto.hash.HashRequest
Returns the source data that will be hashed by a HashService.
getSource() - Method in class org.apache.shiro.crypto.hash.SimpleHashRequest
 
getSpecifiedIni(String[]) - Method in class org.apache.shiro.web.env.IniWebEnvironment
 
getStartTimestamp(SessionKey) - Method in class org.apache.shiro.session.mgt.AbstractNativeSessionManager
 
getStartTimestamp() - Method in class org.apache.shiro.session.mgt.DelegatingSession
 
getStartTimestamp(SessionKey) - Method in interface org.apache.shiro.session.mgt.NativeSessionManager
Returns the time the associated Session started (was created).
getStartTimestamp() - Method in class org.apache.shiro.session.mgt.SimpleSession
 
getStartTimestamp() - Method in class org.apache.shiro.session.ProxiedSession
Immediately delegates to the underlying proxied session.
getStartTimestamp() - Method in interface org.apache.shiro.session.Session
Returns the time the session was started; that is, the time the system created the instance.
getStartTimestamp() - Method in class org.apache.shiro.web.session.HttpServletSession
 
getStopTimestamp() - Method in class org.apache.shiro.session.mgt.SimpleSession
Returns the time the session was stopped, or null if the session is still active.
getStoredPassword(AuthenticationInfo) - Method in class org.apache.shiro.authc.credential.PasswordMatcher
 
getStreamingBlockSize() - Method in class org.apache.shiro.crypto.DefaultBlockCipherService
 
getStreamingBufferSize() - Method in class org.apache.shiro.crypto.JcaCipherService
Returns the size in bytes of the internal buffer used to transfer data from one stream to another during stream operations (JcaCipherService.encrypt(java.io.InputStream, java.io.OutputStream, byte[]) and JcaCipherService.decrypt(java.io.InputStream, java.io.OutputStream, byte[])).
getStreamingModeName() - Method in class org.apache.shiro.crypto.DefaultBlockCipherService
Same purpose as the modeName attribute, but is used instead only for for streaming operations (JcaCipherService.encrypt(java.io.InputStream, java.io.OutputStream, byte[]) and JcaCipherService.decrypt(java.io.InputStream, java.io.OutputStream, byte[])).
getStreamingPaddingSchemeName() - Method in class org.apache.shiro.crypto.DefaultBlockCipherService
 
getStringPermissions() - Method in class org.apache.shiro.authc.SimpleAccount
Returns all String-based permissions assigned to this Account.
getStringPermissions() - Method in interface org.apache.shiro.authz.AuthorizationInfo
Returns all string-based permissions assigned to the corresponding Subject.
getStringPermissions() - Method in class org.apache.shiro.authz.SimpleAuthorizationInfo
 
getSubject() - Method in class org.apache.shiro.aop.AnnotationHandler
Returns the Subject associated with the currently-executing code.
getSubject() - Method in class org.apache.shiro.aop.MethodInterceptorSupport
Returns the Subject associated with the currently-executing code.
getSubject() - Method in class org.apache.shiro.concurrent.SubjectAwareExecutor
Returns the currently Subject instance that should be associated with Runnable or Callable instances before being dispatched to the target Executor instance.
getSubject() - Static method in class org.apache.shiro.SecurityUtils
Returns the currently accessible Subject available to the calling code depending on runtime environment.
getSubject() - Method in interface org.apache.shiro.subject.SubjectContext
Returns any existing Subject that may be in use at the time the new Subject instance is being created.
getSubject() - Method in class org.apache.shiro.subject.support.DefaultSubjectContext
 
getSubject() - Method in class org.apache.shiro.subject.support.SubjectThreadState
Returns the Subject instance managed by this ThreadState implementation.
getSubject() - Static method in class org.apache.shiro.util.ThreadContext
Convenience method that simplifies retrieval of a thread-bound Subject.
getSubject(ServletRequest, ServletResponse) - Method in class org.apache.shiro.web.filter.AccessControlFilter
Convenience method that acquires the Subject associated with the request.
getSubject(ServletRequest, ServletResponse) - Method in class org.apache.shiro.web.filter.authc.LogoutFilter
Returns the currently executing Subject.
getSubject() - Method in class org.apache.shiro.web.servlet.ShiroHttpServletRequest
 
getSubject() - Method in class org.apache.shiro.web.tags.SecureTag
 
getSubjectContext() - Method in class org.apache.shiro.subject.Subject.Builder
Returns the backing context used to build the Subject instance, available to subclasses since the context class attribute is marked as private.
getSubjectDAO() - Method in class org.apache.shiro.mgt.DefaultSecurityManager
Returns the SubjectDAO responsible for persisting Subject state, typically used after login or when an Subject identity is discovered (eg after RememberMe services).
getSubjectFactory() - Method in class org.apache.shiro.mgt.DefaultSecurityManager
Returns the SubjectFactory responsible for creating Subject instances exposed to the application.
getSubjectPrincipal() - Method in class org.apache.shiro.web.servlet.ShiroHttpServletRequest
 
getSubmittedPassword(AuthenticationToken) - Method in class org.apache.shiro.authc.credential.PasswordMatcher
 
getSuccessUrl() - Method in class org.apache.shiro.spring.web.ShiroFilterFactoryBean
Returns the application's after-login success URL to be assigned to all acquired Filters that subclass AuthenticationFilter or null if no value should be assigned globally.
getSuccessUrl() - Method in class org.apache.shiro.web.filter.authc.AuthenticationFilter
Returns the success url to use as the default location a user is sent after logging in.
getSystemLdapContext() - Method in class org.apache.shiro.realm.ldap.DefaultLdapContextFactory
Deprecated.  
getSystemLdapContext() - Method in class org.apache.shiro.realm.ldap.JndiLdapContextFactory
This implementation delegates to JndiLdapContextFactory.getLdapContext(Object, Object) using the systemUsername and systemPassword properties as arguments.
getSystemLdapContext() - Method in interface org.apache.shiro.realm.ldap.LdapContextFactory
Creates (or retrieves from a pool) a LdapContext connection bound using the system account, or anonymously if no system account is configured.
getSystemPassword() - Method in class org.apache.shiro.realm.ldap.JndiLdapContextFactory
Returns the password of the systemUsername that will be used when creating an LDAP connection used for authorization queries.
getSystemUsername() - Method in class org.apache.shiro.realm.ldap.JndiLdapContextFactory
Returns the system username that will be used when creating an LDAP connection used for authorization queries.
getTargetExecutor() - Method in class org.apache.shiro.concurrent.SubjectAwareExecutor
Returns the target Executor instance that will actually execute the subject-associated Runnable instances.
getTargetExecutorService() - Method in class org.apache.shiro.concurrent.SubjectAwareExecutorService
 
getTargets() - Method in class org.apache.shiro.authz.permission.DomainPermission
 
getTargetScheduledExecutorService() - Method in class org.apache.shiro.concurrent.SubjectAwareScheduledExecutorService
 
getThis() - Method in interface org.apache.shiro.aop.MethodInvocation
Returns the object that holds the current joinpoint's static part.
getThis() - Method in class org.apache.shiro.aspectj.BeforeAdviceMethodInvocationAdapter
 
getTimeout(SessionKey) - Method in class org.apache.shiro.session.mgt.AbstractNativeSessionManager
 
getTimeout(Session) - Method in class org.apache.shiro.session.mgt.AbstractValidatingSessionManager
Subclass template hook in case per-session timeout is not based on Session.getTimeout().
getTimeout() - Method in class org.apache.shiro.session.mgt.DelegatingSession
 
getTimeout(SessionKey) - Method in interface org.apache.shiro.session.mgt.NativeSessionManager
Returns the time in milliseconds that the associated session may remain idle before expiring.
getTimeout() - Method in class org.apache.shiro.session.mgt.SimpleSession
 
getTimeout() - Method in class org.apache.shiro.session.ProxiedSession
Immediately delegates to the underlying proxied session.
getTimeout() - Method in interface org.apache.shiro.session.Session
Returns the time in milliseconds that the session session may remain idle before expiring.
getTimeout() - Method in class org.apache.shiro.web.session.HttpServletSession
 
getTransformationName() - Method in enum org.apache.shiro.crypto.PaddingScheme
Returns the actual string name to use when building the Cipher transformation string.
getTransformationString(boolean) - Method in class org.apache.shiro.crypto.DefaultBlockCipherService
Returns the transformation string to use with the Cipher.getInstance(java.lang.String) call.
getTransformationString(boolean) - Method in class org.apache.shiro.crypto.JcaCipherService
Returns the transformation string to use with the Cipher.getInstance(java.lang.String) invocation when creating a new Cipher instance.
getType() - Method in class org.apache.shiro.web.tags.PrincipalTag
 
getTypedValue(String, Class<E>) - Method in class org.apache.shiro.util.MapContext
Performs a get operation but additionally ensures that the value returned is of the specified type.
getUnauthorizedUrl() - Method in class org.apache.shiro.spring.web.ShiroFilterFactoryBean
Returns the application's after-login success URL to be assigned to all acquired Filters that subclass AuthenticationFilter or null if no value should be assigned globally.
getUnauthorizedUrl() - Method in class org.apache.shiro.web.filter.authz.AuthorizationFilter
Returns the URL to which users should be redirected if they are denied access to an underlying path or resource, or null if a raw HttpServletResponse.SC_UNAUTHORIZED response should be issued (401 Unauthorized).
getUrl() - Method in class org.apache.shiro.realm.ldap.JndiLdapContextFactory
Returns the LDAP url to connect to.
getUrl() - Method in class org.apache.shiro.web.util.RedirectView
 
getUser(String) - Method in class org.apache.shiro.realm.SimpleAccountRealm
 
getUserDefinitions() - Method in class org.apache.shiro.realm.text.TextConfigurationRealm
 
getUserDn(String) - Method in class org.apache.shiro.realm.ldap.JndiLdapRealm
Returns the LDAP User Distinguished Name (DN) to use when acquiring an LdapContext from the LdapContextFactory.
getUserDnPrefix() - Method in class org.apache.shiro.realm.ldap.JndiLdapRealm
Returns the User DN prefix to use when building a runtime User DN value or null if no userDnTemplate has been configured.
getUserDnSuffix() - Method in class org.apache.shiro.realm.ldap.JndiLdapRealm
Returns the User DN suffix to use when building a runtime User DN value.
getUserDnTemplate() - Method in class org.apache.shiro.realm.ldap.JndiLdapRealm
Returns the User Distinguished Name (DN) template to use when creating User DNs at runtime - see the setUserDnTemplate JavaDoc for a full explanation.
getUsername() - Method in class org.apache.shiro.authc.UsernamePasswordToken
Returns the username submitted during an authentication attempt.
getUsername(SimpleAccount) - Method in class org.apache.shiro.realm.SimpleAccountRealm
 
getUsername(PrincipalCollection) - Method in class org.apache.shiro.realm.SimpleAccountRealm
 
getUsername(String) - Method in class org.apache.shiro.realm.text.PropertiesRealm
 
getUsername(ServletRequest) - Method in class org.apache.shiro.web.filter.authc.FormAuthenticationFilter
 
getUsernameParam() - Method in class org.apache.shiro.web.filter.authc.FormAuthenticationFilter
 
getUserPrincipal() - Method in class org.apache.shiro.web.servlet.ShiroHttpServletRequest
 
getValidationProtocol() - Method in class org.apache.shiro.cas.CasRealm
 
getValue() - Method in interface org.apache.shiro.web.servlet.Cookie
 
getValue(String) - Method in class org.apache.shiro.web.servlet.ShiroHttpSession
 
getValue() - Method in class org.apache.shiro.web.servlet.SimpleCookie
 
getValueNames() - Method in class org.apache.shiro.web.servlet.ShiroHttpSession
 
getVersion() - Static method in class org.apache.shiro.util.JavaEnvironment
Return the full Java version string, as returned by System.getProperty("java.version").
getVersion() - Method in interface org.apache.shiro.web.servlet.Cookie
 
getVersion() - Method in class org.apache.shiro.web.servlet.SimpleCookie
 
getWebEnvironment(ServletContext) - Static method in class org.apache.shiro.web.util.WebUtils
Find the Shiro WebEnvironment for this web application, which is typically loaded via EnvironmentLoaderListener.
getWebEnvironment(ServletContext, String) - Static method in class org.apache.shiro.web.util.WebUtils
Find the Shiro WebEnvironment for this web application.
getWebSecurityManager() - Method in class org.apache.shiro.web.env.DefaultWebEnvironment
 
getWebSecurityManager() - Method in interface org.apache.shiro.web.env.WebEnvironment
Returns the web application's security manager instance.
GMT_TIME_ZONE_ID - Static variable in class org.apache.shiro.web.servlet.SimpleCookie
 
GuestAnnotationHandler - Class in org.apache.shiro.authz.aop
Checks to see if a @RequiresGuest annotation is declared, and if so, ensures the calling Subject does not have an identity before invoking the method.
GuestAnnotationHandler() - Constructor for class org.apache.shiro.authz.aop.GuestAnnotationHandler
Default no-argument constructor that ensures this interceptor looks for RequiresGuest annotations in a method declaration.
GuestAnnotationMethodInterceptor - Class in org.apache.shiro.authz.aop
Checks to see if a @RequiresGuest annotation is declared, and if so, ensures the calling Subject does not have an identity before invoking the method.
GuestAnnotationMethodInterceptor() - Constructor for class org.apache.shiro.authz.aop.GuestAnnotationMethodInterceptor
Default no-argument constructor that ensures this interceptor looks for RequiresGuest annotations in a method declaration.
GuestAnnotationMethodInterceptor(AnnotationResolver) - Constructor for class org.apache.shiro.authz.aop.GuestAnnotationMethodInterceptor
 
GuestTag - Class in org.apache.shiro.web.tags
JSP tag that renders the tag body if the current user is not known to the system, either because they haven't logged in yet, or because they have no 'RememberMe' identity.
GuestTag() - Constructor for class org.apache.shiro.web.tags.GuestTag
 
guiceFilterModule() - Static method in class org.apache.shiro.guice.web.ShiroWebModule
 
guiceFilterModule(String) - Static method in class org.apache.shiro.guice.web.ShiroWebModule
 
GuiceShiroFilter - Class in org.apache.shiro.guice.web
Shiro filter that is managed by and receives its filter chain configurations from Guice.

H

H64 - Class in org.apache.shiro.codec
Codec for Unix Crypt-style encoding.
H64() - Constructor for class org.apache.shiro.codec.H64
 
hasAllRoles(PrincipalCollection, Collection<String>) - Method in interface org.apache.shiro.authz.Authorizer
Returns true if the corresponding Subject/user has all of the specified roles, false otherwise.
hasAllRoles(PrincipalCollection, Collection<String>) - Method in class org.apache.shiro.authz.ModularRealmAuthorizer
Returns true iff any of the configured realms' ModularRealmAuthorizer.hasRole(org.apache.shiro.subject.PrincipalCollection, String) call returns true for all roles specified, false otherwise.
hasAllRoles(PrincipalCollection, Collection<String>) - Method in class org.apache.shiro.mgt.AuthorizingSecurityManager
 
hasAllRoles(PrincipalCollection, Collection<String>) - Method in class org.apache.shiro.realm.AuthorizingRealm
 
hasAllRoles(Collection<String>) - Method in interface org.apache.shiro.subject.Subject
Returns true if this Subject has all of the specified roles, false otherwise.
hasAllRoles(Collection<String>) - Method in class org.apache.shiro.subject.support.DelegatingSubject
 
HasAnyRolesTag - Class in org.apache.shiro.web.tags
Displays body content if the current user has any of the roles specified.
HasAnyRolesTag() - Constructor for class org.apache.shiro.web.tags.HasAnyRolesTag
 
hasChains() - Method in class org.apache.shiro.web.filter.mgt.DefaultFilterChainManager
 
hasChains() - Method in interface org.apache.shiro.web.filter.mgt.FilterChainManager
Returns true if one or more configured chains are available, false if none are configured.
hash(byte[]) - Method in class org.apache.shiro.crypto.hash.AbstractHash
Deprecated. Hashes the specified byte array without a salt for a single iteration.
hash(byte[], byte[]) - Method in class org.apache.shiro.crypto.hash.AbstractHash
Deprecated. Hashes the specified byte array using the given salt for a single iteration.
hash(byte[], byte[], int) - Method in class org.apache.shiro.crypto.hash.AbstractHash
Deprecated. Hashes the specified byte array using the given salt for the specified number of iterations.
Hash - Interface in org.apache.shiro.crypto.hash
A Cryptographic Hash represents a one-way conversion algorithm that transforms an input source to an underlying byte array.
hash(byte[]) - Method in class org.apache.shiro.crypto.hash.SimpleHash
Hashes the specified byte array without a salt for a single iteration.
hash(byte[], byte[]) - Method in class org.apache.shiro.crypto.hash.SimpleHash
Hashes the specified byte array using the given salt for a single iteration.
hash(byte[], byte[], int) - Method in class org.apache.shiro.crypto.hash.SimpleHash
Hashes the specified byte array using the given salt for the specified number of iterations.
hashCode() - Method in class org.apache.shiro.authc.SimpleAccount
If the principals are not null, returns principals.hashCode(), otherwise returns 0 (zero).
hashCode() - Method in class org.apache.shiro.authc.SimpleAuthenticationInfo
Returns the hashcode of the internal principals instance.
hashCode() - Method in class org.apache.shiro.authz.permission.WildcardPermission
 
hashCode() - Method in class org.apache.shiro.authz.SimpleRole
 
hashCode() - Method in class org.apache.shiro.config.Ini
 
hashCode() - Method in class org.apache.shiro.config.Ini.Section
 
hashCode() - Method in class org.apache.shiro.crypto.hash.AbstractHash
Deprecated. Simply returns toHex().hashCode();
hashCode() - Method in class org.apache.shiro.crypto.hash.SimpleHash
Simply returns toHex().hashCode();
hashCode() - Method in class org.apache.shiro.session.mgt.SimpleSession
Returns the hashCode.
hashCode() - Method in class org.apache.shiro.subject.SimplePrincipalCollection
 
hashCode() - Method in class org.apache.shiro.util.SimpleByteSource
 
HashedCredentialsMatcher - Class in org.apache.shiro.authc.credential
A HashedCredentialMatcher provides support for hashing of supplied AuthenticationToken credentials before being compared to those in the AuthenticationInfo from the data store.
HashedCredentialsMatcher() - Constructor for class org.apache.shiro.authc.credential.HashedCredentialsMatcher
JavaBeans-compatibile no-arg constructor intended for use in IoC/Dependency Injection environments.
HashedCredentialsMatcher(String) - Constructor for class org.apache.shiro.authc.credential.HashedCredentialsMatcher
Creates an instance using the specified hashAlgorithmName to hash submitted credentials.
Hasher - Class in org.apache.shiro.tools.hasher
Commandline line utility to hash data such as strings, passwords, resources (files, urls, etc).
Hasher() - Constructor for class org.apache.shiro.tools.hasher.Hasher
 
HashFormat - Interface in org.apache.shiro.crypto.hash.format
A HashFormat is able to format a Hash instance into a well-defined formatted String.
HashFormatFactory - Interface in org.apache.shiro.crypto.hash.format
 
HashingPasswordService - Interface in org.apache.shiro.authc.credential
A HashingPasswordService is a PasswordService that performs password encryption and comparisons based on cryptographic Hashes.
hashPassword(Object) - Method in class org.apache.shiro.authc.credential.DefaultPasswordService
 
hashPassword(Object) - Method in interface org.apache.shiro.authc.credential.HashingPasswordService
Hashes the specified plaintext password using internal hashing configuration settings pertinent to password hashing.
hashProvidedCredentials(AuthenticationToken, AuthenticationInfo) - Method in class org.apache.shiro.authc.credential.HashedCredentialsMatcher
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).
hashProvidedCredentials(Object, Object, int) - Method in class org.apache.shiro.authc.credential.HashedCredentialsMatcher
Hashes the provided credentials a total of hashIterations times, using the given salt.
HashRequest - Interface in org.apache.shiro.crypto.hash
A HashRequest is composed of data that will be used by a HashService to compute a hash (aka 'digest').
HashRequest.Builder - Class in org.apache.shiro.crypto.hash
A Builder class representing the Builder design pattern for constructing HashRequest instances.
HashRequest.Builder() - Constructor for class org.apache.shiro.crypto.hash.HashRequest.Builder
Default no-arg constructor.
HashService - Interface in org.apache.shiro.crypto.hash
A HashService hashes input sources utilizing a particular hashing strategy.
hasLength(String) - Static method in class org.apache.shiro.util.StringUtils
Check that the given String is neither null nor of length 0.
HasPermissionTag - Class in org.apache.shiro.web.tags
 
HasPermissionTag() - Constructor for class org.apache.shiro.web.tags.HasPermissionTag
 
hasPrincipals() - Method in class org.apache.shiro.subject.support.DelegatingSubject
 
hasResourcePrefix(String) - Static method in class org.apache.shiro.io.ResourceUtils
Returns true if the resource path is not null and starts with one of the recognized resource prefixes (CLASSPATH_PREFIX, URL_PREFIX, or FILE_PREFIX), false otherwise.
hasRole(PrincipalCollection, String) - Method in interface org.apache.shiro.authz.Authorizer
Returns true if the corresponding Subject/user has the specified role, false otherwise.
hasRole(PrincipalCollection, String) - Method in class org.apache.shiro.authz.ModularRealmAuthorizer
Returns true if any of the configured realms' ModularRealmAuthorizer.hasRole(org.apache.shiro.subject.PrincipalCollection, String) call returns true, false otherwise.
hasRole(PrincipalCollection, String) - Method in class org.apache.shiro.mgt.AuthorizingSecurityManager
 
hasRole(PrincipalCollection, String) - Method in class org.apache.shiro.realm.AuthorizingRealm
 
hasRole(String, AuthorizationInfo) - Method in class org.apache.shiro.realm.AuthorizingRealm
 
hasRole(String) - Method in interface org.apache.shiro.subject.Subject
Returns true if this Subject has the specified role, false otherwise.
hasRole(String) - Method in class org.apache.shiro.subject.support.DelegatingSubject
 
hasRoles(PrincipalCollection, List<String>) - Method in interface org.apache.shiro.authz.Authorizer
Checks if the corresponding Subject/user has the specified roles, returning a boolean array indicating which roles are associated with the given subject.
hasRoles(PrincipalCollection, List<String>) - Method in class org.apache.shiro.authz.ModularRealmAuthorizer
Calls ModularRealmAuthorizer.hasRole(org.apache.shiro.subject.PrincipalCollection, String) for each role name in the specified collection and places the return value from each call at the respective location in the returned array.
hasRoles(PrincipalCollection, List<String>) - Method in class org.apache.shiro.mgt.AuthorizingSecurityManager
 
hasRoles(PrincipalCollection, List<String>) - Method in class org.apache.shiro.realm.AuthorizingRealm
 
hasRoles(List<String>, AuthorizationInfo) - Method in class org.apache.shiro.realm.AuthorizingRealm
 
hasRoles(List<String>) - Method in interface org.apache.shiro.subject.Subject
Checks if this Subject has the specified roles, returning a boolean array indicating which roles are associated.
hasRoles(List<String>) - Method in class org.apache.shiro.subject.support.DelegatingSubject
 
HasRoleTag - Class in org.apache.shiro.web.tags
 
HasRoleTag() - Constructor for class org.apache.shiro.web.tags.HasRoleTag
 
hasText(String) - Static method in class org.apache.shiro.util.StringUtils
Check whether the given String has actual text.
Hex - Class in org.apache.shiro.codec
Hexadecimal encoder and decoder.
Hex() - Constructor for class org.apache.shiro.codec.Hex
 
HexFormat - Class in org.apache.shiro.crypto.hash.format
HashFormat that outputs only The hash's digest bytes in hex format.
HexFormat() - Constructor for class org.apache.shiro.crypto.hash.format.HexFormat
 
host(String) - Method in class org.apache.shiro.subject.Subject.Builder
Ensures the Subject being built will reflect the specified host name or IP as its originating location.
host - Variable in class org.apache.shiro.subject.support.DelegatingSubject
 
HOST_KEY - Static variable in class org.apache.shiro.spring.remoting.SecureRemoteInvocationFactory
 
HostAuthenticationToken - Interface in org.apache.shiro.authc
A HostAuthenticationToken retains the host information from where an authentication attempt originates.
HostFilter - Class in org.apache.shiro.web.filter.authz
A Filter that can allow or deny access based on the host that sent the request.
HostFilter() - Constructor for class org.apache.shiro.web.filter.authz.HostFilter
 
HostUnauthorizedException - Exception in org.apache.shiro.authz
Thrown when a particular client (that is, host address) has not been enabled to access the system or if the client has been enabled access but is not permitted to perform a particular operation or access a particular resource.
HostUnauthorizedException() - Constructor for exception org.apache.shiro.authz.HostUnauthorizedException
Creates a new HostUnauthorizedException.
HostUnauthorizedException(String) - Constructor for exception org.apache.shiro.authz.HostUnauthorizedException
Constructs a new HostUnauthorizedException.
HostUnauthorizedException(Throwable) - Constructor for exception org.apache.shiro.authz.HostUnauthorizedException
Constructs a new HostUnauthorizedException.
HostUnauthorizedException(String, Throwable) - Constructor for exception org.apache.shiro.authz.HostUnauthorizedException
Constructs a new HostUnauthorizedException.
HTTP_ONLY_ATTRIBUTE_NAME - Static variable in class org.apache.shiro.web.servlet.SimpleCookie
 
HTTP_SCHEME - Static variable in class org.apache.shiro.web.filter.authz.PortFilter
 
HTTP_SESSION_MODE - Static variable in class org.apache.shiro.web.mgt.DefaultWebSecurityManager
Deprecated. 
HttpMethodPermissionFilter - Class in org.apache.shiro.web.filter.authz
A filter that translates an HTTP Request's Method (eg GET, POST, etc) into an corresponding action (verb) and uses that verb to construct a permission that will be checked to determine access.
HttpMethodPermissionFilter() - Constructor for class org.apache.shiro.web.filter.authz.HttpMethodPermissionFilter
Creates the filter instance with default method-to-action values in the instance's http method actions map.
HTTPS_SCHEME - Static variable in class org.apache.shiro.web.filter.authz.SslFilter
 
HttpServletSession - Class in org.apache.shiro.web.session
Session implementation that is backed entirely by a standard servlet container HttpSession instance.
HttpServletSession(HttpSession, String) - Constructor for class org.apache.shiro.web.session.HttpServletSession
 
httpSessions - Variable in class org.apache.shiro.web.servlet.ShiroHttpServletRequest
 

I

ID - Static variable in class org.apache.shiro.crypto.hash.format.Shiro1CryptFormat
 
IDENTITY_REMOVED_KEY - Static variable in class org.apache.shiro.web.servlet.ShiroHttpServletRequest
 
ImmutableProxiedSession - Class in org.apache.shiro.session.mgt
Implementation of the Session interface that proxies another Session, but does not allow any 'write' operations to the underlying session.
ImmutableProxiedSession(Session) - Constructor for class org.apache.shiro.session.mgt.ImmutableProxiedSession
Constructs a new instance of this class proxying the specified Session.
implies(Permission) - Method in class org.apache.shiro.authz.permission.AllPermission
Always returns true, indicating any Subject granted this permission can do anything.
implies(Permission) - Method in interface org.apache.shiro.authz.Permission
Returns true if this current instance implies all the functionality and/or resource access described by the specified Permission argument, false otherwise.
implies(Permission) - Method in class org.apache.shiro.authz.permission.WildcardPermission
 
INCLUDE_CONTEXT_PATH_ATTRIBUTE - Static variable in class org.apache.shiro.web.util.WebUtils
 
INCLUDE_PATH_INFO_ATTRIBUTE - Static variable in class org.apache.shiro.web.util.WebUtils
 
INCLUDE_QUERY_STRING_ATTRIBUTE - Static variable in class org.apache.shiro.web.util.WebUtils
 
INCLUDE_REQUEST_URI_ATTRIBUTE - Static variable in class org.apache.shiro.web.util.WebUtils
Standard Servlet 2.3+ spec request attributes for include URI and paths.
INCLUDE_SERVLET_PATH_ATTRIBUTE - Static variable in class org.apache.shiro.web.util.WebUtils
 
IncorrectCredentialsException - Exception in org.apache.shiro.authc
Thrown when attempting to authenticate with credential(s) that do not match the actual credentials associated with the account principal.
IncorrectCredentialsException() - Constructor for exception org.apache.shiro.authc.IncorrectCredentialsException
Creates a new IncorrectCredentialsException.
IncorrectCredentialsException(String) - Constructor for exception org.apache.shiro.authc.IncorrectCredentialsException
Constructs a new IncorrectCredentialsException.
IncorrectCredentialsException(Throwable) - Constructor for exception org.apache.shiro.authc.IncorrectCredentialsException
Constructs a new IncorrectCredentialsException.
IncorrectCredentialsException(String, Throwable) - Constructor for exception org.apache.shiro.authc.IncorrectCredentialsException
Constructs a new IncorrectCredentialsException.
indexOf(Object) - Method in class org.apache.shiro.web.filter.mgt.SimpleNamedFilterList
 
Ini - Class in org.apache.shiro.config
A class representing the INI text configuration format.
Ini() - Constructor for class org.apache.shiro.config.Ini
Creates a new empty Ini instance.
Ini(Ini) - Constructor for class org.apache.shiro.config.Ini
Creates a new Ini instance with the specified defaults.
Ini.Section - Class in org.apache.shiro.config
An Ini.Section is String-key-to-String-value Map, identifiable by a name unique within an Ini instance.
INI_REALM_NAME - Static variable in class org.apache.shiro.config.IniSecurityManagerFactory
 
IniFactorySupport<T> - Class in org.apache.shiro.config
Base support class for Factory implementations that generate their instance(s) based on Ini configuration.
IniFactorySupport() - Constructor for class org.apache.shiro.config.IniFactorySupport
 
IniFactorySupport(Ini) - Constructor for class org.apache.shiro.config.IniFactorySupport
 
IniFilterChainResolverFactory - Class in org.apache.shiro.web.config
A Factory that creates FilterChainResolver instances based on Ini configuration.
IniFilterChainResolverFactory() - Constructor for class org.apache.shiro.web.config.IniFilterChainResolverFactory
 
IniFilterChainResolverFactory(Ini) - Constructor for class org.apache.shiro.web.config.IniFilterChainResolverFactory
 
IniFilterChainResolverFactory(Ini, Map<String, ?>) - Constructor for class org.apache.shiro.web.config.IniFilterChainResolverFactory
 
IniRealm - Class in org.apache.shiro.realm.text
A Realm implementation that creates SimpleAccount instances based on Ini configuration.
IniRealm() - Constructor for class org.apache.shiro.realm.text.IniRealm
 
IniRealm(Ini) - Constructor for class org.apache.shiro.realm.text.IniRealm
This constructor will immediately process the definitions in the Ini argument.
IniRealm(String) - Constructor for class org.apache.shiro.realm.text.IniRealm
This constructor will immediately process the definitions in the Ini resolved from the specified resourcePath.
IniSecurityManagerFactory - Class in org.apache.shiro.config
A Factory that creates SecurityManager instances based on Ini configuration.
IniSecurityManagerFactory() - Constructor for class org.apache.shiro.config.IniSecurityManagerFactory
Creates a new instance.
IniSecurityManagerFactory(Ini) - Constructor for class org.apache.shiro.config.IniSecurityManagerFactory
 
IniSecurityManagerFactory(String) - Constructor for class org.apache.shiro.config.IniSecurityManagerFactory
 
IniShiroFilter - Class in org.apache.shiro.web.servlet
Deprecated. in 1.2 in favor of using the ShiroFilter
IniShiroFilter() - Constructor for class org.apache.shiro.web.servlet.IniShiroFilter
Deprecated.  
init() - Method in class org.apache.shiro.cache.ehcache.EhCacheManager
Initializes this instance.
init() - Method in class org.apache.shiro.realm.AuthenticatingRealm
Initializes this realm and potentially enables an authentication cache, depending on configuration.
init() - Method in interface org.apache.shiro.util.Initializable
Initializes this object.
init(Object) - Static method in class org.apache.shiro.util.LifecycleUtils
 
init(Initializable) - Static method in class org.apache.shiro.util.LifecycleUtils
 
init(Collection) - Static method in class org.apache.shiro.util.LifecycleUtils
Calls init for each object in the collection.
init() - Method in class org.apache.shiro.web.env.IniWebEnvironment
Initializes this instance by resolving any potential (explicit or resource-configured) Ini configuration and calling configure for actual instance configuration.
init(FilterConfig) - Method in class org.apache.shiro.web.servlet.AbstractFilter
Sets the filter's filterConfig and then immediately calls onFilterConfigSet() to trigger any processing a subclass might wish to perform.
init() - Method in class org.apache.shiro.web.servlet.AbstractShiroFilter
 
init() - Method in class org.apache.shiro.web.servlet.IniShiroFilter
Deprecated.  
init() - Method in class org.apache.shiro.web.servlet.ShiroFilter
Configures this instance based on the existing WebEnvironment instance available to the currently accessible servletContext.
initEnvironment(ServletContext) - Method in class org.apache.shiro.web.env.EnvironmentLoader
Initializes Shiro's WebEnvironment instance for the specified ServletContext based on the EnvironmentLoader.CONFIG_LOCATIONS_PARAM value.
initFilter(Filter) - Method in class org.apache.shiro.web.filter.mgt.DefaultFilterChainManager
Initializes the filter by calling filter.init( getFilterConfig() );.
Initializable - Interface in org.apache.shiro.util
Shiro container-agnostic interface that indicates that this object requires initialization.
IniWebEnvironment - Class in org.apache.shiro.web.env
WebEnvironment implementation configured by an Ini instance or Ini resource locations.
IniWebEnvironment() - Constructor for class org.apache.shiro.web.env.IniWebEnvironment
 
instantiate(Constructor, Object...) - Static method in class org.apache.shiro.util.ClassUtils
 
InstantiationException - Exception in org.apache.shiro.util
Runtime exception thrown by the framework when unable to instantiate a Class via reflection.
InstantiationException() - Constructor for exception org.apache.shiro.util.InstantiationException
Creates a new InstantiationException.
InstantiationException(String) - Constructor for exception org.apache.shiro.util.InstantiationException
Constructs a new InstantiationException.
InstantiationException(Throwable) - Constructor for exception org.apache.shiro.util.InstantiationException
Constructs a new InstantiationException.
InstantiationException(String, Throwable) - Constructor for exception org.apache.shiro.util.InstantiationException
Constructs a new InstantiationException.
invalidate() - Method in class org.apache.shiro.web.servlet.ShiroHttpSession
 
InvalidPermissionStringException - Exception in org.apache.shiro.authz.permission
Thrown by PermissionResolver.resolvePermission(String) when the String being parsed is not valid for that resolver.
InvalidPermissionStringException(String, String) - Constructor for exception org.apache.shiro.authz.permission.InvalidPermissionStringException
Constructs a new exception with the given message and permission string.
InvalidResourceUsageException - Exception in org.apache.shiro.dao
Root exception indicating invalid or incorrect usage of a data access resource.
InvalidResourceUsageException(String) - Constructor for exception org.apache.shiro.dao.InvalidResourceUsageException
Constructs an InvalidResourceUsageException with a message explaining the cause of the exception.
InvalidResourceUsageException(String, Throwable) - Constructor for exception org.apache.shiro.dao.InvalidResourceUsageException
Constructs a InvalidResourceUsageException with a message explaining the cause of the exception.
InvalidSessionException - Exception in org.apache.shiro.session
Exception thrown when attempting to interact with the system under an established session when that session is considered invalid.
InvalidSessionException() - Constructor for exception org.apache.shiro.session.InvalidSessionException
Creates a new InvalidSessionException.
InvalidSessionException(String) - Constructor for exception org.apache.shiro.session.InvalidSessionException
Constructs a new InvalidSessionException.
InvalidSessionException(Throwable) - Constructor for exception org.apache.shiro.session.InvalidSessionException
Constructs a new InvalidSessionException.
InvalidSessionException(String, Throwable) - Constructor for exception org.apache.shiro.session.InvalidSessionException
Constructs a new InvalidSessionException.
invoke(MethodInvocation) - Method in interface org.apache.shiro.aop.MethodInterceptor
Invokes the specified MethodInvocation, allowing implementations to perform pre/post/finally surrounding the actual invocation.
invoke(MethodInvocation) - Method in class org.apache.shiro.authz.aop.AuthorizingAnnotationMethodInterceptor
Ensures the methodInvocation is allowed to execute first before proceeding by calling the assertAuthorized method first.
invoke(MethodInvocation) - Method in class org.apache.shiro.authz.aop.AuthorizingMethodInterceptor
Invokes the specified method (methodInvocation.proceed() if authorization is allowed by first calling assertAuthorized.
invoke(RemoteInvocation, Object) - Method in class org.apache.shiro.spring.remoting.SecureRemoteInvocationExecutor
 
invoke(MethodInvocation) - Method in class org.apache.shiro.spring.security.interceptor.AopAllianceAnnotationsAuthorizingMethodInterceptor
Creates a Shiro MethodInvocation instance and then immediately calls super.invoke.
invokeAll(Collection<? extends Callable<T>>) - Method in class org.apache.shiro.concurrent.SubjectAwareExecutorService
 
invokeAll(Collection<? extends Callable<T>>, long, TimeUnit) - Method in class org.apache.shiro.concurrent.SubjectAwareExecutorService
 
invokeAny(Collection<? extends Callable<T>>) - Method in class org.apache.shiro.concurrent.SubjectAwareExecutorService
 
invokeAny(Collection<? extends Callable<T>>, long, TimeUnit) - Method in class org.apache.shiro.concurrent.SubjectAwareExecutorService
 
IPV4_PATTERN - Static variable in class org.apache.shiro.web.filter.authz.HostFilter
 
IPV4_QUAD_REGEX - Static variable in class org.apache.shiro.web.filter.authz.HostFilter
 
IPV4_REGEX - Static variable in class org.apache.shiro.web.filter.authz.HostFilter
 
isAccessAllowed(ServletRequest, ServletResponse, Object) - Method in class org.apache.shiro.cas.CasFilter
Returns false to always force authentication (user is never considered authenticated by this filter).
isAccessAllowed(ServletRequest, ServletResponse, Object) - Method in class org.apache.shiro.web.filter.AccessControlFilter
Returns true if the request is allowed to proceed through the filter normally, or false if the request should be handled by the onAccessDenied(request,response,mappedValue) method instead.
isAccessAllowed(ServletRequest, ServletResponse, Object) - Method in class org.apache.shiro.web.filter.authc.AuthenticatingFilter
Determines whether the current subject should be allowed to make the current request.
isAccessAllowed(ServletRequest, ServletResponse, Object) - Method in class org.apache.shiro.web.filter.authc.AuthenticationFilter
Determines whether the current subject is authenticated.
isAccessAllowed(ServletRequest, ServletResponse, Object) - Method in class org.apache.shiro.web.filter.authc.UserFilter
Returns true if the request is a loginRequest or if the current subject is not null, false otherwise.
isAccessAllowed(ServletRequest, ServletResponse, Object) - Method in class org.apache.shiro.web.filter.authz.HostFilter
 
isAccessAllowed(ServletRequest, ServletResponse, Object) - Method in class org.apache.shiro.web.filter.authz.HttpMethodPermissionFilter
Resolves an 'application friendly' action verb based on the HttpServletRequest's method, appends that action to each configured permission (the mappedValue argument is a String[] array), and delegates the permission check for the newly constructed permission(s) to the superclass isAccessAllowed implementation to perform the actual permission check.
isAccessAllowed(ServletRequest, ServletResponse, Object) - Method in class org.apache.shiro.web.filter.authz.PermissionsAuthorizationFilter
 
isAccessAllowed(ServletRequest, ServletResponse, Object) - Method in class org.apache.shiro.web.filter.authz.PortFilter
 
isAccessAllowed(ServletRequest, ServletResponse, Object) - Method in class org.apache.shiro.web.filter.authz.RolesAuthorizationFilter
 
isAccessAllowed(ServletRequest, ServletResponse, Object) - Method in class org.apache.shiro.web.filter.authz.SslFilter
Retains the parent method's port-matching behavior but additionally guarantees that the ServletRequest.isSecure().
isAtLeastVersion14() - Static method in class org.apache.shiro.util.JavaEnvironment
Convenience method to determine if the current JVM is at least Java 1.4.
isAtLeastVersion15() - Static method in class org.apache.shiro.util.JavaEnvironment
Convenience method to determine if the current JVM is at least Java 1.5 (Java 5).
isAtLeastVersion16() - Static method in class org.apache.shiro.util.JavaEnvironment
Convenience method to determine if the current JVM is at least Java 1.6 (Java 6).
isAuthenticated() - Method in interface org.apache.shiro.subject.Subject
Returns true if this Subject/user proved their identity during their current session by providing valid credentials matching those known to the system, false otherwise.
isAuthenticated() - Method in interface org.apache.shiro.subject.SubjectContext
Returns true if the constructed Subject should be considered authenticated, false otherwise.
isAuthenticated() - Method in class org.apache.shiro.subject.support.DefaultSubjectContext
 
isAuthenticated() - Method in class org.apache.shiro.subject.support.DelegatingSubject
 
isAuthenticationCachingEnabled() - Method in class org.apache.shiro.realm.AuthenticatingRealm
Returns true if authentication caching should be utilized if a CacheManager has been configured, false otherwise.
isAuthenticationCachingEnabled(AuthenticationToken, AuthenticationInfo) - Method in class org.apache.shiro.realm.AuthenticatingRealm
Returns true if authentication caching should be utilized based on the specified AuthenticationToken and/or AuthenticationInfo, false otherwise.
isAuthorizationCachingEnabled() - Method in class org.apache.shiro.realm.AuthorizingRealm
Returns true if authorization caching should be utilized if a CacheManager has been configured, false otherwise.
isAutoApplyRealms(SecurityManager) - Method in class org.apache.shiro.config.IniSecurityManagerFactory
 
isAvailable(String) - Static method in class org.apache.shiro.util.ClassUtils
 
isBase64(byte[]) - Static method in class org.apache.shiro.codec.Base64
Tests a given byte array to see if it contains only valid characters within the Base64 alphabet.
isByteSource(Object) - Method in class org.apache.shiro.codec.CodecSupport
Returns true if the specified object can be easily converted to bytes by instances of this class, false otherwise.
isCachingEnabled() - Method in class org.apache.shiro.realm.CachingRealm
Returns true if caching should be used if a CacheManager has been configured, false otherwise.
isCompatible(Object) - Static method in class org.apache.shiro.util.ByteSource.Util
Returns true if the specified object can be easily represented as a ByteSource using the ByteSource.Util's default heuristics, false otherwise.
isCompatible(Object) - Static method in class org.apache.shiro.util.SimpleByteSource
Returns true if the specified object is a recognized data type that can be easily converted to bytes by instances of this class, false otherwise.
isContinued(String) - Static method in class org.apache.shiro.config.Ini.Section
 
isCredentialsExpired() - Method in class org.apache.shiro.authc.SimpleAccount
Returns whether or not the Account's credentials are expired.
isDeleteInvalidSessions() - Method in class org.apache.shiro.session.mgt.DefaultSessionManager
Returns true if sessions should be automatically deleted after they are discovered to be invalid, false if invalid sessions will be manually deleted by some process external to Shiro's control.
isEmpty() - Method in class org.apache.shiro.config.Ini
Returns true if no sections have been configured, or if there are sections, but the sections themselves are all empty, false otherwise.
isEmpty() - Method in class org.apache.shiro.config.Ini.Section
 
isEmpty() - Method in class org.apache.shiro.crypto.hash.SimpleHash
 
isEmpty() - Method in interface org.apache.shiro.subject.PrincipalCollection
Returns true if this collection is empty, false otherwise.
isEmpty() - Method in class org.apache.shiro.subject.SimplePrincipalCollection
 
isEmpty() - Method in class org.apache.shiro.subject.SimplePrincipalMap
 
isEmpty() - Method in interface org.apache.shiro.util.ByteSource
Returns true if the underlying wrapped byte array is null or empty (zero length), false otherwise.
isEmpty(Collection) - Static method in class org.apache.shiro.util.CollectionUtils
Returns true if the specified Collection is null or empty, false otherwise.
isEmpty(Map) - Static method in class org.apache.shiro.util.CollectionUtils
Returns true if the specified Map is null or empty, false otherwise.
isEmpty(PrincipalCollection) - Static method in class org.apache.shiro.util.CollectionUtils
Returns true if the specified PrincipalCollection is null or empty, false otherwise.
isEmpty() - Method in class org.apache.shiro.util.MapContext
 
isEmpty() - Method in class org.apache.shiro.util.SimpleByteSource
 
isEmpty() - Method in class org.apache.shiro.util.SoftHashMap
 
isEmpty() - Method in class org.apache.shiro.web.filter.mgt.SimpleNamedFilterList
 
isEnabled() - Method in class org.apache.shiro.session.mgt.ExecutorServiceSessionValidationScheduler
 
isEnabled() - Method in class org.apache.shiro.session.mgt.quartz.QuartzSessionValidationScheduler
 
isEnabled() - Method in interface org.apache.shiro.session.mgt.SessionValidationScheduler
Returns true if this Scheduler is enabled and ready to begin validation at the appropriate time, false otherwise.
isEnabled(ServletRequest, ServletResponse, String, Object) - Method in class org.apache.shiro.web.filter.PathMatchingFilter
Path-matching version of the parent class's OncePerRequestFilter.isEnabled(javax.servlet.ServletRequest, javax.servlet.ServletResponse) method, but additionally allows for inspection of any path-specific configuration values corresponding to the specified request.
isEnabled() - Method in class org.apache.shiro.web.servlet.OncePerRequestFilter
Returns true if this filter should generally* execute for any request, false if it should let the request/response pass through immediately to the next element in the FilterChain.
isEnabled(ServletRequest, ServletResponse) - Method in class org.apache.shiro.web.servlet.OncePerRequestFilter
Returns true if this filter should filter the specified request, false if it should let the request/response pass through immediately to the next element in the FilterChain.
isEncodeable(String) - Method in class org.apache.shiro.web.servlet.ShiroHttpServletResponse
Return true if the specified URL should be encoded with a session identifier.
isExpired() - Method in class org.apache.shiro.session.mgt.SimpleSession
Returns true if this session has expired, false otherwise.
isGenerateInitializationVectors(boolean) - Method in class org.apache.shiro.crypto.DefaultBlockCipherService
Overrides the parent implementation to ensure initialization vectors are always generated if streaming is enabled (block ciphers must use initialization vectors if they are to be used as a stream cipher).
isGenerateInitializationVectors() - Method in class org.apache.shiro.crypto.JcaCipherService
 
isGenerateInitializationVectors(boolean) - Method in class org.apache.shiro.crypto.JcaCipherService
 
isGeneratePublicSalt() - Method in class org.apache.shiro.crypto.hash.DefaultHashService
Returns true if a public salt should be randomly generated and used to compute a hash if a HashRequest does not specify a salt, false otherwise.
isHashSalted() - Method in class org.apache.shiro.authc.credential.HashedCredentialsMatcher
Deprecated. since Shiro 1.1. Hash salting is now expected to be based on if the AuthenticationInfo returned from the Realm is a SaltedAuthenticationInfo instance and its getCredentialsSalt() method returns a non-null value. This method and the 1.0 behavior still exists for backwards compatibility if the Realm does not return SaltedAuthenticationInfo instances, but it is highly recommended that Realm implementations that support hashed credentials start returning SaltedAuthenticationInfo instances as soon as possible.

This is because salts should always be obtained from the stored account information and never be interpreted based on user/Subject-entered data. User-entered data is easier to compromise for attackers, whereas account-unique (and secure randomly-generated) salts never disseminated to the end-user are almost impossible to break. This method will be removed in Shiro 2.0.

isHttp(Object) - Static method in class org.apache.shiro.web.util.WebUtils
 
isHttpOnly() - Method in interface org.apache.shiro.web.servlet.Cookie
 
isHttpOnly() - Method in class org.apache.shiro.web.servlet.SimpleCookie
 
isHttpSessionMode() - Method in class org.apache.shiro.web.mgt.DefaultWebSecurityManager
 
isHttpSessionMode() - Method in interface org.apache.shiro.web.mgt.WebSecurityManager
Security information needs to be retained from request to request, so Shiro makes use of a session for this.
isHttpSessions() - Method in class org.apache.shiro.web.servlet.AbstractShiroFilter
 
isHttpSessions() - Method in class org.apache.shiro.web.servlet.ShiroHttpServletRequest
 
isIndexedPropertyAssignment(String) - Method in class org.apache.shiro.config.ReflectionBuilder
 
isIpv4Candidate(String) - Method in class org.apache.shiro.web.filter.authz.HostFilter
 
isLocked() - Method in class org.apache.shiro.authc.SimpleAccount
Returns true if this Account is locked and thus cannot be used to login, false otherwise.
isLoginAttempt(ServletRequest, ServletResponse) - Method in class org.apache.shiro.web.filter.authc.BasicHttpAuthenticationFilter
Determines whether the incoming request is an attempt to log in.
isLoginAttempt(String) - Method in class org.apache.shiro.web.filter.authc.BasicHttpAuthenticationFilter
Default implementation that returns true if the specified authzHeader starts with the same (case-insensitive) characters specified by the authzScheme, false otherwise.
isLoginRequest(ServletRequest, ServletResponse) - Method in class org.apache.shiro.web.filter.AccessControlFilter
Returns true if the incoming request is a login request, false otherwise.
isLoginRequest(ServletRequest, ServletResponse) - Method in class org.apache.shiro.web.filter.authc.BasicHttpAuthenticationFilter
Delegates to isLoginAttempt.
isLoginSubmission(ServletRequest, ServletResponse) - Method in class org.apache.shiro.web.filter.authc.FormAuthenticationFilter
This default implementation merely returns true if the request is an HTTP POST, false otherwise.
isNew() - Method in class org.apache.shiro.web.servlet.ShiroHttpSession
 
isPattern(String) - Method in class org.apache.shiro.util.AntPathMatcher
 
isPermissive(Object) - Method in class org.apache.shiro.web.filter.authc.AuthenticatingFilter
Returns true if the mappedValue contains the AuthenticatingFilter.PERMISSIVE qualifier.
isPermitted(PrincipalCollection, String) - Method in interface org.apache.shiro.authz.Authorizer
Returns true if the corresponding subject/user is permitted to perform an action or access a resource summarized by the specified permission string.
isPermitted(PrincipalCollection, Permission) - Method in interface org.apache.shiro.authz.Authorizer
Returns true if the corresponding subject/user is permitted to perform an action or access a resource summarized by the specified permission.
isPermitted(PrincipalCollection, String...) - Method in interface org.apache.shiro.authz.Authorizer
Checks if the corresponding Subject implies the given permission strings and returns a boolean array indicating which permissions are implied.
isPermitted(PrincipalCollection, List<Permission>) - Method in interface org.apache.shiro.authz.Authorizer
Checks if the corresponding Subject/user implies the given Permissions and returns a boolean array indicating which permissions are implied.
isPermitted(PrincipalCollection, String) - Method in class org.apache.shiro.authz.ModularRealmAuthorizer
Returns true if any of the configured realms' ModularRealmAuthorizer.isPermitted(org.apache.shiro.subject.PrincipalCollection, String) returns true, false otherwise.
isPermitted(PrincipalCollection, Permission) - Method in class org.apache.shiro.authz.ModularRealmAuthorizer
Returns true if any of the configured realms' ModularRealmAuthorizer.isPermitted(org.apache.shiro.subject.PrincipalCollection, Permission) call returns true, false otherwise.
isPermitted(PrincipalCollection, String...) - Method in class org.apache.shiro.authz.ModularRealmAuthorizer
Returns true if any of the configured realms' ModularRealmAuthorizer.isPermittedAll(org.apache.shiro.subject.PrincipalCollection, String...) call returns true, false otherwise.
isPermitted(PrincipalCollection, List<Permission>) - Method in class org.apache.shiro.authz.ModularRealmAuthorizer
Returns true if any of the configured realms' ModularRealmAuthorizer.isPermitted(org.apache.shiro.subject.PrincipalCollection, List) call returns true, false otherwise.
isPermitted(Permission) - Method in class org.apache.shiro.authz.SimpleRole
 
isPermitted(PrincipalCollection, String) - Method in class org.apache.shiro.mgt.AuthorizingSecurityManager
 
isPermitted(PrincipalCollection, Permission) - Method in class org.apache.shiro.mgt.AuthorizingSecurityManager
 
isPermitted(PrincipalCollection, String...) - Method in class org.apache.shiro.mgt.AuthorizingSecurityManager
 
isPermitted(PrincipalCollection, List<Permission>) - Method in class org.apache.shiro.mgt.AuthorizingSecurityManager
 
isPermitted(PrincipalCollection, String) - Method in class org.apache.shiro.realm.AuthorizingRealm
 
isPermitted(PrincipalCollection, Permission) - Method in class org.apache.shiro.realm.AuthorizingRealm
 
isPermitted(PrincipalCollection, String...) - Method in class org.apache.shiro.realm.AuthorizingRealm
 
isPermitted(PrincipalCollection, List<Permission>) - Method in class org.apache.shiro.realm.AuthorizingRealm
 
isPermitted(List<Permission>, AuthorizationInfo) - Method in class org.apache.shiro.realm.AuthorizingRealm
 
isPermitted(String) - Method in interface org.apache.shiro.subject.Subject
Returns true if this Subject is permitted to perform an action or access a resource summarized by the specified permission string.
isPermitted(Permission) - Method in interface org.apache.shiro.subject.Subject
Returns true if this Subject is permitted to perform an action or access a resource summarized by the specified permission.
isPermitted(String...) - Method in interface org.apache.shiro.subject.Subject
Checks if this Subject implies the given permission strings and returns a boolean array indicating which permissions are implied.
isPermitted(List<Permission>) - Method in interface org.apache.shiro.subject.Subject
Checks if this Subject implies the given Permissions and returns a boolean array indicating which permissions are implied.
isPermitted(String) - Method in class org.apache.shiro.subject.support.DelegatingSubject
 
isPermitted(Permission) - Method in class org.apache.shiro.subject.support.DelegatingSubject
 
isPermitted(String...) - Method in class org.apache.shiro.subject.support.DelegatingSubject
 
isPermitted(List<Permission>) - Method in class org.apache.shiro.subject.support.DelegatingSubject
 
isPermitted(String) - Method in class org.apache.shiro.web.tags.PermissionTag
 
isPermittedAll(PrincipalCollection, String...) - Method in interface org.apache.shiro.authz.Authorizer
Returns true if the corresponding Subject/user implies all of the specified permission strings, false otherwise.
isPermittedAll(PrincipalCollection, Collection<Permission>) - Method in interface org.apache.shiro.authz.Authorizer
Returns true if the corresponding Subject/user implies all of the specified permissions, false otherwise.
isPermittedAll(PrincipalCollection, String...) - Method in class org.apache.shiro.authz.ModularRealmAuthorizer
Returns true if any of the configured realms' ModularRealmAuthorizer.isPermitted(org.apache.shiro.subject.PrincipalCollection, String) call returns true for all of the specified string permissions, false otherwise.
isPermittedAll(PrincipalCollection, Collection<Permission>) - Method in class org.apache.shiro.authz.ModularRealmAuthorizer
Returns true if any of the configured realms' ModularRealmAuthorizer.isPermitted(org.apache.shiro.subject.PrincipalCollection, Permission) call returns true for all of the specified Permissions, false otherwise.
isPermittedAll(PrincipalCollection, String...) - Method in class org.apache.shiro.mgt.AuthorizingSecurityManager
 
isPermittedAll(PrincipalCollection, Collection<Permission>) - Method in class org.apache.shiro.mgt.AuthorizingSecurityManager
 
isPermittedAll(PrincipalCollection, String...) - Method in class org.apache.shiro.realm.AuthorizingRealm
 
isPermittedAll(PrincipalCollection, Collection<Permission>) - Method in class org.apache.shiro.realm.AuthorizingRealm
 
isPermittedAll(Collection<Permission>, AuthorizationInfo) - Method in class org.apache.shiro.realm.AuthorizingRealm
 
isPermittedAll(String...) - Method in interface org.apache.shiro.subject.Subject
Returns true if this Subject implies all of the specified permission strings, false otherwise.
isPermittedAll(Collection<Permission>) - Method in interface org.apache.shiro.subject.Subject
Returns true if this Subject implies all of the specified permissions, false otherwise.
isPermittedAll(String...) - Method in class org.apache.shiro.subject.support.DelegatingSubject
 
isPermittedAll(Collection<Permission>) - Method in class org.apache.shiro.subject.support.DelegatingSubject
 
isPoolingConnections(Object) - Method in class org.apache.shiro.realm.ldap.JndiLdapContextFactory
Returns true if LDAP connection pooling should be used when acquiring a connection based on the specified account principal, false otherwise.
isPoolingEnabled() - Method in class org.apache.shiro.realm.ldap.JndiLdapContextFactory
Returns whether or not connection pooling should be used when possible and appropriate.
isReference(String) - Method in class org.apache.shiro.config.ReflectionBuilder
 
isRemembered() - Method in interface org.apache.shiro.subject.Subject
Returns true if this Subject has an identity (it is not anonymous) and the identity (aka principals) is remembered from a successful authentication during a previous session.
isRemembered() - Method in class org.apache.shiro.subject.support.DelegatingSubject
 
isRememberMe() - Method in interface org.apache.shiro.authc.RememberMeAuthenticationToken
Returns true if the submitting user wishes their identity (principal(s)) to be remembered across sessions, false otherwise.
isRememberMe() - Method in class org.apache.shiro.authc.UsernamePasswordToken
Returns true if the submitting user wishes their identity (principal(s)) to be remembered across sessions, false otherwise.
isRememberMe() - Method in class org.apache.shiro.cas.CasToken
 
isRememberMe(AuthenticationToken) - Method in class org.apache.shiro.mgt.AbstractRememberMeManager
Determines whether or not remember me services should be performed for the specified token.
isRememberMe(ServletRequest) - Method in class org.apache.shiro.web.filter.authc.AuthenticatingFilter
Returns true if "rememberMe" should be enabled for the login attempt associated with the current request, false otherwise.
isRememberMe(ServletRequest) - Method in class org.apache.shiro.web.filter.authc.FormAuthenticationFilter
 
isRequestedSessionIdFromCookie() - Method in class org.apache.shiro.web.servlet.ShiroHttpServletRequest
 
isRequestedSessionIdFromURL() - Method in class org.apache.shiro.web.servlet.ShiroHttpServletRequest
 
isRequestedSessionIdFromUrl() - Method in class org.apache.shiro.web.servlet.ShiroHttpServletRequest
 
isRequestedSessionIdValid() - Method in class org.apache.shiro.web.servlet.ShiroHttpServletRequest
 
isResourceRef() - Method in class org.apache.shiro.jndi.JndiLocator
Return whether the lookup occurs in a J2EE container.
isRolename(String) - Method in class org.apache.shiro.realm.text.PropertiesRealm
 
isRunAs() - Method in interface org.apache.shiro.subject.Subject
Returns true if this Subject is 'running as' another identity other than its original one or false otherwise (normal Subject state).
isRunAs() - Method in class org.apache.shiro.subject.support.DelegatingSubject
 
isSchemeChar(char) - Static method in class org.apache.shiro.web.servlet.ShiroHttpServletResponse
Determine if the character is allowed in the scheme of a URI.
isSectionHeader(String) - Static method in class org.apache.shiro.config.Ini
 
isSecure() - Method in interface org.apache.shiro.web.servlet.Cookie
 
isSecure() - Method in class org.apache.shiro.web.servlet.SimpleCookie
 
isServletContainerSessions() - Method in class org.apache.shiro.web.session.mgt.DefaultWebSessionManager
This is a native session manager implementation, so this method returns false always.
isServletContainerSessions() - Method in class org.apache.shiro.web.session.mgt.ServletContainerSessionManager
This implementation always delegates to the servlet container for sessions, so this method returns true always.
isServletContainerSessions() - Method in interface org.apache.shiro.web.session.mgt.WebSessionManager
Returns true if session management and storage is managed by the underlying Servlet container or false if managed by Shiro directly (called 'native' sessions).
isSessionCreationEnabled() - Method in interface org.apache.shiro.subject.SubjectContext
Returns true if the constructed Subject should be allowed to create a session, false otherwise.
isSessionCreationEnabled() - Method in class org.apache.shiro.subject.support.DefaultSubjectContext
 
isSessionCreationEnabled() - Method in class org.apache.shiro.subject.support.DelegatingSubject
Returns true if this Subject is allowed to create sessions, false otherwise.
isSessionCreationEnabled() - Method in class org.apache.shiro.web.subject.support.WebDelegatingSubject
Returns true if session creation is allowed (as determined by the super class's super#isSessionCreationEnabled() value and no request-specific override has disabled sessions for this subject, false otherwise.
isSessionIdCookieEnabled() - Method in class org.apache.shiro.web.session.mgt.DefaultWebSessionManager
 
isSessionStorageEnabled(Subject) - Method in class org.apache.shiro.mgt.DefaultSessionStorageEvaluator
This implementation functions as follows: If the specified Subject already has an existing Session (typically because an application developer has called subject.getSession() already), Shiro will use that existing session to store subject state. If a Subject does not yet have a Session, this implementation checks the sessionStorageEnabled property: If sessionStorageEnabled is true (the default setting), a new session may be created to persist Subject state if necessary. If sessionStorageEnabled is false, a new session will not be created to persist session state. Most applications use Sessions and are OK with the default true setting for sessionStorageEnabled.
isSessionStorageEnabled() - Method in class org.apache.shiro.mgt.DefaultSessionStorageEvaluator
Returns true if any Subject's Session may be used to persist that Subject's state, false otherwise.
isSessionStorageEnabled(Subject) - Method in class org.apache.shiro.mgt.DefaultSubjectDAO
Determines if the subject's session will be used to persist subject state or not.
isSessionStorageEnabled(Subject) - Method in interface org.apache.shiro.mgt.SessionStorageEvaluator
Returns true if the specified Subject's session may be used to persist that Subject's state, false otherwise.
isSessionStorageEnabled(Subject) - Method in class org.apache.shiro.web.mgt.DefaultWebSessionStorageEvaluator
Returns true if session storage is generally available (as determined by the super class's global configuration property DefaultSessionStorageEvaluator.isSessionStorageEnabled() and no request-specific override has turned off session storage, false otherwise.
isSessionValidationSchedulerEnabled() - Method in class org.apache.shiro.session.mgt.AbstractValidatingSessionManager
 
isShutdown() - Method in class org.apache.shiro.concurrent.SubjectAwareExecutorService
 
isSingleton() - Method in class org.apache.shiro.spring.web.ShiroFilterFactoryBean
Returns true always.
isSingleton() - Method in class org.apache.shiro.util.AbstractFactory
 
isStaticSecurityManagerEnabled() - Method in class org.apache.shiro.web.servlet.AbstractShiroFilter
Returns true if the constructed securityManager reference should be bound to static memory (via SecurityUtils.setSecurityManager), false otherwise.
isStopped() - Method in class org.apache.shiro.session.mgt.SimpleSession
 
isStoredCredentialsHexEncoded() - Method in class org.apache.shiro.authc.credential.HashedCredentialsMatcher
Returns true if the system's stored credential hash is Hex encoded, false if it is Base64 encoded.
issueRedirect(ServletRequest, ServletResponse, String) - Method in class org.apache.shiro.web.filter.authc.LogoutFilter
Issues an HTTP redirect to the specified URL after subject logout.
issueRedirect(ServletRequest, ServletResponse, String, Map, boolean, boolean) - Static method in class org.apache.shiro.web.util.WebUtils
Redirects the current request to a new URL based on the given parameters.
issueRedirect(ServletRequest, ServletResponse, String) - Static method in class org.apache.shiro.web.util.WebUtils
Redirects the current request to a new URL based on the given parameters and default values for unspecified parameters.
issueRedirect(ServletRequest, ServletResponse, String, Map) - Static method in class org.apache.shiro.web.util.WebUtils
Redirects the current request to a new URL based on the given parameters and default values for unspecified parameters.
issueRedirect(ServletRequest, ServletResponse, String, Map, boolean) - Static method in class org.apache.shiro.web.util.WebUtils
Redirects the current request to a new URL based on the given parameters and default values for unspecified parameters.
issueSuccessRedirect(ServletRequest, ServletResponse) - Method in class org.apache.shiro.web.filter.authc.AuthenticationFilter
Redirects to user to the previously attempted URL after a successful login.
isTerminated() - Method in class org.apache.shiro.concurrent.SubjectAwareExecutorService
 
isTimedOut() - Method in class org.apache.shiro.session.mgt.SimpleSession
Determines if this session is expired.
isTrue(ServletRequest, String) - Static method in class org.apache.shiro.web.util.WebUtils
Checks to see if a request param is considered true using a loose matching strategy for general values that indicate that something is true or enabled, etc.
isTypedProperty(Object, String, Class) - Method in class org.apache.shiro.config.ReflectionBuilder
 
isUserInRole(String) - Method in class org.apache.shiro.web.servlet.ShiroHttpServletRequest
 
isUsername(String) - Method in class org.apache.shiro.realm.text.PropertiesRealm
 
isValid(SessionKey) - Method in class org.apache.shiro.session.mgt.AbstractNativeSessionManager
 
isValid(SessionKey) - Method in interface org.apache.shiro.session.mgt.NativeSessionManager
Returns true if the associated session is valid (it exists and is not stopped nor expired), false otherwise.
isValid() - Method in class org.apache.shiro.session.mgt.SimpleSession
 
isValid() - Method in interface org.apache.shiro.session.mgt.ValidatingSession
 
isWeb(Object) - Static method in class org.apache.shiro.web.util.WebUtils
 
iterator() - Method in class org.apache.shiro.subject.SimplePrincipalCollection
 
iterator() - Method in class org.apache.shiro.subject.SimplePrincipalMap
 
iterator() - Method in class org.apache.shiro.web.filter.mgt.SimpleNamedFilterList
 

J

JAVA_13 - Static variable in class org.apache.shiro.util.JavaEnvironment
Constant identifying the 1.3.x JVM (JDK 1.3).
JAVA_14 - Static variable in class org.apache.shiro.util.JavaEnvironment
Constant identifying the 1.4.x JVM (J2SE 1.4).
JAVA_15 - Static variable in class org.apache.shiro.util.JavaEnvironment
Constant identifying the 1.5 JVM (Java 5).
JAVA_16 - Static variable in class org.apache.shiro.util.JavaEnvironment
Constant identifying the 1.6 JVM (Java 6).
JAVA_17 - Static variable in class org.apache.shiro.util.JavaEnvironment
Constant identifying the 1.7 JVM.
JavaEnvironment - Class in org.apache.shiro.util
Internal helper class used to find the Java/JDK version that Shiro is operating within, to allow for automatically adapting to the present platform's capabilities.
JavaEnvironment() - Constructor for class org.apache.shiro.util.JavaEnvironment
 
JavaUuidSessionIdGenerator - Class in org.apache.shiro.session.mgt.eis
SessionIdGenerator that generates String values of JDK UUID's as the session IDs.
JavaUuidSessionIdGenerator() - Constructor for class org.apache.shiro.session.mgt.eis.JavaUuidSessionIdGenerator
 
JcaCipherService - Class in org.apache.shiro.crypto
Abstract CipherService implementation utilizing Java's JCA APIs.
JcaCipherService(String) - Constructor for class org.apache.shiro.crypto.JcaCipherService
Creates a new JcaCipherService instance which will use the specified cipher algorithmName for all encryption, decryption, and key operations.
JdbcRealm - Class in org.apache.shiro.realm.jdbc
Realm that allows authentication and authorization via JDBC calls.
JdbcRealm() - Constructor for class org.apache.shiro.realm.jdbc.JdbcRealm
 
JdbcRealm.SaltStyle - Enum in org.apache.shiro.realm.jdbc
Password hash salt configuration.
JdbcUtils - Class in org.apache.shiro.util
A set of static helper methods for managing JDBC API objects.
JndiCallback - Interface in org.apache.shiro.jndi
Callback interface to be implemented by classes that need to perform an operation (such as a lookup) in a JNDI context.
JndiLdapContextFactory - Class in org.apache.shiro.realm.ldap
LdapContextFactory implementation using the default Sun/Oracle JNDI Ldap API, utilizing JNDI environment properties and an InitialContext.
JndiLdapContextFactory() - Constructor for class org.apache.shiro.realm.ldap.JndiLdapContextFactory
Default no-argument constructor that initializes the backing environment template with the contextFactoryClassName equal to com.sun.jndi.ldap.LdapCtxFactory (the Sun/Oracle default) and the default referral behavior to follow.
JndiLdapRealm - Class in org.apache.shiro.realm.ldap
An LDAP Realm implementation utilizing Sun's/Oracle's JNDI API as an LDAP API.
JndiLdapRealm() - Constructor for class org.apache.shiro.realm.ldap.JndiLdapRealm
Default no-argument constructor that defaults the internal LdapContextFactory instance to a JndiLdapContextFactory.
JndiLocator - Class in org.apache.shiro.jndi
Convenient superclass for JNDI accessors, providing "jndiTemplate" and "jndiEnvironment" bean properties.
JndiLocator() - Constructor for class org.apache.shiro.jndi.JndiLocator
 
JndiObjectFactory<T> - Class in org.apache.shiro.jndi
A factory implementation intended to be used to look up objects in jndi.
JndiObjectFactory() - Constructor for class org.apache.shiro.jndi.JndiObjectFactory
 
JndiRealmFactory - Class in org.apache.shiro.realm.jndi
Looks up one or more Realm instances from JNDI using specified jndiNames.
JndiRealmFactory() - Constructor for class org.apache.shiro.realm.jndi.JndiRealmFactory
 
JndiTemplate - Class in org.apache.shiro.jndi
Helper class that simplifies JNDI operations.
JndiTemplate() - Constructor for class org.apache.shiro.jndi.JndiTemplate
Create a new JndiTemplate instance.
JndiTemplate(Properties) - Constructor for class org.apache.shiro.jndi.JndiTemplate
Create a new JndiTemplate instance, using the given environment.
join(Iterator<?>, String) - Static method in class org.apache.shiro.util.StringUtils
Joins the elements of the provided Iterator into a single String containing the provided elements.

K

keys() - Method in interface org.apache.shiro.cache.Cache
Returns a view of all the keys for entries contained in this cache.
keys() - Method in class org.apache.shiro.cache.ehcache.EhCache
 
keys() - Method in class org.apache.shiro.cache.MapCache
 
keySet() - Method in class org.apache.shiro.config.Ini
 
keySet() - Method in class org.apache.shiro.config.Ini.Section
 
keySet() - Method in class org.apache.shiro.subject.SimplePrincipalMap
 
keySet() - Method in class org.apache.shiro.util.MapContext
 
keySet() - Method in class org.apache.shiro.util.SoftHashMap
 

L

LacksPermissionTag - Class in org.apache.shiro.web.tags
 
LacksPermissionTag() - Constructor for class org.apache.shiro.web.tags.LacksPermissionTag
 
LacksRoleTag - Class in org.apache.shiro.web.tags
 
LacksRoleTag() - Constructor for class org.apache.shiro.web.tags.LacksRoleTag
 
lastIndexOf(Object) - Method in class org.apache.shiro.web.filter.mgt.SimpleNamedFilterList
 
LdapContextFactory - Interface in org.apache.shiro.realm.ldap
Interface that encapsulates the creation of LdapContext objects that are used by JndiLdapRealms to perform authentication attempts and query for authorization data.
LdapUtils - Class in org.apache.shiro.realm.ldap
Utility class providing static methods to make working with LDAP easier.
LdapUtils() - Constructor for class org.apache.shiro.realm.ldap.LdapUtils
 
LifecycleBeanPostProcessor - Class in org.apache.shiro.spring
Bean post processor for Spring that automatically calls the init() and/or destroy() methods on Shiro objects that implement the Initializable or Destroyable interfaces, respectfully.
LifecycleBeanPostProcessor() - Constructor for class org.apache.shiro.spring.LifecycleBeanPostProcessor
Default Constructor.
LifecycleBeanPostProcessor(int) - Constructor for class org.apache.shiro.spring.LifecycleBeanPostProcessor
Constructor with definable order value.
LifecycleUtils - Class in org.apache.shiro.util
Utility class to help call Initializable.init() and Destroyable.destroy() methods cleanly on any object.
LifecycleUtils() - Constructor for class org.apache.shiro.util.LifecycleUtils
 
listIterator() - Method in class org.apache.shiro.web.filter.mgt.SimpleNamedFilterList
 
listIterator(int) - Method in class org.apache.shiro.web.filter.mgt.SimpleNamedFilterList
 
load(String) - Method in class org.apache.shiro.config.Ini
Loads the specified raw INI-formatted text into this instance.
load(InputStream) - Method in class org.apache.shiro.config.Ini
Loads the INI-formatted text backed by the given InputStream into this instance.
load(Reader) - Method in class org.apache.shiro.config.Ini
Loads the INI-formatted text backed by the given Reader into this instance.
load(Scanner) - Method in class org.apache.shiro.config.Ini
Loads the INI-formatted text backed by the given Scanner.
loadDefaultClassPathIni() - Static method in class org.apache.shiro.config.IniFactorySupport
Returns a new Ini instance created from the default classpath:shiro.ini file, or null if the file does not exist.
loadFromPath(String) - Method in class org.apache.shiro.config.Ini
Loads data from the specified resource path into this current Ini instance.
loadIniFromConfig() - Method in class org.apache.shiro.web.servlet.IniShiroFilter
Deprecated.  
loadIniFromPath() - Method in class org.apache.shiro.web.servlet.IniShiroFilter
Deprecated.  
LockedAccountException - Exception in org.apache.shiro.authc
A special kind of DisabledAccountException, this exception is thrown when attempting to authenticate and the corresponding account has been disabled explicitly due to being locked.
LockedAccountException() - Constructor for exception org.apache.shiro.authc.LockedAccountException
Creates a new LockedAccountException.
LockedAccountException(String) - Constructor for exception org.apache.shiro.authc.LockedAccountException
Constructs a new LockedAccountException.
LockedAccountException(Throwable) - Constructor for exception org.apache.shiro.authc.LockedAccountException
Constructs a new LockedAccountException.
LockedAccountException(String, Throwable) - Constructor for exception org.apache.shiro.authc.LockedAccountException
Constructs a new LockedAccountException.
Logical - Enum in org.apache.shiro.authz.annotation
An enum for specifying a logical operation that can be used for interpreting authorization annotations
login(Subject, AuthenticationToken) - Method in class org.apache.shiro.mgt.DefaultSecurityManager
First authenticates the AuthenticationToken argument, and if successful, constructs a Subject instance representing the authenticated account's identity.
login(Subject, AuthenticationToken) - Method in interface org.apache.shiro.mgt.SecurityManager
Logs in the specified Subject using the given authenticationToken, returning an updated Subject instance reflecting the authenticated state if successful or throwing AuthenticationException if it is not.
login(AuthenticationToken) - Method in interface org.apache.shiro.subject.Subject
Performs a login attempt for this Subject/user.
login(AuthenticationToken) - Method in class org.apache.shiro.subject.support.DelegatingSubject
 
LOGOUT - Static variable in class org.apache.shiro.guice.web.ShiroWebModule
 
logout(Subject) - Method in class org.apache.shiro.mgt.DefaultSecurityManager
 
logout(Subject) - Method in interface org.apache.shiro.mgt.SecurityManager
Logs out the specified Subject from the system.
logout() - Method in interface org.apache.shiro.subject.Subject
Logs out this Subject and invalidates and/or removes any associated entities, such as a Session and authorization data.
logout() - Method in class org.apache.shiro.subject.support.DelegatingSubject
 
LogoutAware - Interface in org.apache.shiro.authc
An SPI interface allowing cleanup logic to be executed during logout of a previously authenticated Subject/user.
LogoutFilter - Class in org.apache.shiro.web.filter.authc
Simple Filter that, upon receiving a request, will immediately log-out the currently executing subject and then redirect them to a configured redirectUrl.
LogoutFilter() - Constructor for class org.apache.shiro.web.filter.authc.LogoutFilter
 
lookup(String) - Method in class org.apache.shiro.jndi.JndiLocator
Perform an actual JNDI lookup for the given name via the JndiTemplate.
lookup(String, Class) - Method in class org.apache.shiro.jndi.JndiLocator
Perform an actual JNDI lookup for the given name via the JndiTemplate.
lookup(String) - Method in class org.apache.shiro.jndi.JndiTemplate
Look up the object with the given name in the current JNDI context.
lookup(String, Class) - Method in class org.apache.shiro.jndi.JndiTemplate
Look up the object with the given name in the current JNDI context.
lookupHashFormatClass(String) - Method in class org.apache.shiro.crypto.hash.format.DefaultHashFormatFactory
 
lookupSecurityManager() - Method in class org.apache.shiro.env.DefaultEnvironment
Looks up the SecurityManager instance in the backing map without performing any non-null guarantees.

M

main(String[]) - Static method in class org.apache.shiro.tools.hasher.Hasher
 
main(String[]) - Static method in class Quickstart
 
MAIN_SECTION_NAME - Static variable in class org.apache.shiro.config.IniSecurityManagerFactory
 
manager - Variable in class org.apache.shiro.cache.ehcache.EhCacheManager
The EhCache cache manager used by this implementation to create caches.
MapCache<K,V> - Class in org.apache.shiro.cache
A MapCache is a Cache implementation that uses a backing Map instance to store and retrieve cached data.
MapCache(String, Map<K, V>) - Constructor for class org.apache.shiro.cache.MapCache
 
MapContext - Class in org.apache.shiro.util
A MapContext provides a common base for context-based data storage in a Map.
MapContext() - Constructor for class org.apache.shiro.util.MapContext
 
MapContext(Map<String, Object>) - Constructor for class org.apache.shiro.util.MapContext
 
match(String, String) - Method in class org.apache.shiro.util.AntPathMatcher
 
matches(Method, Class) - Method in class org.apache.shiro.spring.security.interceptor.AuthorizationAttributeSourceAdvisor
Returns true if the method has any Shiro annotations, false otherwise.
matches(String, String) - Method in class org.apache.shiro.util.AntPathMatcher
 
matches(String, String) - Method in interface org.apache.shiro.util.PatternMatcher
Returns true if the given source matches the specified pattern, false otherwise.
matches(String, String) - Method in class org.apache.shiro.util.RegExPatternMatcher
Simple implementation that merely uses the default pattern comparison logic provided by the JDK.
matchStart(String, String) - Method in class org.apache.shiro.util.AntPathMatcher
 
MAXAGE_ATTRIBUTE_NAME - Static variable in class org.apache.shiro.web.servlet.SimpleCookie
 
MCF_PREFIX - Static variable in class org.apache.shiro.crypto.hash.format.Shiro1CryptFormat
 
Md2CredentialsMatcher - Class in org.apache.shiro.authc.credential
Deprecated. since 1.1 - use the HashedCredentialsMatcher directly and set its hashAlgorithmName property.
Md2CredentialsMatcher() - Constructor for class org.apache.shiro.authc.credential.Md2CredentialsMatcher
Deprecated.  
Md2Hash - Class in org.apache.shiro.crypto.hash
Generates an MD2 Hash (RFC 1319) from a given input source with an optional salt and hash iterations.
Md2Hash() - Constructor for class org.apache.shiro.crypto.hash.Md2Hash
 
Md2Hash(Object) - Constructor for class org.apache.shiro.crypto.hash.Md2Hash
 
Md2Hash(Object, Object) - Constructor for class org.apache.shiro.crypto.hash.Md2Hash
 
Md2Hash(Object, Object, int) - Constructor for class org.apache.shiro.crypto.hash.Md2Hash
 
Md5CredentialsMatcher - Class in org.apache.shiro.authc.credential
Deprecated. since 1.1 - use the HashedCredentialsMatcher directly and set its hashAlgorithmName property.
Md5CredentialsMatcher() - Constructor for class org.apache.shiro.authc.credential.Md5CredentialsMatcher
Deprecated.  
Md5Hash - Class in org.apache.shiro.crypto.hash
Generates an MD5 Hash (RFC 1321) from a given input source with an optional salt and hash iterations.
Md5Hash() - Constructor for class org.apache.shiro.crypto.hash.Md5Hash
 
Md5Hash(Object) - Constructor for class org.apache.shiro.crypto.hash.Md5Hash
 
Md5Hash(Object, Object) - Constructor for class org.apache.shiro.crypto.hash.Md5Hash
 
Md5Hash(Object, Object, int) - Constructor for class org.apache.shiro.crypto.hash.Md5Hash
 
MemoryConstrainedCacheManager - Class in org.apache.shiro.cache
Simple memory-only based CacheManager implementation usable in production environments.
MemoryConstrainedCacheManager() - Constructor for class org.apache.shiro.cache.MemoryConstrainedCacheManager
 
MemorySessionDAO - Class in org.apache.shiro.session.mgt.eis
Simple memory-based implementation of the SessionDAO that stores all of its sessions in an in-memory ConcurrentMap.
MemorySessionDAO() - Constructor for class org.apache.shiro.session.mgt.eis.MemorySessionDAO
 
MergableAuthenticationInfo - Interface in org.apache.shiro.authc
An extension of the AuthenticationInfo interface to be implemented by classes that support merging with other AuthenticationInfo instances.
merge(AuthenticationInfo) - Method in interface org.apache.shiro.authc.MergableAuthenticationInfo
Merges the given AuthenticationInfo into this instance.
merge(AuthenticationInfo, AuthenticationInfo) - Method in class org.apache.shiro.authc.pam.AbstractAuthenticationStrategy
Merges the specified info argument into the aggregate argument and then returns an aggregate for continued use throughout the login process.
merge(AuthenticationInfo, AuthenticationInfo) - Method in class org.apache.shiro.authc.pam.FirstSuccessfulStrategy
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.
merge(AuthenticationInfo) - Method in class org.apache.shiro.authc.SimpleAccount
Merges the specified AuthenticationInfo into this Account.
merge(AuthenticationInfo) - Method in class org.apache.shiro.authc.SimpleAuthenticationInfo
Takes the specified info argument and adds its principals and credentials into this instance.
mergeAuthenticationState(Subject) - Method in class org.apache.shiro.mgt.DefaultSubjectDAO
Merges the Subject's current authentication state with whatever may be in any available session.
mergePrincipals(Subject) - Method in class org.apache.shiro.mgt.DefaultSubjectDAO
Merges the Subject's current Subject.getPrincipals() with whatever may be in any available session.
MethodInterceptor - Interface in org.apache.shiro.aop
A MethodInterceptor intercepts a MethodInvocation to perform before or after logic (aka 'advice').
methodInterceptors - Variable in class org.apache.shiro.authz.aop.AnnotationsAuthorizingMethodInterceptor
The method interceptors to execute for the annotated method.
MethodInterceptorSupport - Class in org.apache.shiro.aop
This class is an abstraction of AOP method interceptor behavior specific to Shiro that leaves AOP implementation specifics to be handled by subclass implementations.
MethodInterceptorSupport() - Constructor for class org.apache.shiro.aop.MethodInterceptorSupport
Default no-argument constructor for subclasses.
MethodInvocation - Interface in org.apache.shiro.aop
3rd-party API independent representation of a method invocation.
MILLIS_PER_HOUR - Static variable in class org.apache.shiro.session.mgt.AbstractSessionManager
 
MILLIS_PER_HOUR - Static variable in class org.apache.shiro.session.mgt.SimpleSession
 
MILLIS_PER_MINUTE - Static variable in class org.apache.shiro.session.mgt.AbstractSessionManager
 
MILLIS_PER_MINUTE - Static variable in class org.apache.shiro.session.mgt.SimpleSession
 
MILLIS_PER_SECOND - Static variable in class org.apache.shiro.session.mgt.AbstractSessionManager
 
MILLIS_PER_SECOND - Static variable in class org.apache.shiro.session.mgt.SimpleSession
 
ModularCryptFormat - Interface in org.apache.shiro.crypto.hash.format
A HashFormat that supports Modular Crypt Format token rules.
ModularRealmAuthenticator - Class in org.apache.shiro.authc.pam
A ModularRealmAuthenticator delgates account lookups to a pluggable (modular) collection of Realms.
ModularRealmAuthenticator() - Constructor for class org.apache.shiro.authc.pam.ModularRealmAuthenticator
Default no-argument constructor which enables an AtLeastOneSuccessfulStrategy by default.
ModularRealmAuthorizer - Class in org.apache.shiro.authz
A ModularRealmAuthorizer is an Authorizer implementation that consults one or more configured Realms during an authorization operation.
ModularRealmAuthorizer() - Constructor for class org.apache.shiro.authz.ModularRealmAuthorizer
Default no-argument constructor, does nothing.
ModularRealmAuthorizer(Collection<Realm>) - Constructor for class org.apache.shiro.authz.ModularRealmAuthorizer
Constructor that accepts the Realms to consult during an authorization check.
MutablePrincipalCollection - Interface in org.apache.shiro.subject
A PrincipalCollection that allows modification.
MutableWebEnvironment - Interface in org.apache.shiro.web.env
A WebEnvironment that supports 'write' operations operations.

N

name - Variable in class org.apache.shiro.authz.SimpleRole
 
NAME_VALUE_DELIMITER - Static variable in class org.apache.shiro.web.servlet.SimpleCookie
 
Nameable - Interface in org.apache.shiro.util
Interface implemented by components that can be named, such as via configuration, and wish to have that name set once it has been configured.
NameableFilter - Class in org.apache.shiro.web.servlet
Allows a filter to be named via JavaBeans-compatible NameableFilter.getName()/NameableFilter.setName(String) methods.
NameableFilter() - Constructor for class org.apache.shiro.web.servlet.NameableFilter
 
NamedFilterList - Interface in org.apache.shiro.web.filter.mgt
A NamedFilterList is a List of Filter instances that is uniquely identified by a name.
NamedObjectEnvironment - Interface in org.apache.shiro.env
An environment that supports object lookup by name.
NATIVE_SESSION_MODE - Static variable in class org.apache.shiro.web.mgt.DefaultWebSecurityManager
Deprecated. 
NativeSessionManager - Interface in org.apache.shiro.session.mgt
A Native session manager is one that manages sessions natively - that is, it is directly responsible for the creation, persistence and removal of Session instances and their lifecycles.
newHashFormatInstance(Class) - Method in class org.apache.shiro.crypto.hash.format.DefaultHashFormatFactory
 
newHashInstance() - Method in class org.apache.shiro.authc.credential.HashedCredentialsMatcher
Returns a new, uninitialized instance, without its byte array set.
newInstance(String) - Static method in class org.apache.shiro.util.ClassUtils
 
newInstance(String, Object...) - Static method in class org.apache.shiro.util.ClassUtils
 
newInstance(Class) - Static method in class org.apache.shiro.util.ClassUtils
 
newInstance(Class, Object...) - Static method in class org.apache.shiro.util.ClassUtils
 
newInstance() - Method in enum org.apache.shiro.web.filter.mgt.DefaultFilter
 
newSessionInstance(SessionContext) - Method in class org.apache.shiro.session.mgt.DefaultSessionManager
 
newSubjectContextInstance() - Method in class org.apache.shiro.subject.Subject.Builder
Creates a new SubjectContext instance to be used to populate with subject contextual data that will then be sent to the SecurityManager to create a new Subject instance.
newSubjectContextInstance() - Method in class org.apache.shiro.web.subject.WebSubject.Builder
Overrides the parent implementation to return a new instance of a DefaultWebSubjectContext to account for the additional request/response pair.
newSubjectInstance(PrincipalCollection, boolean, String, Session, SecurityManager) - Method in class org.apache.shiro.mgt.DefaultSubjectFactory
Deprecated. since 1.2 - override DefaultSubjectFactory.createSubject(org.apache.shiro.subject.SubjectContext) directly if you need to instantiate a custom Subject class.
newSubjectInstance(PrincipalCollection, boolean, String, Session, ServletRequest, ServletResponse, SecurityManager) - Method in class org.apache.shiro.web.mgt.DefaultWebSubjectFactory
Deprecated. since 1.2 - override DefaultWebSubjectFactory.createSubject(org.apache.shiro.subject.SubjectContext) directly if you need to instantiate a custom Subject class.
nextBytes() - Method in interface org.apache.shiro.crypto.RandomNumberGenerator
Generates a byte array of fixed length filled with random data, often useful for generating salts, initialization vectors or other seed data.
nextBytes(int) - Method in interface org.apache.shiro.crypto.RandomNumberGenerator
Generates a byte array of the specified length filled with random data.
nextBytes() - Method in class org.apache.shiro.crypto.SecureRandomNumberGenerator
 
nextBytes(int) - Method in class org.apache.shiro.crypto.SecureRandomNumberGenerator
 
NO_SESSION_CREATION - Static variable in class org.apache.shiro.guice.web.ShiroWebModule
 
normalize(String) - Static method in class org.apache.shiro.web.util.WebUtils
Normalize a relative URI path that may have relative values ("/./", "/../", and so on ) it it.
NoSessionCreationFilter - Class in org.apache.shiro.web.filter.session
A PathMatchingFilter that will disable creating new Sessions during the request.
NoSessionCreationFilter() - Constructor for class org.apache.shiro.web.filter.session.NoSessionCreationFilter
 
NotAuthenticatedTag - Class in org.apache.shiro.web.tags
JSP tag that renders the tag body only if the current user has not executed a successful authentication attempt during their current session.
NotAuthenticatedTag() - Constructor for class org.apache.shiro.web.tags.NotAuthenticatedTag
 
notifyExpiration(Session) - Method in class org.apache.shiro.session.mgt.AbstractNativeSessionManager
 
notifyFailure(AuthenticationToken, AuthenticationException) - Method in class org.apache.shiro.authc.AbstractAuthenticator
Notifies any registered AuthenticationListeners that authentication failed for the specified token which resulted in the specified ae exception.
notifyLogout(PrincipalCollection) - Method in class org.apache.shiro.authc.AbstractAuthenticator
Notifies any registered AuthenticationListeners that a Subject has logged-out.
notifyStart(Session) - Method in class org.apache.shiro.session.mgt.AbstractNativeSessionManager
Notifies any interested SessionListeners that a Session has started.
notifyStop(Session) - Method in class org.apache.shiro.session.mgt.AbstractNativeSessionManager
 
notifySuccess(AuthenticationToken, AuthenticationInfo) - Method in class org.apache.shiro.authc.AbstractAuthenticator
Notifies any registered AuthenticationListeners that authentication was successful for the specified token which resulted in the specified info.
nullSafePut(String, Object) - Method in class org.apache.shiro.util.MapContext
Places a value in this context map under the given key only if the given value argument is not null.

O

objectPermissions - Variable in class org.apache.shiro.authz.SimpleAuthorizationInfo
Collection of all object-based permissions associaed with the account.
objects - Variable in class org.apache.shiro.env.DefaultEnvironment
 
objectToBytes(Object) - Method in class org.apache.shiro.codec.CodecSupport
Default implementation throws a CodecException immediately since it can't infer how to convert the Object to a byte array.
objectToString(Object) - Method in class org.apache.shiro.codec.CodecSupport
Default implementation merely returns objectArgument.toString().
onAccessDenied(ServletRequest, ServletResponse) - Method in class org.apache.shiro.cas.CasFilter
Execute login by creating token and logging subject with this token.
onAccessDenied(ServletRequest, ServletResponse, Object) - Method in class org.apache.shiro.web.filter.AccessControlFilter
Processes requests where the subject was denied access as determined by the isAccessAllowed method, retaining the mappedValue that was used during configuration.
onAccessDenied(ServletRequest, ServletResponse) - Method in class org.apache.shiro.web.filter.AccessControlFilter
Processes requests where the subject was denied access as determined by the isAccessAllowed method.
onAccessDenied(ServletRequest, ServletResponse) - Method in class org.apache.shiro.web.filter.authc.BasicHttpAuthenticationFilter
Processes unauthenticated requests.
onAccessDenied(ServletRequest, ServletResponse) - Method in class org.apache.shiro.web.filter.authc.FormAuthenticationFilter
 
onAccessDenied(ServletRequest, ServletResponse) - Method in class org.apache.shiro.web.filter.authc.PassThruAuthenticationFilter
 
onAccessDenied(ServletRequest, ServletResponse) - Method in class org.apache.shiro.web.filter.authc.UserFilter
This default implementation simply calls saveRequestAndRedirectToLogin and then immediately returns false, thereby preventing the chain from continuing so the redirect may execute.
onAccessDenied(ServletRequest, ServletResponse) - Method in class org.apache.shiro.web.filter.authz.AuthorizationFilter
Handles the response when access has been denied.
onAccessDenied(ServletRequest, ServletResponse, Object) - Method in class org.apache.shiro.web.filter.authz.PortFilter
Redirects the request to the same exact incoming URL, but with the port listed in the filter's configuration.
OncePerRequestFilter - Class in org.apache.shiro.web.servlet
Filter base class that guarantees to be just executed once per request, on any servlet container.
OncePerRequestFilter() - Constructor for class org.apache.shiro.web.servlet.OncePerRequestFilter
 
onChange(Session) - Method in class org.apache.shiro.session.mgt.AbstractNativeSessionManager
 
onChange(Session) - Method in class org.apache.shiro.session.mgt.DefaultSessionManager
 
onDoStartTag() - Method in class org.apache.shiro.web.tags.AuthenticatedTag
 
onDoStartTag() - Method in class org.apache.shiro.web.tags.GuestTag
 
onDoStartTag() - Method in class org.apache.shiro.web.tags.NotAuthenticatedTag
 
onDoStartTag() - Method in class org.apache.shiro.web.tags.PermissionTag
 
onDoStartTag() - Method in class org.apache.shiro.web.tags.PrincipalTag
 
onDoStartTag() - Method in class org.apache.shiro.web.tags.RoleTag
 
onDoStartTag() - Method in class org.apache.shiro.web.tags.SecureTag
 
onDoStartTag() - Method in class org.apache.shiro.web.tags.UserTag
 
ONE_YEAR - Static variable in interface org.apache.shiro.web.servlet.Cookie
The number of seconds in one year (= 60 * 60 * 24 * 365).
oneByType(Class<T>) - Method in interface org.apache.shiro.subject.PrincipalCollection
Returns the first discovered principal assignable from the specified type, or null if there are none of the specified type.
oneByType(Class<T>) - Method in class org.apache.shiro.subject.SimplePrincipalCollection
 
oneByType(Class<T>) - Method in class org.apache.shiro.subject.SimplePrincipalMap
 
onEquals(SimpleSession) - Method in class org.apache.shiro.session.mgt.SimpleSession
Provides an attribute-based comparison (no ID comparison) - incurred only when 'this' or the session object being compared for equality do not have a session id.
onExpiration(Session, ExpiredSessionException, SessionKey) - Method in class org.apache.shiro.session.mgt.AbstractValidatingSessionManager
 
onExpiration(Session) - Method in class org.apache.shiro.session.mgt.AbstractValidatingSessionManager
 
onExpiration(Session) - Method in class org.apache.shiro.session.mgt.DefaultSessionManager
 
onExpiration(Session) - Method in interface org.apache.shiro.session.SessionListener
Notification callback that occurs when the corresponding Session has expired.
onExpiration(Session) - Method in class org.apache.shiro.session.SessionListenerAdapter
Adapter no-op implemenation - does nothing and returns immediately.
onExpiration(Session, ExpiredSessionException, SessionKey) - Method in class org.apache.shiro.web.session.mgt.DefaultWebSessionManager
 
onFailedLogin(Subject, AuthenticationToken, AuthenticationException) - Method in class org.apache.shiro.mgt.AbstractRememberMeManager
Reacts to a failed login by immediately forgetting any previously remembered identity.
onFailedLogin(AuthenticationToken, AuthenticationException, Subject) - Method in class org.apache.shiro.mgt.DefaultSecurityManager
 
onFailedLogin(Subject, AuthenticationToken, AuthenticationException) - Method in interface org.apache.shiro.mgt.RememberMeManager
Reacts to a failed authentication attempt, typically by forgetting any previously remembered principals for the Subject.
onFailure(AuthenticationToken, AuthenticationException) - Method in interface org.apache.shiro.authc.AuthenticationListener
Callback triggered when an authentication attempt for a Subject has failed.
onFilterConfigSet() - Method in class org.apache.shiro.web.servlet.AbstractFilter
Template method to be overridden by subclasses to perform initialization logic at start-up.
onFilterConfigSet() - Method in class org.apache.shiro.web.servlet.AbstractShiroFilter
 
onInit() - Method in class org.apache.shiro.cas.CasRealm
 
onInit() - Method in class org.apache.shiro.realm.AuthenticatingRealm
Template method for subclasses to implement any initialization logic.
onInit() - Method in class org.apache.shiro.realm.AuthorizingRealm
Initializes this realm and potentially enables a cache, depending on configuration.
onInit() - Method in class org.apache.shiro.realm.ldap.AbstractLdapRealm
 
onInit() - Method in class org.apache.shiro.realm.text.IniRealm
 
onInit() - Method in class org.apache.shiro.realm.text.PropertiesRealm
 
onInit() - Method in class org.apache.shiro.realm.text.TextConfigurationRealm
Will call 'processDefinitions' on startup.
onInvalidation(Session, InvalidSessionException, SessionKey) - Method in class org.apache.shiro.session.mgt.AbstractValidatingSessionManager
 
onInvalidation(Session, InvalidSessionException, SessionKey) - Method in class org.apache.shiro.web.session.mgt.DefaultWebSessionManager
 
onLoginFailure(AuthenticationToken, AuthenticationException, ServletRequest, ServletResponse) - Method in class org.apache.shiro.cas.CasFilter
If login has failed, redirect user to the CAS error page (no ticket or ticket validation failed) except if the user is already authenticated, in which case redirect to the default success url.
onLoginFailure(AuthenticationToken, AuthenticationException, ServletRequest, ServletResponse) - Method in class org.apache.shiro.web.filter.authc.AuthenticatingFilter
 
onLoginFailure(AuthenticationToken, AuthenticationException, ServletRequest, ServletResponse) - Method in class org.apache.shiro.web.filter.authc.FormAuthenticationFilter
 
onLoginSuccess(AuthenticationToken, Subject, ServletRequest, ServletResponse) - Method in class org.apache.shiro.cas.CasFilter
If login has been successful, redirect user to the original protected url.
onLoginSuccess(AuthenticationToken, Subject, ServletRequest, ServletResponse) - Method in class org.apache.shiro.web.filter.authc.AuthenticatingFilter
 
onLoginSuccess(AuthenticationToken, Subject, ServletRequest, ServletResponse) - Method in class org.apache.shiro.web.filter.authc.FormAuthenticationFilter
 
onLogout(PrincipalCollection) - Method in class org.apache.shiro.authc.AbstractAuthenticator
This implementation merely calls notifyLogout to allow any registered listeners to react to the logout.
onLogout(PrincipalCollection) - Method in interface org.apache.shiro.authc.AuthenticationListener
Callback triggered when a Subject logs-out of the system.
onLogout(PrincipalCollection) - Method in interface org.apache.shiro.authc.LogoutAware
Callback triggered when a Subject logs out of the system.
onLogout(PrincipalCollection) - Method in class org.apache.shiro.authc.pam.ModularRealmAuthenticator
First calls super.onLogout(principals) to ensure a logout notification is issued, and for each wrapped Realm that implements the LogoutAware interface, calls ((LogoutAware)realm).onLogout(principals) to allow each realm the opportunity to perform logout/cleanup operations during an user-logout.
onLogout(Subject) - Method in class org.apache.shiro.mgt.AbstractRememberMeManager
Reacts to a subject logging out of the application and immediately forgets any previously stored identity and returns.
onLogout(Subject) - Method in interface org.apache.shiro.mgt.RememberMeManager
Reacts to a Subject logging out of the application, typically by forgetting any previously remembered principals for the Subject.
onLogout(PrincipalCollection) - Method in class org.apache.shiro.realm.CachingRealm
If caching is enabled, this will clear any cached data associated with the specified account identity.
onPreHandle(ServletRequest, ServletResponse, Object) - Method in class org.apache.shiro.web.filter.AccessControlFilter
Returns true if isAccessAllowed(Request,Response,Object), otherwise returns the result of onAccessDenied(Request,Response,Object).
onPreHandle(ServletRequest, ServletResponse, Object) - Method in class org.apache.shiro.web.filter.authc.AnonymousFilter
Always returns true allowing unchecked access to the underlying path or resource.
onPreHandle(ServletRequest, ServletResponse, Object) - Method in class org.apache.shiro.web.filter.PathMatchingFilter
This default implementation always returns true and should be overridden by subclasses for custom logic if necessary.
onPreHandle(ServletRequest, ServletResponse, Object) - Method in class org.apache.shiro.web.filter.session.NoSessionCreationFilter
 
onRememberedPrincipalFailure(RuntimeException, SubjectContext) - Method in class org.apache.shiro.mgt.AbstractRememberMeManager
Called when an exception is thrown while trying to retrieve principals.
onStart(Session, SessionContext) - Method in class org.apache.shiro.session.mgt.AbstractNativeSessionManager
Template method that allows subclasses to react to a new session being created.
onStart(Session) - Method in interface org.apache.shiro.session.SessionListener
Notification callback that occurs when the corresponding Session has started.
onStart(Session) - Method in class org.apache.shiro.session.SessionListenerAdapter
Adapter no-op implemenation - does nothing and returns immediately.
onStart(Session, SessionContext) - Method in class org.apache.shiro.web.session.mgt.DefaultWebSessionManager
Stores the Session's ID, usually as a Cookie, to associate with future requests.
onStop(Session, SessionKey) - Method in class org.apache.shiro.session.mgt.AbstractNativeSessionManager
 
onStop(Session) - Method in class org.apache.shiro.session.mgt.AbstractNativeSessionManager
 
onStop(Session) - Method in class org.apache.shiro.session.mgt.DefaultSessionManager
 
onStop(Session) - Method in interface org.apache.shiro.session.SessionListener
Notification callback that occurs when the corresponding Session has stopped, either programmatically via Session.stop() or automatically upon a subject logging out.
onStop(Session) - Method in class org.apache.shiro.session.SessionListenerAdapter
Adapter no-op implemenation - does nothing and returns immediately.
onStop(Session, SessionKey) - Method in class org.apache.shiro.web.session.mgt.DefaultWebSessionManager
 
onSuccess(AuthenticationToken, AuthenticationInfo) - Method in interface org.apache.shiro.authc.AuthenticationListener
Callback triggered when an authentication attempt for a Subject has succeeded.
onSuccessfulLogin(Subject, AuthenticationToken, AuthenticationInfo) - Method in class org.apache.shiro.mgt.AbstractRememberMeManager
Reacts to the successful login attempt by first always forgetting any previously stored identity.
onSuccessfulLogin(AuthenticationToken, AuthenticationInfo, Subject) - Method in class org.apache.shiro.mgt.DefaultSecurityManager
 
onSuccessfulLogin(Subject, AuthenticationToken, AuthenticationInfo) - Method in interface org.apache.shiro.mgt.RememberMeManager
Reacts to a successful authentication attempt, typically saving the principals to be retrieved ('remembered') for future system access.
OperationMode - Enum in org.apache.shiro.crypto
A cipher mode of operation directs a cipher algorithm how to convert data during the encryption or decryption process.
org.apache.shiro - package org.apache.shiro
This package primarily exists as a root classpath distinction, but it does contain two core classes widely used by applications, SecurityUtils and ShiroException.
org.apache.shiro.aop - package org.apache.shiro.aop
Components used to support the framework's AOP/interception support classes.
org.apache.shiro.aspectj - package org.apache.shiro.aspectj
AspectJ support for enabling dynamic authorization using Shiro's annotations.
org.apache.shiro.authc - package org.apache.shiro.authc
Core interfaces and exceptions concerning Authentication (the act of logging-in).
org.apache.shiro.authc.credential - package 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 - package 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.authz - package org.apache.shiro.authz
Core interfaces and exceptions supporting Authorization (access control).
org.apache.shiro.authz.annotation - package org.apache.shiro.authz.annotation
Annotations used to restrict which classes, instances, or methods may be accessed or invoked depending on the caller's access abilities or authentication state.
org.apache.shiro.authz.aop - package org.apache.shiro.authz.aop
Contains AOP implementation support classes specifically used for authorization operations, particularly supporting AOP Method Interceptors and JSR-175 metadata Annotations.
org.apache.shiro.authz.permission - package org.apache.shiro.authz.permission
Support and default implementations for Shiro's Permission interface.
org.apache.shiro.cache - package org.apache.shiro.cache
Caching support used to enhance performance for any security operation.
org.apache.shiro.cache.ehcache - package org.apache.shiro.cache.ehcache
Ehcache-based implementations of Shiro's cache interfaces.
org.apache.shiro.cas - package org.apache.shiro.cas
 
org.apache.shiro.codec - package org.apache.shiro.codec
Components for encoding and decoding of data across multiple formats, especially useful in Shiro's cryptography and web functionality.
org.apache.shiro.concurrent - package org.apache.shiro.concurrent
Executor, ExecutorService, and ScheduledExecutorService implementations for transparent Subject association with threads in an asynchronous execution environment.
org.apache.shiro.config - package org.apache.shiro.config
Components that support configuring Shiro in any application.
org.apache.shiro.crypto - package org.apache.shiro.crypto
Cryptography Cipher and Hashing components that greatly simplify the JDK's cryptography concepts and add additional convenient behavior.
org.apache.shiro.crypto.hash - package org.apache.shiro.crypto.hash
Cryptographic Hashing components that greatly simplify one-way data hashing in an application.
org.apache.shiro.crypto.hash.format - package org.apache.shiro.crypto.hash.format
 
org.apache.shiro.dao - package org.apache.shiro.dao
Package containing various components useful when building Data Access Objects (DAOs), including a generic Data Access Exception hierarchy.
org.apache.shiro.env - package org.apache.shiro.env
Concepts used to represent Shiro's aggregate state in an application.
org.apache.shiro.functor - package org.apache.shiro.functor
Package containing functor components used for data translation or conversion.
org.apache.shiro.guice - package org.apache.shiro.guice
 
org.apache.shiro.guice.aop - package org.apache.shiro.guice.aop
 
org.apache.shiro.guice.web - package org.apache.shiro.guice.web
 
org.apache.shiro.io - package org.apache.shiro.io
Support for reading and writing (input/output) raw data from multiple resource locations.
org.apache.shiro.jndi - package org.apache.shiro.jndi
Enables accessing objects located in JNDI that might be useful when configuring a Shiro-enabled application.
org.apache.shiro.ldap - package org.apache.shiro.ldap
 
org.apache.shiro.mgt - package 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 - package org.apache.shiro.realm
Components and sub-packages used in supporting the core Realm interface.
org.apache.shiro.realm.activedirectory - package org.apache.shiro.realm.activedirectory
Realms that acquire security data from a Microsoft Active Directory.
org.apache.shiro.realm.jdbc - package 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.jndi - package org.apache.shiro.realm.jndi
Support for acquiring Realms from JNDI, particularly useful for configuring Shiro in JEE or EJB environments.
org.apache.shiro.realm.ldap - package 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.realm.text - package org.apache.shiro.realm.text
Realms that acquire security data from text-based data sources such as Files or text streams.
org.apache.shiro.session - package org.apache.shiro.session
Components related to managing sessions, the time-based data contexts in which a Subject interacts with an application.
org.apache.shiro.session.mgt - package org.apache.shiro.session.mgt
SessionManager components supporting enterprise session management.
org.apache.shiro.session.mgt.eis - package org.apache.shiro.session.mgt.eis
EIS (Enterprise Information System)-tier components that can perform CRUD operations for sessions using any EIS API.
org.apache.shiro.session.mgt.quartz - package org.apache.shiro.session.mgt.quartz
Quartz-based implementations of components that help SessionManager implementations maintain sessions (timed expiration, orphan cleanup, etc).
org.apache.shiro.spring - package org.apache.shiro.spring
Spring Application Framework support for enabling Shiro in spring applications.
org.apache.shiro.spring.aop - package org.apache.shiro.spring.aop
 
org.apache.shiro.spring.remoting - package org.apache.shiro.spring.remoting
Support to enable Spring-based remote method invocations to carry a Shiro session ID as part of the invocation payload, allowing remote clients to perform security operations.
org.apache.shiro.spring.security.interceptor - package org.apache.shiro.spring.security.interceptor
Spring AOP support for enabling Shiro annotations in Spring-configured applications.
org.apache.shiro.spring.web - package org.apache.shiro.spring.web
Spring-specific components for use in Spring-based web applications.
org.apache.shiro.subject - package org.apache.shiro.subject
Components supporting the Subject interface, the most important concept in Shiro's API.
org.apache.shiro.subject.support - package org.apache.shiro.subject.support
Concrete support implementations of most of the org.apache.shiro.subject interfaces.
org.apache.shiro.tools.hasher - package org.apache.shiro.tools.hasher
 
org.apache.shiro.util - package org.apache.shiro.util
Your run-of-the-mill 'util' pacakge for components and logic widely used across the framework that can't find their home into a proper OO hierarchy (or, most likely for things used across many hierarchies).
org.apache.shiro.web - package org.apache.shiro.web
Shiro's web support module to support security in any web-enabled application.
org.apache.shiro.web.config - package org.apache.shiro.web.config
Web-specific implementation extensions to the org.apache.shiro.config components.
org.apache.shiro.web.env - package org.apache.shiro.web.env
Web-specific Environment implementation and support.
org.apache.shiro.web.filter - package org.apache.shiro.web.filter
Base package supporting all Servlet Filter implementations used to control access to web pages and URL resources.
org.apache.shiro.web.filter.authc - package org.apache.shiro.web.filter.authc
Servlet Filter implementations specific to controlling access based on a subject's authentication status, or those that can execute authentications (log-ins) directly.
org.apache.shiro.web.filter.authz - package org.apache.shiro.web.filter.authz
Servlet Filter implementations that perform authorization (access control) checks based on the Subject's abilities (for example, role or permission checks).
org.apache.shiro.web.filter.mgt - package org.apache.shiro.web.filter.mgt
The filter 'mgt' (management) package contains components used in managing Filters that are available for filter chain construction, the filter chains themselves, as well as resolving filter chains based by name.
org.apache.shiro.web.filter.session - package org.apache.shiro.web.filter.session
 
org.apache.shiro.web.mgt - package org.apache.shiro.web.mgt
Components supporting web-specific SecurityManager implementations.
org.apache.shiro.web.servlet - package org.apache.shiro.web.servlet
Shiro-specific implementations of the Servlet API (Servlet Filters, et al).
org.apache.shiro.web.session - package org.apache.shiro.web.session
Components supporting Session management in web-enabled applications.
org.apache.shiro.web.session.mgt - package org.apache.shiro.web.session.mgt
 
org.apache.shiro.web.subject - package org.apache.shiro.web.subject
Web-specific Subject interfaces to enable Subject use in web environments.
org.apache.shiro.web.subject.support - package org.apache.shiro.web.subject.support
Supporting implementations of org.apache.shiro.web.subject package interfaces.
org.apache.shiro.web.tags - package org.apache.shiro.web.tags
Provides the Shiro JSP Tag Library implementations.
org.apache.shiro.web.util - package org.apache.shiro.web.util
 

P

PaddingScheme - Enum in org.apache.shiro.crypto
A CipherPaddingScheme represents well-known padding schemes supported by JPA providers in a type-safe manner.
ParsableHashFormat - Interface in org.apache.shiro.crypto.hash.format
A ParsableHashFormat is able to parse a formatted string and convert it into a Hash instance.
parse(String) - Method in interface org.apache.shiro.crypto.hash.format.ParsableHashFormat
Parses the specified formatted string and returns the corresponding Hash instance.
parse(String) - Method in class org.apache.shiro.crypto.hash.format.Shiro1CryptFormat
 
PART_DIVIDER_TOKEN - Static variable in class org.apache.shiro.authz.permission.WildcardPermission
 
PassThruAuthenticationFilter - Class in org.apache.shiro.web.filter.authc
An authentication filter that redirects the user to the login page when they are trying to access a protected resource.
PassThruAuthenticationFilter() - Constructor for class org.apache.shiro.web.filter.authc.PassThruAuthenticationFilter
 
PasswordMatcher - Class in org.apache.shiro.authc.credential
A CredentialsMatcher that employs best-practices comparisons for hashed text passwords.
PasswordMatcher() - Constructor for class org.apache.shiro.authc.credential.PasswordMatcher
 
PasswordService - Interface in org.apache.shiro.authc.credential
A PasswordService supports common use cases when using passwords as a credentials mechanism.
passwordsMatch(Object, Hash) - Method in class org.apache.shiro.authc.credential.DefaultPasswordService
 
passwordsMatch(Object, String) - Method in class org.apache.shiro.authc.credential.DefaultPasswordService
 
passwordsMatch(Object, Hash) - Method in interface org.apache.shiro.authc.credential.HashingPasswordService
Returns true if the submittedPlaintext password matches the existing savedPasswordHash, false otherwise.
passwordsMatch(Object, String) - Method in interface org.apache.shiro.authc.credential.PasswordService
Returns true if the submittedPlaintext password matches the existing saved password, false otherwise.
PATH_ATTRIBUTE_NAME - Static variable in class org.apache.shiro.web.servlet.SimpleCookie
 
PathConfigProcessor - Interface in org.apache.shiro.web.filter
A PathConfigProcessor processes configuration entries on a per path (url) basis.
pathMatcher - Variable in class org.apache.shiro.web.filter.PathMatchingFilter
PatternMatcher used in determining which paths to react to for a given request.
pathMatches(String, String) - Method in class org.apache.shiro.web.filter.mgt.PathMatchingFilterChainResolver
Returns true if an incoming request path (the path argument) matches a configured filter chain path (the pattern argument), false otherwise.
PathMatchingFilter - Class in org.apache.shiro.web.filter
Base class for Filters that will process only specified paths and allow all others to pass through.
PathMatchingFilter() - Constructor for class org.apache.shiro.web.filter.PathMatchingFilter
 
PathMatchingFilterChainResolver - Class in org.apache.shiro.web.filter.mgt
A FilterChainResolver that resolves FilterChains based on url path matching, as determined by a configurable PathMatcher.
PathMatchingFilterChainResolver() - Constructor for class org.apache.shiro.web.filter.mgt.PathMatchingFilterChainResolver
 
PathMatchingFilterChainResolver(FilterConfig) - Constructor for class org.apache.shiro.web.filter.mgt.PathMatchingFilterChainResolver
 
pathsMatch(String, ServletRequest) - Method in class org.apache.shiro.web.filter.PathMatchingFilter
Returns true if the incoming request matches the specified path pattern, false otherwise.
pathsMatch(String, String) - Method in class org.apache.shiro.web.filter.PathMatchingFilter
Returns true if the path matches the specified pattern string, false otherwise.
PatternMatcher - Interface in org.apache.shiro.util
Interface for components that can match source strings against a specified pattern string.
performBeforeInterception(JoinPoint) - Method in class org.apache.shiro.aspectj.AspectjAnnotationsAuthorizingMethodInterceptor
Performs the method interception of the before advice at the specified joint point.
Permission - Interface in org.apache.shiro.authz
A Permission represents the ability to perform an action or access a resource.
PermissionAnnotationHandler - Class in org.apache.shiro.authz.aop
Checks to see if a @RequiresPermissions annotation is declared, and if so, performs a permission check to see if the calling Subject is allowed continued access.
PermissionAnnotationHandler() - Constructor for class org.apache.shiro.authz.aop.PermissionAnnotationHandler
Default no-argument constructor that ensures this handler looks for RequiresPermissions annotations.
PermissionAnnotationMethodInterceptor - Class in org.apache.shiro.authz.aop
Checks to see if a @RequiresPermissions annotation is declared, and if so, performs a permission check to see if the calling Subject is allowed to call the method.
PermissionAnnotationMethodInterceptor() - Constructor for class org.apache.shiro.authz.aop.PermissionAnnotationMethodInterceptor
Default no-argument constructor that ensures this interceptor looks for RequiresPermissions annotations in a method declaration.
PermissionAnnotationMethodInterceptor(AnnotationResolver) - Constructor for class org.apache.shiro.authz.aop.PermissionAnnotationMethodInterceptor
 
permissionResolver - Variable in class org.apache.shiro.authz.ModularRealmAuthorizer
A PermissionResolver to be used by all configured realms.
PermissionResolver - Interface in org.apache.shiro.authz.permission
A PermisisonResolver resolves a String value and converts it into a Permission instance.
PermissionResolverAware - Interface in org.apache.shiro.authz.permission
Interface implemented by a component that wishes to use any application-configured PermissionResolver that might already exist instead of potentially creating one itself.
permissions - Variable in class org.apache.shiro.authz.SimpleRole
 
PermissionsAuthorizationFilter - Class in org.apache.shiro.web.filter.authz
Filter that allows access if the current user has the permissions specified by the mapped value, or denies access if the user does not have all of the permissions specified.
PermissionsAuthorizationFilter() - Constructor for class org.apache.shiro.web.filter.authz.PermissionsAuthorizationFilter
 
permissionsLookupEnabled - Variable in class org.apache.shiro.realm.jdbc.JdbcRealm
 
permissionsQuery - Variable in class org.apache.shiro.realm.jdbc.JdbcRealm
 
PermissionTag - Class in org.apache.shiro.web.tags
 
PermissionTag() - Constructor for class org.apache.shiro.web.tags.PermissionTag
 
PermissionUtils - Class in org.apache.shiro.util
Utility class to help with String-to-Permission object resolution.
PermissionUtils() - Constructor for class org.apache.shiro.util.PermissionUtils
 
PERMISSIVE - Static variable in class org.apache.shiro.web.filter.authc.AuthenticatingFilter
 
PERMS - Static variable in class org.apache.shiro.guice.web.ShiroWebModule
 
PORT - Static variable in class org.apache.shiro.guice.web.ShiroWebModule
 
PortFilter - Class in org.apache.shiro.web.filter.authz
A Filter that requires the request to be on a specific port, and if not, redirects to the same URL on that port.
PortFilter() - Constructor for class org.apache.shiro.web.filter.authz.PortFilter
 
POST_METHOD - Static variable in class org.apache.shiro.web.filter.AccessControlFilter
Constant representing the HTTP 'POST' request method, equal to POST.
postHandle(ServletRequest, ServletResponse) - Method in class org.apache.shiro.web.servlet.AdviceFilter
Allows 'post' advice logic to be called, but only if no exception occurs during filter chain execution.
postProcessAfterInitialization(Object, String) - Method in class org.apache.shiro.spring.LifecycleBeanPostProcessor
Does nothing - merely returns the object argument immediately.
postProcessAfterInitialization(Object, String) - Method in class org.apache.shiro.spring.web.ShiroFilterFactoryBean
Does nothing - only exists to satisfy the BeanPostProcessor interface and immediately returns the bean argument.
postProcessBeforeDestruction(Object, String) - Method in class org.apache.shiro.spring.LifecycleBeanPostProcessor
Calls the destroy() methods on the bean if it implements Destroyable
postProcessBeforeInitialization(Object, String) - Method in class org.apache.shiro.spring.LifecycleBeanPostProcessor
Calls the init() methods on the bean if it implements Initializable
postProcessBeforeInitialization(Object, String) - Method in class org.apache.shiro.spring.web.ShiroFilterFactoryBean
Inspects a bean, and if it implements the Filter interface, automatically adds that filter instance to the internal filters map that will be referenced later during filter chain construction.
PREFERRED_ENCODING - Static variable in class org.apache.shiro.codec.CodecSupport
Shiro's default preferred character encoding, equal to UTF-8.
preHandle(ServletRequest, ServletResponse) - Method in class org.apache.shiro.web.filter.authc.LogoutFilter
Acquires the currently executing subject, a potentially Subject or request-specific redirectUrl, and redirects the end-user to that redirect url.
preHandle(ServletRequest, ServletResponse) - Method in class org.apache.shiro.web.filter.PathMatchingFilter
Implementation that handles path-matching behavior before a request is evaluated.
preHandle(ServletRequest, ServletResponse) - Method in class org.apache.shiro.web.servlet.AdviceFilter
Returns true if the filter chain should be allowed to continue, false otherwise.
prepareServletRequest(ServletRequest, ServletResponse, FilterChain) - Method in class org.apache.shiro.web.servlet.AbstractShiroFilter
Prepares the ServletRequest instance that will be passed to the FilterChain for request processing.
prepareServletResponse(ServletRequest, ServletResponse, FilterChain) - Method in class org.apache.shiro.web.servlet.AbstractShiroFilter
Prepares the ServletResponse instance that will be passed to the FilterChain for request processing.
PrincipalCollection - Interface in org.apache.shiro.subject
A collection of all principals associated with a corresponding Subject.
PrincipalMap - Interface in org.apache.shiro.subject
EXPERIMENTAL - DO NOT USE YET

A PrincipalMap is map of all of a subject's principals - its identifying attributes like username, userId, etc.

principals - Variable in class org.apache.shiro.authc.SimpleAuthenticationInfo
The principals identifying the account associated with this AuthenticationInfo instance.
principals(PrincipalCollection) - Method in class org.apache.shiro.subject.Subject.Builder
Ensures the Subject being built will reflect the specified principals (aka identity).
principals - Variable in class org.apache.shiro.subject.support.DelegatingSubject
 
PRINCIPALS_SESSION_KEY - Static variable in class org.apache.shiro.subject.support.DefaultSubjectContext
The session key that is used to store subject principals.
principalSuffix - Variable in class org.apache.shiro.realm.ldap.AbstractLdapRealm
 
principalSuffix - Variable in class org.apache.shiro.realm.ldap.DefaultLdapContextFactory
Deprecated.  
PrincipalTag - Class in org.apache.shiro.web.tags
Tag used to print out the String value of a user's default principal, or a specific principal as specified by the tag's attributes.
PrincipalTag() - Constructor for class org.apache.shiro.web.tags.PrincipalTag
 
PRIVATE_CLASS_A_REGEX - Static variable in class org.apache.shiro.web.filter.authz.HostFilter
 
PRIVATE_CLASS_B_REGEX - Static variable in class org.apache.shiro.web.filter.authz.HostFilter
 
PRIVATE_CLASS_B_SUBSET - Static variable in class org.apache.shiro.web.filter.authz.HostFilter
 
PRIVATE_CLASS_C_REGEX - Static variable in class org.apache.shiro.web.filter.authz.HostFilter
 
proceed() - Method in interface org.apache.shiro.aop.MethodInvocation
Continues the method invocation chain, or if the last in the chain, the method itself.
proceed() - Method in class org.apache.shiro.aspectj.BeforeAdviceMethodInvocationAdapter
 
processDefinitions() - Method in class org.apache.shiro.realm.text.TextConfigurationRealm
 
processPathConfig(String, String) - Method in interface org.apache.shiro.web.filter.PathConfigProcessor
Processes the specified config, unique to the given path, and returns the Filter that should execute for that path/config combination.
processPathConfig(String, String) - Method in class org.apache.shiro.web.filter.PathMatchingFilter
Splits any comma-delmited values that might be found in the config argument and sets the resulting String[] array on the appliedPaths internal Map.
processRoleDefinitions() - Method in class org.apache.shiro.realm.text.TextConfigurationRealm
 
processRoleDefinitions(Map<String, String>) - Method in class org.apache.shiro.realm.text.TextConfigurationRealm
 
processUserDefinitions() - Method in class org.apache.shiro.realm.text.TextConfigurationRealm
 
processUserDefinitions(Map<String, String>) - Method in class org.apache.shiro.realm.text.TextConfigurationRealm
 
PropertiesRealm - Class in org.apache.shiro.realm.text
A TextConfigurationRealm that defers all logic to the parent class, but just enables Properties based configuration in addition to the parent class's String configuration.
PropertiesRealm() - Constructor for class org.apache.shiro.realm.text.PropertiesRealm
 
ProvidedHashFormat - Enum in org.apache.shiro.crypto.hash.format
An enum representing Shiro's default provided HashFormat implementations.
ProxiedFilterChain - Class in org.apache.shiro.web.servlet
A proxied filter chain is a FilterChain instance that proxies an original FilterChain as well as a List of other Filters that might need to execute prior to the final wrapped original chain.
ProxiedFilterChain(FilterChain, List<Filter>) - Constructor for class org.apache.shiro.web.servlet.ProxiedFilterChain
 
ProxiedSession - Class in org.apache.shiro.session
Simple Session implementation that immediately delegates all corresponding calls to an underlying proxied session instance.
ProxiedSession(Session) - Constructor for class org.apache.shiro.session.ProxiedSession
Constructs an instance that proxies the specified target.
proxy(FilterChain, String) - Method in class org.apache.shiro.web.filter.mgt.DefaultFilterChainManager
 
proxy(FilterChain, String) - Method in interface org.apache.shiro.web.filter.mgt.FilterChainManager
Proxies the specified original FilterChain with the named chain.
proxy(FilterChain) - Method in interface org.apache.shiro.web.filter.mgt.NamedFilterList
Returns a new FilterChain instance that will first execute this list's Filters (in list order) and end with the execution of the given filterChain instance.
proxy(FilterChain) - Method in class org.apache.shiro.web.filter.mgt.SimpleNamedFilterList
 
put(K, V) - Method in interface org.apache.shiro.cache.Cache
Adds a Cache entry.
put(K, V) - Method in class org.apache.shiro.cache.ehcache.EhCache
Puts an object into the cache.
put(K, V) - Method in class org.apache.shiro.cache.MapCache
 
put(String, Ini.Section) - Method in class org.apache.shiro.config.Ini
 
put(String, String) - Method in class org.apache.shiro.config.Ini.Section
 
put(String, Object) - Method in class org.apache.shiro.subject.SimplePrincipalMap
 
put(String, Object) - Method in class org.apache.shiro.util.MapContext
 
put(K, V) - Method in class org.apache.shiro.util.SoftHashMap
Creates a new entry, but wraps the value in a SoftValue instance to enable auto garbage collection.
put(Object, Object) - Static method in class org.apache.shiro.util.ThreadContext
Binds value for the given key to the current thread.
putAll(Map<? extends String, ? extends Ini.Section>) - Method in class org.apache.shiro.config.Ini
 
putAll(Map<? extends String, ? extends String>) - Method in class org.apache.shiro.config.Ini.Section
 
putAll(Map<? extends String, ?>) - Method in class org.apache.shiro.subject.SimplePrincipalMap
 
putAll(Map<? extends String, ?>) - Method in class org.apache.shiro.util.MapContext
 
putAll(Map<? extends K, ? extends V>) - Method in class org.apache.shiro.util.SoftHashMap
 
putValue(String, Object) - Method in class org.apache.shiro.web.servlet.ShiroHttpSession
 

Q

QuartzSessionValidationJob - Class in org.apache.shiro.session.mgt.quartz
A quartz job that basically just calls the ValidatingSessionManager.validateSessions() method on a configured session manager.
QuartzSessionValidationJob() - Constructor for class org.apache.shiro.session.mgt.quartz.QuartzSessionValidationJob
 
QuartzSessionValidationScheduler - Class in org.apache.shiro.session.mgt.quartz
An implementation of the SessionValidationScheduler that uses Quartz to schedule a job to call ValidatingSessionManager.validateSessions() on a regular basis.
QuartzSessionValidationScheduler() - Constructor for class org.apache.shiro.session.mgt.quartz.QuartzSessionValidationScheduler
Default constructor.
QuartzSessionValidationScheduler(ValidatingSessionManager) - Constructor for class org.apache.shiro.session.mgt.quartz.QuartzSessionValidationScheduler
Constructor that specifies the session manager that should be used for validating sessions.
queryForAuthenticationInfo(AuthenticationToken, LdapContextFactory) - Method in class org.apache.shiro.realm.activedirectory.ActiveDirectoryRealm
Builds an AuthenticationInfo object by querying the active directory LDAP context for the specified username.
queryForAuthenticationInfo(AuthenticationToken, LdapContextFactory) - Method in class org.apache.shiro.realm.ldap.AbstractLdapRealm
Abstract method that should be implemented by subclasses to builds an AuthenticationInfo object by querying the LDAP context for the specified username.
queryForAuthenticationInfo(AuthenticationToken, LdapContextFactory) - Method in class org.apache.shiro.realm.ldap.JndiLdapRealm
This implementation opens an LDAP connection using the token's discovered principal and provided credentials.
queryForAuthorizationInfo(PrincipalCollection, LdapContextFactory) - Method in class org.apache.shiro.realm.activedirectory.ActiveDirectoryRealm
Builds an AuthorizationInfo object by querying the active directory LDAP context for the groups that a user is a member of.
queryForAuthorizationInfo(PrincipalCollection, LdapContextFactory) - Method in class org.apache.shiro.realm.ldap.AbstractLdapRealm
Abstract method that should be implemented by subclasses to builds an AuthorizationInfo object by querying the LDAP context for the specified principal.
queryForAuthorizationInfo(PrincipalCollection, LdapContextFactory) - Method in class org.apache.shiro.realm.ldap.JndiLdapRealm
Method that should be implemented by subclasses to build an AuthorizationInfo object by querying the LDAP context for the specified principal.
queryProperties(Map) - Method in class org.apache.shiro.web.util.RedirectView
Determine name-value pairs for query strings, which will be stringified, URL-encoded and formatted by appendQueryProperties.
Quickstart - Class in <Unnamed>
Simple Quickstart application showing how to use Shiro's API.
Quickstart() - Constructor for class Quickstart
 

R

RandomNumberGenerator - Interface in org.apache.shiro.crypto
A component that can generate random number/byte values as needed.
RandomSessionIdGenerator - Class in org.apache.shiro.session.mgt.eis
Generates session IDs by using a Random instance to generate random IDs.
RandomSessionIdGenerator() - Constructor for class org.apache.shiro.session.mgt.eis.RandomSessionIdGenerator
 
readSession(Serializable) - Method in class org.apache.shiro.session.mgt.eis.AbstractSessionDAO
Retrieves the Session object from the underlying EIS identified by sessionId by delegating to the AbstractSessionDAO.doReadSession(java.io.Serializable) method.
readSession(Serializable) - Method in class org.apache.shiro.session.mgt.eis.CachingSessionDAO
Attempts to acquire the Session from the cache first using the session ID as the cache key.
readSession(Serializable) - Method in interface org.apache.shiro.session.mgt.eis.SessionDAO
Retrieves the session from the EIS uniquely identified by the specified sessionId.
readValue(HttpServletRequest, HttpServletResponse) - Method in interface org.apache.shiro.web.servlet.Cookie
 
readValue(HttpServletRequest, HttpServletResponse) - Method in class org.apache.shiro.web.servlet.SimpleCookie
 
Realm - Interface in org.apache.shiro.realm
A Realm is a security component that can access application-specific security entities such as users, roles, and permissions to determine authentication and authorization operations.
RealmFactory - Interface in org.apache.shiro.realm
Enables Shiro end-users to configure and initialize one or more Realm instances in any manner desired.
realms - Variable in class org.apache.shiro.authz.ModularRealmAuthorizer
The realms to consult during any authorization check.
RealmSecurityManager - Class in org.apache.shiro.mgt
Shiro support of a SecurityManager class hierarchy based around a collection of Realms.
RealmSecurityManager() - Constructor for class org.apache.shiro.mgt.RealmSecurityManager
Default no-arg constructor.
rebind(String, Object) - Method in class org.apache.shiro.jndi.JndiTemplate
Rebind the given object to the current JNDI context, using the given name.
redirectToLogin(ServletRequest, ServletResponse) - Method in class org.apache.shiro.web.filter.AccessControlFilter
Convenience method for subclasses that merely acquires the getLoginUrl and redirects the request to that url.
redirectToSavedRequest(ServletRequest, ServletResponse, String) - Static method in class org.apache.shiro.web.util.WebUtils
Redirects the to the request url from a previously saved request, or if there is no saved request, redirects the end user to the specified fallbackUrl.
RedirectView - Class in org.apache.shiro.web.util
View that redirects to an absolute, context relative, or current request relative URL, exposing all model attributes as HTTP query parameters.
RedirectView() - Constructor for class org.apache.shiro.web.util.RedirectView
Constructor for use as a bean.
RedirectView(String) - Constructor for class org.apache.shiro.web.util.RedirectView
Create a new RedirectView with the given URL.
RedirectView(String, boolean) - Constructor for class org.apache.shiro.web.util.RedirectView
Create a new RedirectView with the given URL.
RedirectView(String, boolean, boolean) - Constructor for class org.apache.shiro.web.util.RedirectView
Create a new RedirectView with the given URL.
REFERENCED_SESSION_ID - Static variable in class org.apache.shiro.web.servlet.ShiroHttpServletRequest
 
REFERENCED_SESSION_ID_IS_VALID - Static variable in class org.apache.shiro.web.servlet.ShiroHttpServletRequest
 
REFERENCED_SESSION_ID_SOURCE - Static variable in class org.apache.shiro.web.servlet.ShiroHttpServletRequest
 
REFERENCED_SESSION_IS_NEW - Static variable in class org.apache.shiro.web.servlet.ShiroHttpServletRequest
 
referral - Variable in class org.apache.shiro.realm.ldap.DefaultLdapContextFactory
Deprecated.  
ReflectionBuilder - Class in org.apache.shiro.config
Object builder that uses reflection and Apache Commons BeanUtils to build objects given a map of "property values".
ReflectionBuilder() - Constructor for class org.apache.shiro.config.ReflectionBuilder
 
ReflectionBuilder(Map<String, ?>) - Constructor for class org.apache.shiro.config.ReflectionBuilder
 
RegExPatternMatcher - Class in org.apache.shiro.util
PatternMatcher implementation that uses standard java.util.regex objects.
RegExPatternMatcher() - Constructor for class org.apache.shiro.util.RegExPatternMatcher
 
registerFilters(Map<String, Filter>, FilterChainManager) - Method in class org.apache.shiro.web.config.IniFilterChainResolverFactory
 
releaseRunAs() - Method in interface org.apache.shiro.subject.Subject
Releases the current 'run as' (assumed) identity and reverts back to the previous 'pre run as' identity that existed before #runAs runAs was called.
releaseRunAs() - Method in class org.apache.shiro.subject.support.DelegatingSubject
 
reloadIntervalSeconds - Variable in class org.apache.shiro.realm.text.PropertiesRealm
 
rememberIdentity(Subject, AuthenticationToken, AuthenticationInfo) - Method in class org.apache.shiro.mgt.AbstractRememberMeManager
Remembers a subject-unique identity for retrieval later.
rememberIdentity(Subject, PrincipalCollection) - Method in class org.apache.shiro.mgt.AbstractRememberMeManager
Remembers the specified account principals by first converting them to a byte array and then remembers that byte array.
RememberMeAuthenticationToken - Interface in org.apache.shiro.authc
An AuthenticationToken that indicates if the user wishes their identity to be remembered across sessions.
rememberMeFailedLogin(AuthenticationToken, AuthenticationException, Subject) - Method in class org.apache.shiro.mgt.DefaultSecurityManager
 
rememberMeLogout(Subject) - Method in class org.apache.shiro.mgt.DefaultSecurityManager
 
rememberMeManager - Variable in class org.apache.shiro.mgt.DefaultSecurityManager
 
RememberMeManager - Interface in org.apache.shiro.mgt
A RememberMeManager is responsible for remembering a Subject's identity across that Subject's sessions with the application.
rememberMeSuccessfulLogin(AuthenticationToken, AuthenticationInfo, Subject) - Method in class org.apache.shiro.mgt.DefaultSecurityManager
 
rememberSerializedIdentity(Subject, byte[]) - Method in class org.apache.shiro.mgt.AbstractRememberMeManager
Persists the identity bytes to a persistent store for retrieval later via the AbstractRememberMeManager.getRememberedSerializedIdentity(SubjectContext) method.
rememberSerializedIdentity(Subject, byte[]) - Method in class org.apache.shiro.web.mgt.CookieRememberMeManager
Base64-encodes the specified serialized byte array and sets that base64-encoded String as the cookie value.
remove(K) - Method in interface org.apache.shiro.cache.Cache
Remove the cache entry corresponding to the specified key.
remove(K) - Method in class org.apache.shiro.cache.ehcache.EhCache
Removes the element which matches the key.
remove(K) - Method in class org.apache.shiro.cache.MapCache
 
remove(Object) - Method in class org.apache.shiro.config.Ini
 
remove(Object) - Method in class org.apache.shiro.config.Ini.Section
 
remove(Object) - Method in class org.apache.shiro.subject.SimplePrincipalMap
 
remove(Object) - Method in class org.apache.shiro.util.MapContext
 
remove(Object) - Method in class org.apache.shiro.util.SoftHashMap
 
remove(Object) - Static method in class org.apache.shiro.util.ThreadContext
Unbinds the value for the given key from the current thread.
remove() - Static method in class org.apache.shiro.util.ThreadContext
Removes the underlying ThreadLocal from the thread.
remove(int) - Method in class org.apache.shiro.web.filter.mgt.SimpleNamedFilterList
 
remove(Object) - Method in class org.apache.shiro.web.filter.mgt.SimpleNamedFilterList
 
removeAll(Collection<?>) - Method in class org.apache.shiro.web.filter.mgt.SimpleNamedFilterList
 
removeAttribute(SessionKey, Object) - Method in class org.apache.shiro.session.mgt.AbstractNativeSessionManager
 
removeAttribute(Object) - Method in class org.apache.shiro.session.mgt.DelegatingSession
 
removeAttribute(Object) - Method in class org.apache.shiro.session.mgt.ImmutableProxiedSession
Immediately throws an InvalidSessionException in all cases because this proxy is immutable.
removeAttribute(SessionKey, Object) - Method in interface org.apache.shiro.session.mgt.NativeSessionManager
Removes (unbinds) the object bound to associated Session under the given attributeKey.
removeAttribute(Object) - Method in class org.apache.shiro.session.mgt.SimpleSession
 
removeAttribute(Object) - Method in class org.apache.shiro.session.ProxiedSession
Immediately delegates to the underlying proxied session.
removeAttribute(Object) - Method in interface org.apache.shiro.session.Session
Removes (unbinds) the object bound to this session under the specified key name.
removeAttribute(String) - Method in class org.apache.shiro.web.servlet.ShiroHttpSession
 
removeAttribute(Object) - Method in class org.apache.shiro.web.session.HttpServletSession
 
removeContextAttribute(String) - Method in class org.apache.shiro.web.servlet.ServletContextSupport
 
removeFrom(HttpServletRequest, HttpServletResponse) - Method in interface org.apache.shiro.web.servlet.Cookie
 
removeFrom(HttpServletRequest, HttpServletResponse) - Method in class org.apache.shiro.web.servlet.SimpleCookie
 
removeFromSession(Subject) - Method in class org.apache.shiro.mgt.DefaultSubjectDAO
Removes any existing subject state from the Subject's session (if the session exists).
removeRealmPrincipal(String, String) - Method in interface org.apache.shiro.subject.PrincipalMap
 
removeRealmPrincipal(String, String) - Method in class org.apache.shiro.subject.SimplePrincipalMap
 
removeRequestIdentity(Subject) - Method in class org.apache.shiro.web.mgt.DefaultWebSecurityManager
 
removeSection(String) - Method in class org.apache.shiro.config.Ini
Removes the section with the specified name and returns it, or null if the section did not exist.
removeValue(String) - Method in class org.apache.shiro.web.servlet.ShiroHttpSession
 
renderMergedOutputModel(Map, HttpServletRequest, HttpServletResponse) - Method in class org.apache.shiro.web.util.RedirectView
Convert model to request parameters and redirect to the given URL.
RequestPairSource - Interface in org.apache.shiro.web.util
A RequestPairSource is a component that can supply a ServletRequest and ServletResponse pair associated with a currently executing request.
RequiredTypeException - Exception in org.apache.shiro.env
Exception thrown when attempting to acquire an object of a required type and that object does not equal, extend, or implement a specified Class.
RequiredTypeException(String) - Constructor for exception org.apache.shiro.env.RequiredTypeException
 
RequiredTypeException(String, Throwable) - Constructor for exception org.apache.shiro.env.RequiredTypeException
 
RequiresAuthentication - Annotation Type in org.apache.shiro.authz.annotation
Requires the current Subject to have been authenticated during their current session for the annotated class/instance/method to be accessed or invoked.
RequiresGuest - Annotation Type in org.apache.shiro.authz.annotation
Requires the current Subject to be a "guest", that is, they are not authenticated or remembered from a previous session for the annotated class/instance/method to be accessed or invoked.
RequiresPermissions - Annotation Type in org.apache.shiro.authz.annotation
Requires the current executor's Subject to imply a particular permission in order to execute the annotated method.
RequiresRoles - Annotation Type in org.apache.shiro.authz.annotation
Requires the currently executing Subject to have all of the specified roles.
RequiresUser - Annotation Type in org.apache.shiro.authz.annotation
Requires the current Subject to be an application user for the annotated class/instance/method to be accessed or invoked.
resolveAuthenticated() - Method in interface org.apache.shiro.subject.SubjectContext
 
resolveAuthenticated() - Method in class org.apache.shiro.subject.support.DefaultSubjectContext
 
resolveClass(ObjectStreamClass) - Method in class org.apache.shiro.io.ClassResolvingObjectInputStream
Resolves an ObjectStreamClass by delegating to Shiro's ClassUtils.forName(String) utility method, which is known to work in all ClassLoader environments.
resolveContextSession(SubjectContext) - Method in class org.apache.shiro.mgt.DefaultSecurityManager
 
resolveDelimitedPermissions(String, PermissionResolver) - Static method in class org.apache.shiro.util.PermissionUtils
 
resolveHost() - Method in interface org.apache.shiro.subject.SubjectContext
 
resolveHost() - Method in class org.apache.shiro.subject.support.DefaultSubjectContext
 
resolveHost() - Method in class org.apache.shiro.web.subject.support.DefaultWebSubjectContext
 
resolveIni() - Method in class org.apache.shiro.config.IniFactorySupport
Tries to resolve the Ini instance to use for configuration.
resolvePermission(String) - Method in interface org.apache.shiro.authz.permission.PermissionResolver
Resolves a Permission based on the given String representation.
resolvePermission(String) - Method in class org.apache.shiro.authz.permission.WildcardPermissionResolver
Returns a new WildcardPermission instance constructed based on the specified permissionString.
resolvePermissions(Collection<String>, PermissionResolver) - Static method in class org.apache.shiro.util.PermissionUtils
 
resolvePermissionsInRole(String) - Method in interface org.apache.shiro.authz.permission.RolePermissionResolver
Resolves a Collection of Permissions based on the given String representation.
resolvePrincipals(SubjectContext) - Method in class org.apache.shiro.mgt.DefaultSecurityManager
Attempts to resolve an identity (a PrincipalCollection) for the context using heuristics.
resolvePrincipals() - Method in interface org.apache.shiro.subject.SubjectContext
 
resolvePrincipals() - Method in class org.apache.shiro.subject.support.DefaultSubjectContext
 
resolveReference(String) - Method in class org.apache.shiro.config.ReflectionBuilder
 
resolveSecurityManager() - Method in interface org.apache.shiro.subject.SubjectContext
Resolves the SecurityManager instance that should be used to back the constructed Subject instance (typically used to support DelegatingSubject implementations).
resolveSecurityManager() - Method in class org.apache.shiro.subject.support.DefaultSubjectContext
 
resolveServletRequest() - Method in class org.apache.shiro.web.subject.support.DefaultWebSubjectContext
 
resolveServletRequest() - Method in interface org.apache.shiro.web.subject.WebSubjectContext
 
resolveServletResponse() - Method in class org.apache.shiro.web.subject.support.DefaultWebSubjectContext
 
resolveServletResponse() - Method in interface org.apache.shiro.web.subject.WebSubjectContext
 
resolveSession(SubjectContext) - Method in class org.apache.shiro.mgt.DefaultSecurityManager
Attempts to resolve any associated session based on the context and returns a context that represents this resolved Session to ensure it may be referenced if necessary by the invoked SubjectFactory that performs actual Subject construction.
resolveSession() - Method in interface org.apache.shiro.subject.SubjectContext
 
resolveSession() - Method in class org.apache.shiro.subject.support.DefaultSubjectContext
 
resolveValue(String) - Method in class org.apache.shiro.config.ReflectionBuilder
 
ResourceBasedWebEnvironment - Class in org.apache.shiro.web.env
Abstract implementation for WebEnvironments that can be initialized via resource paths (config files).
ResourceBasedWebEnvironment() - Constructor for class org.apache.shiro.web.env.ResourceBasedWebEnvironment
 
ResourceConfigurable - Interface in org.apache.shiro.config
Interface implemented by components that can be configured by resource locations (paths).
resourceExists(String) - Static method in class org.apache.shiro.io.ResourceUtils
Returns true if the resource at the specified path exists, false otherwise.
resourcePath - Variable in class org.apache.shiro.realm.text.PropertiesRealm
 
ResourceUtils - Class in org.apache.shiro.io
Static helper methods for loading Stream-backed resources.
REST - Static variable in class org.apache.shiro.guice.web.ShiroWebModule
 
restore() - Method in class org.apache.shiro.subject.support.SubjectThreadState
Removes all thread-state that was bound by this instance.
restore() - Method in interface org.apache.shiro.util.ThreadState
Restores a thread to its state before bind bind was invoked.
retainAll(Collection<?>) - Method in class org.apache.shiro.web.filter.mgt.SimpleNamedFilterList
 
retrieveSession(SessionKey) - Method in class org.apache.shiro.session.mgt.AbstractValidatingSessionManager
Looks up a session from the underlying data store based on the specified session key.
retrieveSession(SessionKey) - Method in class org.apache.shiro.session.mgt.DefaultSessionManager
 
retrieveSessionFromDataSource(Serializable) - Method in class org.apache.shiro.session.mgt.DefaultSessionManager
 
RoleAnnotationHandler - Class in org.apache.shiro.authz.aop
Checks to see if a @RequiresRoles annotation is declared, and if so, performs a role check to see if the calling Subject is allowed to proceed.
RoleAnnotationHandler() - Constructor for class org.apache.shiro.authz.aop.RoleAnnotationHandler
Default no-argument constructor that ensures this handler looks for RequiresRoles annotations.
RoleAnnotationMethodInterceptor - Class in org.apache.shiro.authz.aop
Checks to see if a @RequiresRoles annotation is declared, and if so, performs a role check to see if the calling Subject is allowed to invoke the method.
RoleAnnotationMethodInterceptor() - Constructor for class org.apache.shiro.authz.aop.RoleAnnotationMethodInterceptor
Default no-argument constructor that ensures this interceptor looks for RequiresRoles annotations in a method declaration.
RoleAnnotationMethodInterceptor(AnnotationResolver) - Constructor for class org.apache.shiro.authz.aop.RoleAnnotationMethodInterceptor
 
roleExists(String) - Method in class org.apache.shiro.realm.SimpleAccountRealm
 
rolePermissionResolver - Variable in class org.apache.shiro.authz.ModularRealmAuthorizer
A RolePermissionResolver to be used by all configured realms.
RolePermissionResolver - Interface in org.apache.shiro.authz.permission
A RolePermissionResolver resolves a String value and converts it into a Collection of Permission instances.
RolePermissionResolverAware - Interface in org.apache.shiro.authz.permission
Interface implemented by a component that wishes to use any application-configured RolePermissionResolver that might already exist instead of potentially creating one itself.
roles - Variable in class org.apache.shiro.authz.SimpleAuthorizationInfo
The internal roles collection.
ROLES - Static variable in class org.apache.shiro.guice.web.ShiroWebModule
 
roles - Variable in class org.apache.shiro.realm.SimpleAccountRealm
 
ROLES_LOCK - Variable in class org.apache.shiro.realm.SimpleAccountRealm
 
ROLES_SECTION_NAME - Static variable in class org.apache.shiro.realm.text.IniRealm
 
RolesAuthorizationFilter - Class in org.apache.shiro.web.filter.authz
Filter that allows access if the current user has the roles specified by the mapped value, or denies access if the user does not have all of the roles specified.
RolesAuthorizationFilter() - Constructor for class org.apache.shiro.web.filter.authz.RolesAuthorizationFilter
 
RoleTag - Class in org.apache.shiro.web.tags
 
RoleTag() - Constructor for class org.apache.shiro.web.tags.RoleTag
 
ROOT_PATH - Static variable in interface org.apache.shiro.web.servlet.Cookie
Root path to use when the path hasn't been set and request context root is empty or null.
run() - Method in class org.apache.shiro.realm.text.PropertiesRealm
 
run() - Method in class org.apache.shiro.session.mgt.ExecutorServiceSessionValidationScheduler
 
run() - Method in class org.apache.shiro.subject.support.SubjectRunnable
Binds the Subject thread state, executes the target Runnable and then guarantees the previous thread state's restoration:
runAs(PrincipalCollection) - Method in interface org.apache.shiro.subject.Subject
Allows this subject to 'run as' or 'assume' another identity indefinitely.
runAs(PrincipalCollection) - Method in class org.apache.shiro.subject.support.DelegatingSubject
 

S

SaltedAuthenticationInfo - Interface in org.apache.shiro.authc
Interface representing account information that may use a salt when hashing credentials.
saltStyle - Variable in class org.apache.shiro.realm.jdbc.JdbcRealm
 
save(Subject) - Method in class org.apache.shiro.mgt.DefaultSecurityManager
Saves the subject's state to a persistent location for future reference if necessary.
save(Subject) - Method in class org.apache.shiro.mgt.DefaultSubjectDAO
Saves the subject's state to the subject's session only if sessionStorageEnabled(subject).
save(Subject) - Method in interface org.apache.shiro.mgt.SubjectDAO
Persists the specified Subject's state for later access.
SAVED_REQUEST_KEY - Static variable in class org.apache.shiro.web.util.WebUtils
Session key used to save a request and later restore it, for example when redirecting to a requested page after login, equal to shiroSavedRequest.
SavedRequest - Class in org.apache.shiro.web.util
Maintains request data for a request that was redirected, so that after authentication the user can be redirected to the originally requested page.
SavedRequest(HttpServletRequest) - Constructor for class org.apache.shiro.web.util.SavedRequest
Constructs a new instance from the given HTTP request.
saveRequest(ServletRequest) - Method in class org.apache.shiro.web.filter.AccessControlFilter
Convenience method merely delegates to WebUtils.saveRequest(request) to save the request state for reuse later.
saveRequest(ServletRequest) - Static method in class org.apache.shiro.web.util.WebUtils
 
saveRequestAndRedirectToLogin(ServletRequest, ServletResponse) - Method in class org.apache.shiro.web.filter.AccessControlFilter
Convenience method for subclasses to use when a login redirect is required.
saveTo(HttpServletRequest, HttpServletResponse) - Method in interface org.apache.shiro.web.servlet.Cookie
 
saveTo(HttpServletRequest, HttpServletResponse) - Method in class org.apache.shiro.web.servlet.SimpleCookie
 
saveToSession(Subject) - Method in class org.apache.shiro.mgt.DefaultSubjectDAO
Saves the subject's state (it's principals and authentication state) to its session.
schedule(Runnable, long, TimeUnit) - Method in class org.apache.shiro.concurrent.SubjectAwareScheduledExecutorService
 
schedule(Callable<V>, long, TimeUnit) - Method in class org.apache.shiro.concurrent.SubjectAwareScheduledExecutorService
 
scheduleAtFixedRate(Runnable, long, long, TimeUnit) - Method in class org.apache.shiro.concurrent.SubjectAwareScheduledExecutorService
 
scheduler - Variable in class org.apache.shiro.realm.text.PropertiesRealm
 
scheduleWithFixedDelay(Runnable, long, long, TimeUnit) - Method in class org.apache.shiro.concurrent.SubjectAwareScheduledExecutorService
 
scope(Key<T>, Provider<T>) - Method in class org.apache.shiro.guice.ShiroSessionScope
 
searchBase - Variable in class org.apache.shiro.realm.ldap.AbstractLdapRealm
 
searchBase - Variable in class org.apache.shiro.realm.ldap.DefaultLdapContextFactory
Deprecated.  
SECTION_PREFIX - Static variable in class org.apache.shiro.config.Ini
 
SECTION_SUFFIX - Static variable in class org.apache.shiro.config.Ini
 
SECURE_ATTRIBUTE_NAME - Static variable in class org.apache.shiro.web.servlet.SimpleCookie
 
SecureRandomNumberGenerator - Class in org.apache.shiro.crypto
Default implementation of the RandomNumberGenerator interface, backed by a SecureRandom instance.
SecureRandomNumberGenerator() - Constructor for class org.apache.shiro.crypto.SecureRandomNumberGenerator
Creates a new instance with a default backing SecureRandom and a defaultNextBytesSize of 16, which equals 128 bits, a size commonly used in cryptographic algorithms.
SecureRemoteInvocationExecutor - Class in org.apache.shiro.spring.remoting
An implementation of the Spring RemoteInvocationExecutor that binds a sessionId to the incoming thread to make it available to the SecurityManager implementation during the thread execution.