org.springframework.security.web.access.channel.ChannelDecisionManager Maven / Gradle / Ivy
/*
* 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
*
* https://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.springframework.security.web.access.channel;
import java.io.IOException;
import java.util.Collection;
import jakarta.servlet.ServletException;
import org.springframework.security.access.ConfigAttribute;
import org.springframework.security.web.FilterInvocation;
/**
* Decides whether a web channel provides sufficient security.
*
* @author Ben Alex
*/
public interface ChannelDecisionManager {
/**
* Decided whether the presented {@link FilterInvocation} provides the appropriate
* level of channel security based on the requested list of ConfigAttributes.
*
*/
void decide(FilterInvocation invocation, Collection 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
*/
boolean supports(ConfigAttribute attribute);
}