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

Go to download
Show more of this group Show more artifacts with this name
Show all versions of acegi-security
The newest version!
/* 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 meets a specific security condition.
 *
 * 
 * ChannelProcessor implementations are iterated by the {@link
 * ChannelDecisionManagerImpl}.
 * 
 *
 * 
 * If an implementation has an issue with the channel security, they should
 * take action themselves. The callers of the implementation do not take any
 * action.
 * 
 *
 * @author Ben Alex
 * @version $Id: ChannelProcessor.java 1784 2007-02-24 21:00:24Z luke_t $
 */
public interface ChannelProcessor {
    //~ 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!
     */
    void decide(FilterInvocation invocation, ConfigAttributeDefinition config)
        throws IOException, ServletException;

    /**
     * Indicates whether this ChannelProcessor 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 ChannelProcessor can support the passed configuration attribute
     */
    boolean supports(ConfigAttribute attribute);
}