com.epimorphics.appbase.security

Class AppRealm

java.lang.Object

org.apache.shiro.realm.CachingRealm

org.apache.shiro.realm.AuthenticatingRealm

org.apache.shiro.realm.AuthorizingRealm

com.epimorphics.appbase.security.AppRealm

All Implemented Interfaces:

org.apache.shiro.authc.LogoutAware, org.apache.shiro.authz.Authorizer, org.apache.shiro.authz.permission.PermissionResolverAware, org.apache.shiro.authz.permission.RolePermissionResolverAware, org.apache.shiro.cache.CacheManagerAware, org.apache.shiro.realm.Realm, org.apache.shiro.util.Initializable, org.apache.shiro.util.Nameable

public class AppRealm
extends org.apache.shiro.realm.AuthorizingRealm

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_ALGORITHM
static int	DEFAULT_ITERATIONS
protected org.apache.shiro.crypto.hash.HashService	hashService
protected UserStore	userstore

Constructor Summary

Constructors

Constructor and Description
AppRealm()

Method Summary

Modifier and Type	Method and Description
protected void	clearCacheFor(String id) Clear cached authentication and authorization information for an individual.
protected org.apache.shiro.authc.AuthenticationInfo	doGetAuthenticationInfo(org.apache.shiro.authc.AuthenticationToken token)
protected org.apache.shiro.authz.AuthorizationInfo	doGetAuthorizationInfo(org.apache.shiro.subject.PrincipalCollection principals)
protected Object	getAuthenticationCacheKey(org.apache.shiro.subject.PrincipalCollection pc)
org.apache.shiro.crypto.hash.HashService	getHashService()
static AppRealm	getRealm()
UserStore	getUserStore()
static String	permissionAction(String permission) Return the action part of a action:path permission structure
static String	permissionPath(String permission) Return the path part of a action:path permission structure
void	setDiscoverUserStore(String storename) Configure a user store by looking up its name in the set of configured components
void	setHashIterations(int iterations) Set the number of iterations that the hash service should use.
void	setUserStore(UserStore store) Configure the user store for this realm
static String[]	splitPermission(String permission) The string permission structure allows standard Shiro wildcard structures foo:bar:baz...

Methods inherited from class org.apache.shiro.realm.AuthorizingRealm

afterCacheManagerSet, checkPermission, checkPermission, checkPermission, checkPermissions, checkPermissions, checkPermissions, checkRole, checkRole, checkRoles, checkRoles, checkRoles, clearCachedAuthorizationInfo, doClearCache, getAuthorizationCache, getAuthorizationCacheKey, getAuthorizationCacheName, getAuthorizationInfo, getPermissionResolver, getRolePermissionResolver, hasAllRoles, hasRole, hasRole, hasRoles, hasRoles, isAuthorizationCachingEnabled, isPermitted, isPermitted, isPermitted, isPermitted, isPermitted, isPermittedAll, isPermittedAll, isPermittedAll, onInit, setAuthorizationCache, setAuthorizationCacheName, setAuthorizationCachingEnabled, setName, setPermissionResolver, setRolePermissionResolver

Methods inherited from class org.apache.shiro.realm.AuthenticatingRealm

assertCredentialsMatch, clearCachedAuthenticationInfo, getAuthenticationCache, getAuthenticationCacheKey, getAuthenticationCacheName, getAuthenticationInfo, getAuthenticationTokenClass, getCredentialsMatcher, init, isAuthenticationCachingEnabled, isAuthenticationCachingEnabled, setAuthenticationCache, setAuthenticationCacheName, setAuthenticationCachingEnabled, setAuthenticationTokenClass, setCredentialsMatcher, supports

Methods inherited from class org.apache.shiro.realm.CachingRealm

clearCache, getAvailablePrincipal, getCacheManager, getName, isCachingEnabled, onLogout, setCacheManager, setCachingEnabled

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.shiro.util.Initializable

init

Field Detail

DEFAULT_ALGORITHM

public static final String DEFAULT_ALGORITHM

See Also:

Constant Field Values

DEFAULT_ITERATIONS

public static final int DEFAULT_ITERATIONS

See Also:

Constant Field Values

hashService

protected org.apache.shiro.crypto.hash.HashService hashService

userstore

protected UserStore userstore

Constructor Detail

AppRealm

public AppRealm()

Method Detail

getRealm

public static AppRealm getRealm()

setHashIterations

public void setHashIterations(int iterations)

Set the number of iterations that the hash service should use. Must be set before any new credentials (including bootstrap ones) are hashed.

setDiscoverUserStore

public void setDiscoverUserStore(String storename)

Configure a user store by looking up its name in the set of configured components

setUserStore

public void setUserStore(UserStore store)

Configure the user store for this realm

getUserStore

public UserStore getUserStore()

permissionPath

public static String permissionPath(String permission)

Return the path part of a action:path permission structure

permissionAction

public static String permissionAction(String permission)

Return the action part of a action:path permission structure

splitPermission

public static String[] splitPermission(String permission)

The string permission structure allows standard Shiro wildcard structures foo:bar:baz... However, the user store is optimized for a structure action:path where you can add or remove all actions related to a path. This allows for other permission resolvers (e.g. the hierarchical paths supported by the registry). To cater for the mismatch we simply split the first segment of the wildcard to treat as an action and treat the rest as the path.

getHashService

public org.apache.shiro.crypto.hash.HashService getHashService()

clearCacheFor

protected void clearCacheFor(String id)

Clear cached authentication and authorization information for an individual. Should be called from UserStore implementation whenever a change is made.

doGetAuthenticationInfo

protected org.apache.shiro.authc.AuthenticationInfo doGetAuthenticationInfo(org.apache.shiro.authc.AuthenticationToken token)
                                                                     throws org.apache.shiro.authc.AuthenticationException

Specified by:

doGetAuthenticationInfo in class org.apache.shiro.realm.AuthenticatingRealm

Throws:

org.apache.shiro.authc.AuthenticationException

doGetAuthorizationInfo

protected org.apache.shiro.authz.AuthorizationInfo doGetAuthorizationInfo(org.apache.shiro.subject.PrincipalCollection principals)

Specified by:

doGetAuthorizationInfo in class org.apache.shiro.realm.AuthorizingRealm

getAuthenticationCacheKey

protected Object getAuthenticationCacheKey(org.apache.shiro.subject.PrincipalCollection pc)

Overrides:

getAuthenticationCacheKey in class org.apache.shiro.realm.AuthenticatingRealm