org.acegisecurity.securechannel.ChannelDecisionManager Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of acegi-security Show documentation

There is a newer version: 1.0.7

/* Copyright 2004, 2005, 2006 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.securechannel;

import org.acegisecurity.ConfigAttribute;
import org.acegisecurity.ConfigAttributeDefinition;

import org.acegisecurity.intercept.web.FilterInvocation;

import java.io.IOException;

import javax.servlet.ServletException;


/**
 * Decides whether a web channel provides sufficient security.
 * 
 * @author Ben Alex
 * @version $Id: ChannelDecisionManager.java 1519 2006-05-29 15:06:32Z benalex $
 */
public interface ChannelDecisionManager {
    //~ Methods ========================================================================================================

    /**
     * Decided whether the presented {@link FilterInvocation} provides the appropriate level of channel
     * security based on the requested {@link ConfigAttributeDefinition}.
     *
     * @param invocation DOCUMENT ME!
     * @param config DOCUMENT ME!
     *
     * @throws IOException DOCUMENT ME!
     * @throws ServletException DOCUMENT ME!
     */
    public void decide(FilterInvocation invocation, ConfigAttributeDefinition config)
        throws IOException, ServletException;

    /**
     * Indicates whether this ChannelDecisionManager is able to process the passed
     * ConfigAttribute.This allows the ChannelProcessingFilter to check every
     * configuration attribute can be consumed by the configured ChannelDecisionManager.
     *
     * @param attribute a configuration attribute that has been configured against the
     *        ChannelProcessingFilter
     *
     * @return true if this ChannelDecisionManager can support the passed configuration attribute
     */
    public boolean supports(ConfigAttribute attribute);
}