org.onehippo.forge.security.support.shiro.realm

Class HippoRepositoryRealm

java.lang.Object

org.apache.shiro.realm.CachingRealm

org.apache.shiro.realm.AuthenticatingRealm

org.apache.shiro.realm.AuthorizingRealm

org.onehippo.forge.security.support.shiro.realm.HippoRepositoryRealm

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 HippoRepositoryRealm
extends org.apache.shiro.realm.AuthorizingRealm

Realm that allows authentication and authorization against Hippo Repository security data store.

This realm supports caching by extending from AuthorizingRealm.

Constructor Summary

Constructors

Constructor and Description
HippoRepositoryRealm()

Method Summary

Modifier and Type	Method and Description
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)
String	getDefaultPermission()
String	getDefaultRoleName()
String	getGroupsOfUserQuery()
protected Set<String>	getPermissions(String username, Set<String> roleNames)
String	getQueryLanguage()
protected Set<String>	getRoleNames(String username)
String	getRolePrefix()
String	getRolesOfUserAndGroupQuery()
javax.jcr.Credentials	getSystemCredentials()
javax.jcr.Repository	getSystemRepository()
String	getUserQuery()
boolean	isPermissionsLookupEnabled()
void	setDefaultPermission(String defaultPermission)
void	setDefaultRoleName(String defaultRoleName)
void	setGroupsOfUserQuery(String groupsOfUserQuery)
void	setPermissionsLookupEnabled(boolean permissionsLookupEnabled)
void	setQueryLanguage(String queryLanguage)
void	setRolePrefix(String rolePrefix)
void	setRolesOfUserAndGroupQuery(String rolesOfUserAndGroupQuery)
void	setSystemCredentials(javax.jcr.Credentials systemCreds)
void	setSystemRepository(javax.jcr.Repository systemRepository)
void	setUserQuery(String userQuery)

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, getPermissions, getRolePermissionResolver, hasAllRoles, hasRole, hasRole, hasRoles, hasRoles, isAuthorizationCachingEnabled, isPermitted, 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, 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

Constructor Detail

HippoRepositoryRealm

public HippoRepositoryRealm()

Method Detail

setSystemRepository

public void setSystemRepository(javax.jcr.Repository systemRepository)

getSystemRepository

public javax.jcr.Repository getSystemRepository()

setSystemCredentials

public void setSystemCredentials(javax.jcr.Credentials systemCreds)

getSystemCredentials

public javax.jcr.Credentials getSystemCredentials()

setQueryLanguage

public void setQueryLanguage(String queryLanguage)

getQueryLanguage

public String getQueryLanguage()

getUserQuery

public String getUserQuery()

setUserQuery

public void setUserQuery(String userQuery)

setGroupsOfUserQuery

public void setGroupsOfUserQuery(String groupsOfUserQuery)

getGroupsOfUserQuery

public String getGroupsOfUserQuery()

setRolesOfUserAndGroupQuery

public void setRolesOfUserAndGroupQuery(String rolesOfUserAndGroupQuery)

getRolesOfUserAndGroupQuery

public String getRolesOfUserAndGroupQuery()

setDefaultRoleName

public void setDefaultRoleName(String defaultRoleName)

getDefaultRoleName

public String getDefaultRoleName()

getRolePrefix

public String getRolePrefix()

setRolePrefix

public void setRolePrefix(String rolePrefix)

isPermissionsLookupEnabled

public boolean isPermissionsLookupEnabled()

setPermissionsLookupEnabled

public void setPermissionsLookupEnabled(boolean permissionsLookupEnabled)

getDefaultPermission

public String getDefaultPermission()

setDefaultPermission

public void setDefaultPermission(String defaultPermission)

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

getRoleNames

protected Set<String> getRoleNames(String username)
                            throws org.apache.shiro.authz.AuthorizationException

Throws:

org.apache.shiro.authz.AuthorizationException

getPermissions

protected Set<String> getPermissions(String username,
                                     Set<String> roleNames)
                              throws org.apache.shiro.authz.AuthorizationException

Throws:

org.apache.shiro.authz.AuthorizationException