public class RoleVoter extends Object implements AccessDecisionVoter<Object>
ConfigAttribute.getAttribute()starts with a prefix indicating that it is a role. The default prefix string is
ROLE_, but this may be overridden to any value. It may also be set to empty, which means that essentially any attribute will be voted on. As described further below, the effect of an empty prefix may not be quite desirable.
Abstains from voting if no configuration attribute commences with the role
prefix. Votes to grant access if there is an exact matching
GrantedAuthority to a
starting with the role prefix. Votes to deny access if there is no exact
GrantedAuthority to a
starting with the role prefix.
An empty role prefix means that the voter will vote for every
ConfigAttribute. When there are different categories of ConfigAttributes
used, this will not be optimal since the voter will be voting for attributes
which do not represent roles. However, this option may be of some use when
using pre-existing role names without a prefix, and no ability exists to
prefix them with a role prefix on reading them in, such as provided for
All comparisons and prefixes are case sensitive.
|Constructor and Description|
|Modifier and Type||Method and Description|
Allows the default role prefix of
This implementation supports any type of class, because it does not query the presented secure object.
Indicates whether this
Indicates whether or not access is granted.
public String getRolePrefix()
public void setRolePrefix(String rolePrefix)
ROLE_to be overridden. May be set to an empty value, although this is usually not desirable.
rolePrefix- the new prefix
public boolean supports(ConfigAttribute attribute)
AccessDecisionVoteris able to vote on the passed
This allows the
AbstractSecurityInterceptor to check every configuration attribute can be consumed by
public boolean supports(Class<?> clazz)
public int vote(Authentication authentication, Object object, Collection<ConfigAttribute> attributes)
The decision must be affirmative (
ACCESS_GRANTED), negative (
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
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
Whilst the secured object (such as a
MethodInvocation) is passed as a parameter to maximise flexibility
in making access control decisions, implementing classes should not modify it or cause the represented invocation
to take place (for example, by calling
authentication- the caller making the invocation
object- the secured object being invoked
attributes- the configuration attributes associated with the secured object