org.springframework.security

Class ConfigAttributeDefinition

java.lang.Object

org.springframework.security.ConfigAttributeDefinition

All Implemented Interfaces:

java.io.Serializable

public class ConfigAttributeDefinition
extends java.lang.Object
implements java.io.Serializable

Holds a group of ConfigAttributes that are associated with a given secure object target - effectively a Collection.

Once created, the object is immutable.

All the ConfigAttributeDefinitions associated with a given AbstractSecurityInterceptor are stored in an ObjectDefinitionSource.

Version:

$Id$

Author:

Ben Alex

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static ConfigAttributeDefinition	NO_ATTRIBUTES

Constructor Summary

Constructors

Constructor and Description
ConfigAttributeDefinition(ConfigAttribute attribute) Creates a ConfigAttributeDefinition containing a single attribute.
ConfigAttributeDefinition(java.util.List configAttributes) Creates an immutable ConfigAttributeDefinition from the supplied list of ConfigAttribute objects.
ConfigAttributeDefinition(java.lang.String attribute) Creates a ConfigAttributeDefinition containing a single attribute
ConfigAttributeDefinition(java.lang.String[] attributeTokens) Builds a collection of ConfigAttributes from an array of String tokens, each of which will be wrapped in a SecurityConfig instance.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	contains(ConfigAttribute configAttribute) Indicates whether the specified ConfigAttribute is contained within this ConfigAttributeDefinition.
static ConfigAttributeDefinition	createFiltered(java.util.Collection unfilteredInput) Creates a ConfigAttributeDefinition by including only those attributes which implement ConfigAttribute.
boolean	equals(java.lang.Object obj)
java.util.Collection	getConfigAttributes() Returns the internal collection of ConfigAttributes defined by this ConfigAttributeDefinition.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

NO_ATTRIBUTES

public static final ConfigAttributeDefinition NO_ATTRIBUTES

Constructor Detail

ConfigAttributeDefinition

public ConfigAttributeDefinition(java.lang.String attribute)

Creates a ConfigAttributeDefinition containing a single attribute

Parameters:

attribute - the String name of the attribute (converted internally to a SecurityConfig instance).

ConfigAttributeDefinition

public ConfigAttributeDefinition(ConfigAttribute attribute)

Creates a ConfigAttributeDefinition containing a single attribute.

ConfigAttributeDefinition

public ConfigAttributeDefinition(java.lang.String[] attributeTokens)

Builds a collection of ConfigAttributes from an array of String tokens, each of which will be wrapped in a SecurityConfig instance.

Parameters:

attributeTokens - the tokens which will be turned into attributes.

ConfigAttributeDefinition

public ConfigAttributeDefinition(java.util.List configAttributes)

Creates an immutable ConfigAttributeDefinition from the supplied list of ConfigAttribute objects.

Method Detail

createFiltered

public static ConfigAttributeDefinition createFiltered(java.util.Collection unfilteredInput)

Creates a ConfigAttributeDefinition by including only those attributes which implement ConfigAttribute.

Parameters:

unfilteredInput - a collection of various elements, zero or more which implement ConfigAttribute (can also be null)

Returns:

a ConfigAttributeDefinition if at least one ConfigAttribute was present, or null if none implemented it

contains

public boolean contains(ConfigAttribute configAttribute)

Indicates whether the specified ConfigAttribute is contained within this ConfigAttributeDefinition.

Parameters:

configAttribute - the attribute to locate

Returns:

true if the specified ConfigAttribute is contained, false otherwise

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

getConfigAttributes

public java.util.Collection getConfigAttributes()

Returns the internal collection of ConfigAttributes defined by this ConfigAttributeDefinition.

Allows AccessDecisionManagers and other classes to loop through every configuration attribute associated with a target secure object.

Returns:

the configuration attributes stored in this instance.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object