Class RolesAllowedAnnotationHandler

java.lang.Object

org.apache.shiro.aop.AnnotationHandler

org.apache.shiro.authz.aop.AuthorizingAnnotationHandler

org.apache.shiro.authz.aop.RolesAllowedAnnotationHandler

public class RolesAllowedAnnotationHandler
extends AuthorizingAnnotationHandler

Checks to see if a @RolesAllowed annotation is declared, and if so, performs a role check to see if the calling Subject is allowed to proceed.

Since:

2.0

Field Summary

Fields inherited from class org.apache.shiro.aop.AnnotationHandler

annotationClass

Constructor Summary

Constructors

Constructor	Description
RolesAllowedAnnotationHandler()	Default no-argument constructor that ensures this handler looks for RequiresRoles annotations.

Method Summary

Modifier and Type	Method	Description
void	assertAuthorized(Annotation a)	Ensures that the calling Subject has one of the Annotation's specified roles, and if not, throws an AuthorizingException indicating that access is denied.

Methods inherited from class org.apache.shiro.aop.AnnotationHandler

getAnnotationClass, getSubject, setAnnotationClass

Methods inherited from class java.lang.Object

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

Constructor Details

RolesAllowedAnnotationHandler

public RolesAllowedAnnotationHandler()

Default no-argument constructor that ensures this handler looks for RequiresRoles annotations.

Method Details

assertAuthorized

public void assertAuthorized(Annotation a)
                      throws AuthorizationException

Ensures that the calling Subject has one of the Annotation's specified roles, and if not, throws an AuthorizingException indicating that access is denied.

Specified by:

assertAuthorized in class AuthorizingAnnotationHandler

Parameters:

a - the RolesAllowed annotation to use to check for one or more roles

Throws:

AuthorizationException - if the calling Subject does not have the role necessary to proceed.