org.springframework.security.messaging.access.intercept

Class DefaultMessageSecurityMetadataSource

java.lang.Object

org.springframework.security.messaging.access.intercept.DefaultMessageSecurityMetadataSource

All Implemented Interfaces:

org.springframework.aop.framework.AopInfrastructureBean, SecurityMetadataSource, MessageSecurityMetadataSource

public final class DefaultMessageSecurityMetadataSource
extends java.lang.Object
implements MessageSecurityMetadataSource

A default implementation of MessageSecurityMetadataSource that looks up the ConfigAttribute instances using a MessageMatcher.

Each entry is considered in order. The first entry that matches, the corresponding Collection<ConfigAttribute> is returned.

Since:

4.0

See Also:

ChannelSecurityInterceptor, ExpressionBasedMessageSecurityMetadataSourceFactory

Constructor Summary

Constructors

Constructor and Description
DefaultMessageSecurityMetadataSource(java.util.LinkedHashMap<MessageMatcher<?>,java.util.Collection<ConfigAttribute>> messageMap)

Method Summary

Modifier and Type	Method and Description
java.util.Collection<ConfigAttribute>	getAllConfigAttributes() If available, returns all of the ConfigAttributes defined by the implementing class.
java.util.Collection<ConfigAttribute>	getAttributes(java.lang.Object object) Accesses the ConfigAttributes that apply to a given secure object.
boolean	supports(java.lang.Class<?> clazz) Indicates whether the SecurityMetadataSource implementation is able to provide ConfigAttributes for the indicated secure object type.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DefaultMessageSecurityMetadataSource

public DefaultMessageSecurityMetadataSource(java.util.LinkedHashMap<MessageMatcher<?>,java.util.Collection<ConfigAttribute>> messageMap)

Method Detail

getAttributes

public java.util.Collection<ConfigAttribute> getAttributes(java.lang.Object object)
                                                    throws java.lang.IllegalArgumentException

Description copied from interface: SecurityMetadataSource

Accesses the ConfigAttributes that apply to a given secure object.

Specified by:

getAttributes in interface SecurityMetadataSource

Parameters:

object - the object being secured

Returns:

the attributes that apply to the passed in secured object. Should return an empty collection if there are no applicable attributes.

Throws:

java.lang.IllegalArgumentException - if the passed object is not of a type supported by the SecurityMetadataSource implementation

getAllConfigAttributes

public java.util.Collection<ConfigAttribute> getAllConfigAttributes()

Description copied from interface: SecurityMetadataSource

If available, returns all of the ConfigAttributes defined by the implementing class.

This is used by the AbstractSecurityInterceptor to perform startup time validation of each ConfigAttribute configured against it.

Specified by:

getAllConfigAttributes in interface SecurityMetadataSource

Returns:

the ConfigAttributes or null if unsupported

supports

public boolean supports(java.lang.Class<?> clazz)

Description copied from interface: SecurityMetadataSource

Indicates whether the SecurityMetadataSource implementation is able to provide ConfigAttributes for the indicated secure object type.

Specified by:

supports in interface SecurityMetadataSource

Parameters:

clazz - the class that is being queried

Returns:

true if the implementation can process the indicated class