org.acegisecurity.intercept.InterceptorStatusToken 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;

import org.acegisecurity.Authentication;
import org.acegisecurity.ConfigAttributeDefinition;


/**
 * A return object received by {@link AbstractSecurityInterceptor} subclasses.
 * 
 * 
 * This class reflects the status of the security interception, so that the
 * final call to {@link
 * org.acegisecurity.intercept.AbstractSecurityInterceptor#afterInvocation(InterceptorStatusToken,
 * Object)} can tidy up correctly.
 * 
 *
 * @author Ben Alex
 * @version $Id: InterceptorStatusToken.java,v 1.3 2005/11/17 00:55:51 benalex Exp $
 */
public class InterceptorStatusToken {
    //~ Instance fields ========================================================

    private Authentication authentication;
    private ConfigAttributeDefinition attr;
    private Object secureObject;
    private boolean contextHolderRefreshRequired;

    //~ Constructors ===========================================================

    public InterceptorStatusToken(Authentication authentication,
        boolean contextHolderRefreshRequired, ConfigAttributeDefinition attr,
        Object secureObject) {
        this.authentication = authentication;
        this.contextHolderRefreshRequired = contextHolderRefreshRequired;
        this.attr = attr;
        this.secureObject = secureObject;
    }

    protected InterceptorStatusToken() {
        throw new IllegalArgumentException("Cannot use default constructor");
    }

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

    public ConfigAttributeDefinition getAttr() {
        return attr;
    }

    public Authentication getAuthentication() {
        return authentication;
    }

    public boolean isContextHolderRefreshRequired() {
        return contextHolderRefreshRequired;
    }

    public Object getSecureObject() {
        return secureObject;
    }
}