org.acegisecurity.intercept.method.aspectj.AspectJSecurityInterceptor Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of acegi-security
There is a newer version: 1.0.7
/* Copyright 2004 Acegi Technology Pty Limited
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.acegisecurity.intercept.method.aspectj;

import org.acegisecurity.intercept.AbstractSecurityInterceptor;
import org.acegisecurity.intercept.InterceptorStatusToken;
import org.acegisecurity.intercept.ObjectDefinitionSource;
import org.acegisecurity.intercept.method.MethodDefinitionSource;

import org.aspectj.lang.JoinPoint;


/**
 * Provides security interception of AspectJ method invocations.
 * 
 * 
 * The ObjectDefinitionSource required by this security
 * interceptor is of type {@link MethodDefinitionSource}. This is shared with
 * the AOP Alliance based security interceptor
 * (MethodSecurityInterceptor),  since both work with Java
 * Methods.
 * 
 * 
 * 
 * The secure object type is org.aspectj.lang.JoinPoint, which is
 * passed from the relevant around() advice. The
 * around() advice also passes an anonymous implementation of
 * {@link AspectJCallback} which contains the call for AspectJ to continue
 * processing:  return proceed();.
 * 
 * 
 * 
 * Refer to {@link AbstractSecurityInterceptor} for details on the workflow.
 * 
 *
 * @author Ben Alex
 * @version $Id: AspectJSecurityInterceptor.java,v 1.3 2005/11/17 00:56:48 benalex Exp $
 */
public class AspectJSecurityInterceptor extends AbstractSecurityInterceptor {
    //~ Instance fields ========================================================

    private MethodDefinitionSource objectDefinitionSource;

    //~ Methods ================================================================

    public void setObjectDefinitionSource(MethodDefinitionSource newSource) {
        this.objectDefinitionSource = newSource;
    }

    public MethodDefinitionSource getObjectDefinitionSource() {
        return this.objectDefinitionSource;
    }

    public Class getSecureObjectClass() {
        return JoinPoint.class;
    }

    /**
     * This method should be used to enforce security on a
     * JoinPoint.
     *
     * @param jp The AspectJ joint point being invoked which requires a
     *        security decision
     * @param advisorProceed the advice-defined anonymous class that implements
     *        AspectJCallback containing a simple return
     *        proceed(); statement
     *
     * @return The returned value from the method invocation
     */
    public Object invoke(JoinPoint jp, AspectJCallback advisorProceed) {
        Object result = null;
        InterceptorStatusToken token = super.beforeInvocation(jp);

        try {
            result = advisorProceed.proceedWithObject();
        } finally {
            result = super.afterInvocation(token, result);
        }

        return result;
    }

    public ObjectDefinitionSource obtainObjectDefinitionSource() {
        return this.objectDefinitionSource;
    }
}