org.springframework.security.access.AccessDecisionManager 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.access;
import java.util.Collection;
import org.springframework.security.authentication.InsufficientAuthenticationException;
import org.springframework.security.core.Authentication;
/**
* Makes a final access control (authorization) decision.
*
* @author Ben Alex
*/
public interface AccessDecisionManager {
/**
* Resolves an access control decision for the passed parameters.
* @param authentication the caller invoking the method (not null)
* @param object the secured object being called
* @param configAttributes the configuration attributes associated with the secured
* object being invoked
* @throws AccessDeniedException if access is denied as the authentication does not
* hold a required authority or ACL privilege
* @throws InsufficientAuthenticationException if access is denied as the
* authentication does not provide a sufficient level of trust
*/
void decide(Authentication authentication, Object object, Collection configAttributes)
throws AccessDeniedException, InsufficientAuthenticationException;
/**
* Indicates whether this AccessDecisionManager
is able to process
* authorization requests presented with the passed ConfigAttribute
.
*
* This allows the AbstractSecurityInterceptor
to check every
* configuration attribute can be consumed by the configured
* AccessDecisionManager
and/or RunAsManager
and/or
* AfterInvocationManager
.
*
* @param attribute a configuration attribute that has been configured against the
* AbstractSecurityInterceptor
* @return true if this AccessDecisionManager
can support the passed
* configuration attribute
*/
boolean supports(ConfigAttribute attribute);
/**
* Indicates whether the AccessDecisionManager
implementation is able to
* provide access control decisions for the indicated secured object type.
* @param clazz the class that is being queried
* @return true
if the implementation can process the indicated class
*/
boolean supports(Class clazz);
}