org.springframework.security.web.access.WebInvocationPrivilegeEvaluator 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;
import org.springframework.security.core.Authentication;
/**
* Allows users to determine whether they have privileges for a given web URI.
*
* @author Luke Taylor
* @since 3.0
*/
public interface WebInvocationPrivilegeEvaluator {
/**
* Determines whether the user represented by the supplied Authentication
* object is allowed to invoke the supplied URI.
* @param uri the URI excluding the context path (a default context path setting will
* be used)
*/
boolean isAllowed(String uri, Authentication authentication);
/**
* Determines whether the user represented by the supplied Authentication
* object is allowed to invoke the supplied URI, with the given .
*
* Note the default implementation of FilterInvocationSecurityMetadataSource
* disregards the contextPath when evaluating which secure object
* metadata applies to a given request URI, so generally the contextPath
* is unimportant unless you are using a custom
* FilterInvocationSecurityMetadataSource.
* @param uri the URI excluding the context path
* @param contextPath the context path (may be null).
* @param method the HTTP method (or null, for any method)
* @param authentication the Authentication instance whose authorities should
* be used in evaluation whether access should be granted.
* @return true if access is allowed, false if denied
*/
boolean isAllowed(String contextPath, String uri, String method, Authentication authentication);
}