org.springframework.security.web.access.expression
Class WebExpressionVoter

java.lang.Object
  extended by org.springframework.security.web.access.expression.WebExpressionVoter
All Implemented Interfaces:
AccessDecisionVoter

public class WebExpressionVoter
extends Object
implements AccessDecisionVoter

Voter which handles web authorisation decisions.

Since:
3.0
Version:
$Id: WebExpressionVoter.java 3927 2009-10-06 19:46:44Z ltaylor $
Author:
Luke Taylor

Field Summary
 
Fields inherited from interface org.springframework.security.access.AccessDecisionVoter
ACCESS_ABSTAIN, ACCESS_DENIED, ACCESS_GRANTED
 
Constructor Summary
WebExpressionVoter()
           
 
Method Summary
 void setExpressionHandler(WebSecurityExpressionHandler expressionHandler)
           
 boolean supports(Class<?> clazz)
          Indicates whether the AccessDecisionVoter implementation is able to provide access control votes for the indicated secured object type.
 boolean supports(ConfigAttribute attribute)
          Indicates whether this AccessDecisionVoter is able to vote on the passed ConfigAttribute.
 int vote(Authentication authentication, Object object, Collection<ConfigAttribute> attributes)
          Indicates whether or not access is granted.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

WebExpressionVoter

public WebExpressionVoter()
Method Detail

vote

public int vote(Authentication authentication,
                Object object,
                Collection<ConfigAttribute> attributes)
Description copied from interface: AccessDecisionVoter
Indicates whether or not access is granted.

The decision must be affirmative (ACCESS_GRANTED), negative (ACCESS_DENIED) or the AccessDecisionVoter can abstain (ACCESS_ABSTAIN) from voting. Under no circumstances should implementing classes return any other value. If a weighting of results is desired, this should be handled in a custom AccessDecisionManager instead.

Unless an AccessDecisionVoter is specifically intended to vote on an access control decision due to a passed method invocation or configuration attribute parameter, it must return ACCESS_ABSTAIN. This prevents the coordinating AccessDecisionManager from counting votes from those AccessDecisionVoters without a legitimate interest in the access control decision.

Whilst the method invocation is passed as a parameter to maximise flexibility in making access control decisions, implementing classes must never modify the behaviour of the method invocation (such as calling MethodInvocation.proceed()).

Specified by:
vote in interface AccessDecisionVoter
Parameters:
authentication - the caller invoking the method
object - the secured object
attributes - the configuration attributes associated with the method being invoked
Returns:
either AccessDecisionVoter.ACCESS_GRANTED, AccessDecisionVoter.ACCESS_ABSTAIN or AccessDecisionVoter.ACCESS_DENIED

supports

public boolean supports(ConfigAttribute attribute)
Description copied from interface: AccessDecisionVoter
Indicates whether this AccessDecisionVoter is able to vote on 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.

Specified by:
supports in interface AccessDecisionVoter
Parameters:
attribute - a configuration attribute that has been configured against the AbstractSecurityInterceptor
Returns:
true if this AccessDecisionVoter can support the passed configuration attribute

supports

public boolean supports(Class<?> clazz)
Description copied from interface: AccessDecisionVoter
Indicates whether the AccessDecisionVoter implementation is able to provide access control votes for the indicated secured object type.

Specified by:
supports in interface AccessDecisionVoter
Parameters:
clazz - the class that is being queried
Returns:
true if the implementation can process the indicated class

setExpressionHandler

public void setExpressionHandler(WebSecurityExpressionHandler expressionHandler)


Copyright © 2004-2009 SpringSource, Inc. All Rights Reserved.