MoquiShiroRealm (Moqui Framework 3.0.0)

org.moqui.impl.util.MoquiShiroRealm

All Implemented Interfaces and Traits:: org.apache.shiro.realm.Realm, org.apache.shiro.authz.Authorizer

@groovy.transform.CompileStatic
class MoquiShiroRealm
extends java.lang.Object
implements org.apache.shiro.realm.Realm, org.apache.shiro.authz.Authorizer

Nested Class Summary

Nested classes
Modifiers	Name	Description
`static class`	`MoquiShiroRealm.ForceLoginToken`

Field Summary

Fields
Modifiers	Name	Description
`protected java.lang.Class<? extends AuthenticationToken>`	`authenticationTokenClass`
`protected ExecutionContextFactoryImpl`	`ecfi`
`protected static org.slf4j.Logger`	`logger`
`protected java.lang.String`	`realmName`

Properties Summary

Properties
Type	Name and description
`java.lang.String`	`name`

Constructor Summary

Constructors
Constructor and description
`MoquiShiroRealm ()`
`MoquiShiroRealm (ExecutionContextFactoryImpl ecfi)`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`static boolean`	`checkCredentials(java.lang.String username, java.lang.String password, ExecutionContextFactoryImpl ecfi)`
	`void`	`checkPermission(org.apache.shiro.subject.PrincipalCollection principalCollection, org.apache.shiro.authz.Permission permission)`
	`void`	`checkPermission(org.apache.shiro.subject.PrincipalCollection principalCollection, java.lang.String permission)`
	`void`	`checkPermissions(org.apache.shiro.subject.PrincipalCollection principalCollection, java.lang.String[] strings)`
	`void`	`checkPermissions(org.apache.shiro.subject.PrincipalCollection principalCollection, java.util.Collection<Permission> permissions)`
	`void`	`checkRole(org.apache.shiro.subject.PrincipalCollection principalCollection, java.lang.String roleName)`
	`void`	`checkRoles(org.apache.shiro.subject.PrincipalCollection principalCollection, java.util.Collection<java.lang.String> roleNames)`
	`void`	`checkRoles(org.apache.shiro.subject.PrincipalCollection principalCollection, java.lang.String[] roleNames)`
	`AuthenticationInfo`	`getAuthenticationInfo(org.apache.shiro.authc.AuthenticationToken token)`
	`java.lang.String`	`getName()`
	`boolean`	`hasAllRoles(org.apache.shiro.subject.PrincipalCollection principalCollection, java.util.Collection<java.lang.String> roleNames)`
	`boolean`	`hasRole(org.apache.shiro.subject.PrincipalCollection principalCollection, java.lang.String roleName)`
	`boolean[]`	`hasRoles(org.apache.shiro.subject.PrincipalCollection principalCollection, java.util.List<java.lang.String> roleNames)`
	`boolean`	`isPermitted(org.apache.shiro.subject.PrincipalCollection principalCollection, java.lang.String resourceAccess)` Parameters: `principalCollection` - The principal (user)
	`boolean[]`	`isPermitted(org.apache.shiro.subject.PrincipalCollection principalCollection, java.lang.String[] resourceAccesses)`
	`boolean`	`isPermitted(org.apache.shiro.subject.PrincipalCollection principalCollection, org.apache.shiro.authz.Permission permission)`
	`boolean[]`	`isPermitted(org.apache.shiro.subject.PrincipalCollection principalCollection, java.util.List<Permission> permissions)`
	`boolean`	`isPermittedAll(org.apache.shiro.subject.PrincipalCollection principalCollection, java.lang.String[] resourceAccesses)`
	`boolean`	`isPermittedAll(org.apache.shiro.subject.PrincipalCollection principalCollection, java.util.Collection<Permission> permissions)`
	`static void`	`loginPostPassword(ExecutionContextImpl eci, EntityValue newUserAccount, org.apache.shiro.authc.AuthenticationToken token)`
	`static EntityValue`	`loginPrePassword(ExecutionContextImpl eci, java.lang.String username)`
	`static void`	`loginSaveHistory(ExecutionContextImpl eci, java.lang.String userId, java.lang.String passwordUsed, boolean successful)`
	`void`	`setName(java.lang.String n)`
	`boolean`	`supports(org.apache.shiro.authc.AuthenticationToken token)`

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class java.lang.Object`	`java.lang.Object#wait(long), java.lang.Object#wait(long, int), java.lang.Object#wait(), java.lang.Object#equals(java.lang.Object), java.lang.Object#toString(), java.lang.Object#hashCode(), java.lang.Object#getClass(), java.lang.Object#notify(), java.lang.Object#notifyAll()`

- Field Detail
  - protected java.lang.Class<? extends AuthenticationToken> authenticationTokenClass
  - protected ExecutionContextFactoryImpl ecfi
  - protected static final org.slf4j.Logger logger
  - protected java.lang.String realmName
- Property Detail
  - java.lang.String name
- Constructor Detail
  - MoquiShiroRealm()
  - MoquiShiroRealm(ExecutionContextFactoryImpl ecfi)
- Method Detail
  - static boolean checkCredentials(java.lang.String username, java.lang.String password, ExecutionContextFactoryImpl ecfi)
  - void checkPermission(org.apache.shiro.subject.PrincipalCollection principalCollection, org.apache.shiro.authz.Permission permission)
  - void checkPermission(org.apache.shiro.subject.PrincipalCollection principalCollection, java.lang.String permission)
  - void checkPermissions(org.apache.shiro.subject.PrincipalCollection principalCollection, java.lang.String[] strings)
  - void checkPermissions(org.apache.shiro.subject.PrincipalCollection principalCollection, java.util.Collection<Permission> permissions)
  - void checkRole(org.apache.shiro.subject.PrincipalCollection principalCollection, java.lang.String roleName)
  - void checkRoles(org.apache.shiro.subject.PrincipalCollection principalCollection, java.util.Collection<java.lang.String> roleNames)
  - void checkRoles(org.apache.shiro.subject.PrincipalCollection principalCollection, java.lang.String[] roleNames)
  - @java.lang.Override AuthenticationInfo getAuthenticationInfo(org.apache.shiro.authc.AuthenticationToken token)
  - @java.lang.Override java.lang.String getName()
  - boolean hasAllRoles(org.apache.shiro.subject.PrincipalCollection principalCollection, java.util.Collection<java.lang.String> roleNames)
  - boolean hasRole(org.apache.shiro.subject.PrincipalCollection principalCollection, java.lang.String roleName)
  - boolean[] hasRoles(org.apache.shiro.subject.PrincipalCollection principalCollection, java.util.List<java.lang.String> roleNames)
  - boolean isPermitted(org.apache.shiro.subject.PrincipalCollection principalCollection, java.lang.String resourceAccess)
    
    Parameters:
    principalCollection - The principal (user)
    resourceAccess - Formatted as: "\${typeEnumId}:\${actionEnumId}:\${name}"
    Returns:
    boolean true if principal is permitted to access the resource, false otherwise.
  - boolean[] isPermitted(org.apache.shiro.subject.PrincipalCollection principalCollection, java.lang.String[] resourceAccesses)
  - boolean isPermitted(org.apache.shiro.subject.PrincipalCollection principalCollection, org.apache.shiro.authz.Permission permission)
  - boolean[] isPermitted(org.apache.shiro.subject.PrincipalCollection principalCollection, java.util.List<Permission> permissions)
  - boolean isPermittedAll(org.apache.shiro.subject.PrincipalCollection principalCollection, java.lang.String[] resourceAccesses)
  - boolean isPermittedAll(org.apache.shiro.subject.PrincipalCollection principalCollection, java.util.Collection<Permission> permissions)
  - static void loginPostPassword(ExecutionContextImpl eci, EntityValue newUserAccount, org.apache.shiro.authc.AuthenticationToken token)
  - static EntityValue loginPrePassword(ExecutionContextImpl eci, java.lang.String username)
  - static void loginSaveHistory(ExecutionContextImpl eci, java.lang.String userId, java.lang.String passwordUsed, boolean successful)
  - void setName(java.lang.String n)
  - @java.lang.Override boolean supports(org.apache.shiro.authc.AuthenticationToken token)

Groovy Documentation

[Groovy] Class MoquiShiroRealm

Nested Class Summary

Field Summary

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Field Detail

protected java.lang.Class<? extends AuthenticationToken> authenticationTokenClass

protected ExecutionContextFactoryImpl ecfi

protected static final org.slf4j.Logger logger

protected java.lang.String realmName

Property Detail

java.lang.String name

Constructor Detail

MoquiShiroRealm()

MoquiShiroRealm(ExecutionContextFactoryImpl ecfi)

Method Detail

static boolean checkCredentials(java.lang.String username, java.lang.String password, ExecutionContextFactoryImpl ecfi)

void checkPermission(org.apache.shiro.subject.PrincipalCollection principalCollection, org.apache.shiro.authz.Permission permission)

void checkPermission(org.apache.shiro.subject.PrincipalCollection principalCollection, java.lang.String permission)

void checkPermissions(org.apache.shiro.subject.PrincipalCollection principalCollection, java.lang.String[] strings)

void checkPermissions(org.apache.shiro.subject.PrincipalCollection principalCollection, java.util.Collection<Permission> permissions)

void checkRole(org.apache.shiro.subject.PrincipalCollection principalCollection, java.lang.String roleName)

void checkRoles(org.apache.shiro.subject.PrincipalCollection principalCollection, java.util.Collection<java.lang.String> roleNames)

void checkRoles(org.apache.shiro.subject.PrincipalCollection principalCollection, java.lang.String[] roleNames)

@java.lang.Override AuthenticationInfo getAuthenticationInfo(org.apache.shiro.authc.AuthenticationToken token)

@java.lang.Override java.lang.String getName()

boolean hasAllRoles(org.apache.shiro.subject.PrincipalCollection principalCollection, java.util.Collection<java.lang.String> roleNames)

boolean hasRole(org.apache.shiro.subject.PrincipalCollection principalCollection, java.lang.String roleName)

boolean[] hasRoles(org.apache.shiro.subject.PrincipalCollection principalCollection, java.util.List<java.lang.String> roleNames)

boolean isPermitted(org.apache.shiro.subject.PrincipalCollection principalCollection, java.lang.String resourceAccess)

boolean[] isPermitted(org.apache.shiro.subject.PrincipalCollection principalCollection, java.lang.String[] resourceAccesses)

boolean isPermitted(org.apache.shiro.subject.PrincipalCollection principalCollection, org.apache.shiro.authz.Permission permission)

boolean[] isPermitted(org.apache.shiro.subject.PrincipalCollection principalCollection, java.util.List<Permission> permissions)

boolean isPermittedAll(org.apache.shiro.subject.PrincipalCollection principalCollection, java.lang.String[] resourceAccesses)

boolean isPermittedAll(org.apache.shiro.subject.PrincipalCollection principalCollection, java.util.Collection<Permission> permissions)

static void loginPostPassword(ExecutionContextImpl eci, EntityValue newUserAccount, org.apache.shiro.authc.AuthenticationToken token)

static EntityValue loginPrePassword(ExecutionContextImpl eci, java.lang.String username)

static void loginSaveHistory(ExecutionContextImpl eci, java.lang.String userId, java.lang.String passwordUsed, boolean successful)

void setName(java.lang.String n)

@java.lang.Override boolean supports(org.apache.shiro.authc.AuthenticationToken token)