org.apache.jetspeed.security

Interface SecurityAttributes

public interface SecurityAttributes

Version:

$Id$

Method Summary

Methods

Modifier and Type	Method and Description
SecurityAttribute	getAttribute(String name)
SecurityAttribute	getAttribute(String name, boolean create) Returns an existing (predefined typed) attribute or create one if parameter create is true.
Map<String,SecurityAttribute>	getAttributeMap()
Map<String,SecurityAttribute>	getAttributeMap(String category)
Set<String>	getAttributeNames()
Set<String>	getAttributeNames(String category)
Map<String,SecurityAttribute>	getInfoAttributeMap()
Map<String,String>	getInfoMap()
JetspeedPrincipal	getPrincipal()
SecurityAttributeTypes	getSecurityAttributeTypes()
boolean	isDefinedAttribute(String name)
boolean	isExtendable()
boolean	isReadOnly()
void	removeAttribute(String name)
int	size()

Method Detail

getPrincipal

JetspeedPrincipal getPrincipal()

size

int size()

isReadOnly

boolean isReadOnly()

isExtendable

boolean isExtendable()

getSecurityAttributeTypes

SecurityAttributeTypes getSecurityAttributeTypes()

isDefinedAttribute

boolean isDefinedAttribute(String name)

getAttributeNames

Set<String> getAttributeNames()

getAttributeNames

Set<String> getAttributeNames(String category)

getAttributeMap

Map<String,SecurityAttribute> getAttributeMap()

getAttributeMap

Map<String,SecurityAttribute> getAttributeMap(String category)

getInfoAttributeMap

Map<String,SecurityAttribute> getInfoAttributeMap()

getInfoMap

Map<String,String> getInfoMap()

Returns:

an unmodifiable Map of the SecurityAttributes.INFO_CATEGORY SecurityAttributes

getAttribute

SecurityAttribute getAttribute(String name)

getAttribute

SecurityAttribute getAttribute(String name,
                             boolean create)
                               throws SecurityException

Returns an existing (predefined typed) attribute or create one if parameter create is true. If parameter create is true and it doesn't exist yet it will be created (based upon its SecurityAttributeType) first, but only if the SecurityAttributes itself isn't readOnly (then a AttributesReadOnlyException will be thrown). If parameter create is false and it doesn't exist yet a NULL value will be returned. If there is no SecurityAttributeType defined for the attribute (name), a new attribute with INFO_CATEGORY will be created.

Parameters:

name - name of a predefined SecurityAttributeType (for this JetspeedPrincipal type)

create - add the attribute when it doesn't exist yet

Returns:

an existing attribute or one created on the fly (if parameter create is true)

Throws:

SecurityException

removeAttribute

void removeAttribute(String name)
                     throws SecurityException

Throws:

SecurityException