001/*
002 * Licensed to the Apache Software Foundation (ASF) under one
003 * or more contributor license agreements.  See the NOTICE file
004 * distributed with this work for additional information
005 * regarding copyright ownership.  The ASF licenses this file
006 * to you under the Apache License, Version 2.0 (the
007 * "License"); you may not use this file except in compliance
008 * with the License.  You may obtain a copy of the License at
009 *
010 *     http://www.apache.org/licenses/LICENSE-2.0
011 *
012 * Unless required by applicable law or agreed to in writing,
013 * software distributed under the License is distributed on an
014 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
015 * KIND, either express or implied.  See the License for the
016 * specific language governing permissions and limitations
017 * under the License.
018 */
019package org.apache.shiro.authz.aop;
020
021import java.lang.annotation.Annotation;
022
023import org.apache.shiro.aop.AnnotationHandler;
024import org.apache.shiro.authz.AuthorizationException;
025
026/**
027 * An AnnotationHandler that executes authorization (access control) behavior based on directive(s) found in a
028 * JSR-175 Annotation.
029 *
030 * @since 0.9.0
031 */
032public abstract class AuthorizingAnnotationHandler extends AnnotationHandler {
033
034    /**
035     * Constructs an <code>AuthorizingAnnotationHandler</code> who processes annotations of the
036     * specified type.  Immediately calls <code>super(annotationClass)</code>.
037     *
038     * @param annotationClass the type of annotation this handler will process.
039     */
040    public AuthorizingAnnotationHandler(Class<? extends Annotation> annotationClass) {
041        super(annotationClass);
042    }
043
044    /**
045     * Ensures the calling Subject is authorized to execute based on the directive(s) found in the given
046     * annotation.
047     * <p/>
048     * As this is an AnnotationMethodInterceptor, the implementations of this method typically inspect the annotation
049     * and perform a corresponding authorization check based.
050     *
051     * @param a the <code>Annotation</code> to check for performing an authorization check.
052     * @throws org.apache.shiro.authz.AuthorizationException if the class/instance/method is not allowed to proceed/execute.
053     */
054    public abstract void assertAuthorized(Annotation a) throws AuthorizationException;
055}