de.fzj.unicore.uas.security.util
Class AttributeSourcesChain

java.lang.Object
  de.fzj.unicore.uas.security.util.AttributeSourcesChain

All Implemented Interfaces:

IAttributeSource

public class AttributeSourcesChain
extends java.lang.Object
implements IAttributeSource

IAttributeSource implementation that combines the results from a chain of attribute sources using a configurable combining policy:

• FIRST_APPLICABLE: the first source returning any result is used
• FIRST_ACCESSIBLE: the first accessible (i.e. not throwing an exception) source is used
• MERGE_LAST_OVERRIDES (default): all results are combined, so that the later attribute sources in the chain can override earlier ones
• MERGE : all results are combined, and attributes of the same name are merged

Author:

schuller, golbi

Nested Class Summary

static interface	AttributeSourcesChain.CombiningPolicy defines how attributes should be combined
static class	AttributeSourcesChain.FirstAccessible first accessible: the answer from the first accessible attribute source is used.
static class	AttributeSourcesChain.FirstApplicable first applicable: only the first map of attributes is used
static class	AttributeSourcesChain.Merge merge: attributes with the same key are combined
static class	AttributeSourcesChain.MergeLastOverrides merge_last_overrides: new attributes overwrite existing ones

Field Summary

Fields inherited from interface de.fzj.unicore.uas.security.IAttributeSource

ATTRIBUTE_ADD_DEFAULT_GROUPS, ATTRIBUTE_GROUP, ATTRIBUTE_QUEUES, ATTRIBUTE_ROLE, ATTRIBUTE_SUPPLEMENTARY_GROUPS, ATTRIBUTE_XLOGIN, ROLE_ADMIN, ROLE_ANONYMOUS, ROLE_TRUSTED_AGENT, SAML_ATTRIBUTE_REQUEST_NAMEFORMAT

Constructor Summary

AttributeSourcesChain()

Method Summary

java.util.Map<java.lang.String,java.lang.String[]>	getAttributes(eu.unicore.security.xfireutil.SecurityTokens tokens, java.util.Map<java.lang.String,java.lang.String[]> unused) combines results from all configured attribute sources
java.util.List<IAttributeSource>	getChain()
AttributeSourcesChain.CombiningPolicy	getCombiningPolicy()
java.lang.String	getName() This method should return name of this attribute source, which was passed to the init() method.
java.lang.String	getStatusDescription() Get a user-friendly description of the attribute source's status.
void	init(java.lang.String name) will initialise all the authorisers in the chain by calling their init() method
void	setCombiningPolicy(java.lang.String name)
void	setLegacyOrder(java.lang.String order)
void	setOrder(java.lang.String order)
void	setProperties(java.util.Properties p)

Methods inherited from class java.lang.Object

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

Constructor Detail

AttributeSourcesChain

public AttributeSourcesChain()

Method Detail

init

public void init(java.lang.String name)
          throws java.lang.Exception

will initialise all the authorisers in the chain by calling their init() method

Specified by:

init in interface IAttributeSource

Throws:

java.lang.Exception

getAttributes

public java.util.Map<java.lang.String,java.lang.String[]> getAttributes(eu.unicore.security.xfireutil.SecurityTokens tokens,
                                                                        java.util.Map<java.lang.String,java.lang.String[]> unused)
                                                                 throws java.io.IOException,
                                                                        AuthorisationException

combines results from all configured attribute sources

Specified by:

getAttributes in interface IAttributeSource

Parameters:

tokens - - security tokens for this request

unused - - attributes returned by other authorisers, which may be null

Returns:

authorisation attributes, i.e. a mapping of attribute names to lists of values

Throws:

java.io.IOException - in case of technical problems

AuthorisationException

getStatusDescription

public java.lang.String getStatusDescription()

Description copied from interface: IAttributeSource

Get a user-friendly description of the attribute source's status.
This is used for informing the administrator of any problems with configuration, connection problems, etc. UNICORE/X will print a log entry describing the status immediately after startup.
This method should not block for too long, since the server startup would be stalled in this case. For example, you may use the TimeoutRunner class to avoid blocking.

Specified by:

getStatusDescription in interface IAttributeSource

Returns:

a String describing this attribute source's status.

getChain

public java.util.List<IAttributeSource> getChain()

getCombiningPolicy

public AttributeSourcesChain.CombiningPolicy getCombiningPolicy()

setProperties

public void setProperties(java.util.Properties p)

setOrder

public void setOrder(java.lang.String order)

setCombiningPolicy

public void setCombiningPolicy(java.lang.String name)

setLegacyOrder

public void setLegacyOrder(java.lang.String order)

getName

public java.lang.String getName()

Description copied from interface: IAttributeSource

This method should return name of this attribute source, which was passed to the init() method.

Specified by:

getName in interface IAttributeSource

Returns: