Property Detail

• static final org.slf4j.Logger LOG

• org.apache.shiro.authz.permission.PermissionResolver permissionResolver

• java.lang.Class tokenClass

Method Detail

• @groovy.transform.CompileStatic
  org.apache.shiro.authc.AuthenticationInfo authenticate(org.apache.shiro.authc.AuthenticationToken authenticationToken)

  This is a placeholder method for the target Realm. If you don't implement authenticate then you'll get a NotImplementedException

  throws:

  AuthenticationException if not authenticated.

  Parameters:

  authenticationToken - AuthenticationToken to authenticate

  Returns:

  AuthenticationInfo*

• @groovy.transform.CompileStatic
  void checkPermission(org.apache.shiro.subject.PrincipalCollection principal, org.apache.shiro.authz.Permission permission)

  Check for a permission

  throws:

  AuthorizationException

  See Also:

  org.apache.shiro.authz.Authorizer#checkPermission(org.apache.shiro.subject.PrincipalCollection, org.apache.shiro.authz.Permission)

  Parameters:

  principal

  permission

• @groovy.transform.CompileStatic
  void checkPermission(org.apache.shiro.subject.PrincipalCollection principal, java.lang.String s)

  Ensures the corresponding Subject/user implies the specified permission String.

  throws:

  AuthorizationException if the user does not have the permission, or the permission string is Invalid

  Parameters:

  principal - a PrincipalCollection

  s - the permission String to use

• @groovy.transform.CompileStatic
  void checkPermissions(org.apache.shiro.subject.PrincipalCollection principal, java.util.Collection<org.apache.shiro.authz.Permission> permissions)

  Check for a set of permissions, the user must have all permissions.

  throws:

  AuthorizationException

  See Also:

  org.apache.shiro.authz.Authorizer#checkPermissions<org.apache.shiro.authz.Permission>

  Parameters:

  principal

  permissions

• @groovy.transform.CompileStatic
  void checkPermissions(org.apache.shiro.subject.PrincipalCollection principal, java.lang.String[] strings)

  Ensures the corresponding Subject/user org.apache.shiro.authz.Permission#implies(org.apache.shiro.authz.Permission) all of the specified permission strings.

  throws:

  AuthorizationException if the user does not have the permission, or the permission string is Invalid

  Parameters:

  principal - a PrincipalCollection

  strings - the permission Strings to use

• @groovy.transform.CompileStatic
  void checkRole(org.apache.shiro.subject.PrincipalCollection principal, java.lang.String role)

  Check user has a named role

  throws:

  AuthorizationException

  See Also:

  org.apache.shiro.authz.Authorizer#checkRole(PrincipalCollection, java.lang.String)

  Parameters:

  principal

  role

• @groovy.transform.CompileStatic
  void checkRoles(org.apache.shiro.subject.PrincipalCollection principal, java.util.Collection<java.lang.String> roles)

  Check a user has a set of named roles. The user must have all the roles.

  throws:

  AuthorizationException

  See Also:

  org.apache.shiro.authz.Authorizer#checkRoles<java.lang.String>

  Parameters:

  principal

  roles

• @groovy.transform.CompileStatic
  void checkRoles(org.apache.shiro.subject.PrincipalCollection principal, java.lang.String[] roles)

  Same as checkRoles(PrincipalCollection subjectPrincipal, Collection<String> roleIdentifiers) but doesn't require a collection as an argument.

  throws:

  AuthorizationException if the user does not have all of the specified roles.

  Parameters:

  principal - a PrincipalCollection

  roles - role name strings

• @groovy.transform.CompileStatic
  org.apache.shiro.authc.AuthenticationInfo getAuthenticationInfo(org.apache.shiro.authc.AuthenticationToken authenticationToken)

  Wraps the authenticate method logging unable to authenticate exceptions

  Parameters:

  authenticationToken

  Returns:

  @throws AuthenticationException

• @groovy.transform.CompileStatic
  java.lang.String getName()

• @groovy.transform.CompileStatic
  org.apache.shiro.authz.permission.PermissionResolver getPermissionResolver()

• @groovy.transform.CompileStatic
  boolean hasAllRoles(org.apache.shiro.subject.PrincipalCollection principalCollection, java.util.Collection<java.lang.String> roles)

  This should be implemented in your realm either as the simplified version in SimplifiedRealm or a just override this.

  See Also:

  org.apache.shiro.authz.Authorizer#hasAllRoles<java.lang.String>

  Parameters:

  principalCollection

  roles

  Returns:

  true if they have all the roles

• @groovy.transform.CompileStatic
  boolean hasAllRoles(java.lang.Object principal, java.util.Collection<java.lang.String> roles)

• @groovy.transform.CompileStatic
  boolean hasRole(org.apache.shiro.subject.PrincipalCollection principalCollection, java.lang.String role)

  This should be implemented in your realm either as the simplified version in SimplifiedRealm or a just override this.

  See Also:

  org.apache.shiro.authz.Authorizer#hasRole(PrincipalCollection, String)

  Parameters:

  principalCollection

  role

  Returns:

  true if they have this role

• @groovy.transform.CompileStatic
  boolean hasRole(java.lang.Object principal, java.lang.String roleName)

• @groovy.transform.CompileStatic
  boolean[] hasRoles(org.apache.shiro.subject.PrincipalCollection principalCollection, java.util.List<java.lang.String> roles)

  Default implementation using hasRole in a loop override if you can do better.

  See Also:

  org.apache.shiro.authz.Authorizer#hasRoles<java.lang.String>

  Parameters:

  principalCollection

  roles

  Returns:

  array of boolean mapped to roles in list

• @groovy.transform.CompileStatic
  boolean isPermitted(org.apache.shiro.subject.PrincipalCollection principalCollection, org.apache.shiro.authz.Permission permission)

  This should be implemented in your realm either as the simplified version in SimplifiedRealm or a just override this.

  See Also:

  org.apache.shiro.authz.Authorizer#isPermitted(PrincipalCollection, org.apache.shiro.authz.Permission)

  Parameters:

  principalCollection

  permission

  Returns:

  true if the principal has this permission

• @groovy.transform.CompileStatic
  boolean isPermitted(java.lang.Object principal, org.apache.shiro.authz.Permission requiredPermission)

• @groovy.transform.CompileStatic
  boolean[] isPermitted(org.apache.shiro.subject.PrincipalCollection principalCollection, java.util.List<org.apache.shiro.authz.Permission> permissions)

  Default implementation of

  See Also:

  org.apache.shiro.authz.Authorizer#isPermitted(Object, java.util.List)

  Parameters:

  principalCollection

  permissions

  Returns:

  Array of booleans indicating the permissions the user has.

• @groovy.transform.CompileStatic
  boolean isPermitted(org.apache.shiro.subject.PrincipalCollection principal, java.lang.String s)

  Convert the permission string to a Permission and then check it. The Authorizer interface does not specify that it can throw an Authorization exception which is sensible for an boolean method. So if the PermissionResolver.resolvePermission() throws an InvalidPermissionStringException we return false

  Parameters:

  principal - a PrincipalCollection

  s - the permission String to use

  Returns:

  true if permitted

  See Also:

  isPermitted(PrincipalCollection principals, String permission)

• @groovy.transform.CompileStatic
  boolean[] isPermitted(org.apache.shiro.subject.PrincipalCollection principal, java.lang.String[] strings)

  Checks if the corresponding Subject implies the given permission strings and returns a boolean array indicating which permissions are implied.

  The Authorizer interface does not specify that it can throw an Authorization exception which is sensible for an boolean method. So if the PermissionResolver.resolvePermission() throws an InvalidPermissionStringException we return boolean[0]

  Parameters:

  principal - a PrincipalCollection

  strings - the permission Strings to use

  Returns:

  boolean array true if permitted

• @groovy.transform.CompileStatic
  boolean isPermittedAll(org.apache.shiro.subject.PrincipalCollection principalCollection, java.util.Collection<org.apache.shiro.authz.Permission> permissions)

  Default implementation of

  See Also:

  org.apache.shiro.authz.Authorizer#isPermittedAll(Object, java.util.Collection)

  Parameters:

  principalCollection

  permissions

  Returns:

  true if all user has all permissions

• @groovy.transform.CompileStatic
  boolean isPermittedAll(org.apache.shiro.subject.PrincipalCollection principal, java.lang.String[] strings)

  Returns true if the corresponding Subject/user implies all of the specified permission strings, false otherwise. The Authorizer interface does not specify that it can throw an Authorization exception which is sensible for an boolean method. So if the PermissionResolver.resolvePermission() throws an InvalidPermissionStringException we return boolean[0]

  Parameters:

  principal - a PrincipalCollection

  strings - the permission Strings to use

  Returns:

  boolean true if permitted

• @java.lang.SuppressWarnings(value: unused)
  @groovy.transform.CompileStatic
  org.apache.shiro.authc.SimpleAuthenticationInfo makeSimpleAuthInfoSansCredentials(java.util.Collection principals)

  A helper method to create a SimpleAuthenticationInfo from a collection of principal objects. This does not set any credentials.

  Parameters:

  principals

  Returns:

  SimpleAuthenticationInfo without any credentials

• @java.lang.SuppressWarnings(value: unused)
  @groovy.transform.CompileStatic
  org.apache.shiro.authc.SimpleAuthenticationInfo makeSimpleAuthInfoSansCredentials(java.lang.Object principal)

  A helper method to create a SimpleAuthenticationInfo from a principal object. This does not set any credentials.

  Parameters:

  principals

  Returns:

  SimpleAuthenticationInfo without any credentials

• @groovy.transform.CompileStatic
  void onLogout(org.apache.shiro.subject.PrincipalCollection principal)

  Placeholder do nothing on logout override as required

  See Also:

  org.apache.shiro.authc.LogoutAware#onLogout(PrincipalCollection)

• @groovy.transform.CompileStatic
  void setPermissionResolver(org.apache.shiro.authz.permission.PermissionResolver pr)

  Set the permission resolver. This is initially set to WildcardPermissionResolver unless replaced via spring

  Parameters:

  pr

• @java.lang.SuppressWarnings(value: unused)
  @groovy.transform.CompileStatic
  void setTokenClass(java.lang.Class clazz)

• @groovy.transform.CompileStatic
  boolean supports(org.apache.shiro.authc.AuthenticationToken authenticationToken)

  Default implementation, checks the tokenClass

  See Also:

  org.apache.shiro.realm.Realm#supports(org.apache.shiro.authc.AuthenticationToken)