org.fcrepo.server.security.xacml.pdp.data

Class PolicyIndexBase

java.lang.Object

org.fcrepo.server.security.xacml.pdp.data.PolicyIndexBase

All Implemented Interfaces:

PolicyIndex

Direct Known Subclasses:

XPathPolicyIndex

public abstract class PolicyIndexBase
extends java.lang.Object
implements PolicyIndex

Base abstract class for all PolicyIndex implementations. Gets the index configuration common to all implementations.

Version:

$Id$

Author:

Stephen Bayliss

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.String	ACTION_KEY
protected static java.lang.String	ENVIRONMENT_KEY
boolean	indexed
protected java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.String>>	indexMap
protected PolicyReader	m_policyReader
protected static java.lang.String	METADATA_POLICY_NS
static java.util.Map<java.lang.String,java.lang.String>	namespaces
protected static java.lang.String	RESOURCE_KEY
protected static java.net.URI	SUBJECT_CATEGORY_DEFAULT
protected static java.lang.String	SUBJECT_KEY

Fields inherited from interface org.fcrepo.server.security.xacml.pdp.data.PolicyIndex

XACML_RESOURCE_ID, XACML20_POLICY_NS

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	PolicyIndexBase(PolicyReader policyReader)

Method Summary

Methods

Modifier and Type	Method and Description
protected java.util.Map<java.lang.String,java.util.Collection<AttributeBean>>	getAttributeMap(org.jboss.security.xacml.sunxacml.EvaluationCtx eval) This method extracts the attributes listed in the indexMap from the given evaluation context.
protected org.jboss.security.xacml.sunxacml.AbstractPolicy	handleDocument(org.w3c.dom.Document doc, org.jboss.security.xacml.sunxacml.finder.PolicyFinder policyFinder) A private method that handles reading the policy and creates the correct kind of AbstractPolicy.
protected static java.lang.String[]	makeComponents(java.lang.String resourceId) Splits a XACML hierarchical resource-id value into a set of resource-id values that can be matched against a policy.
void	setActionAttributes(java.util.Map<java.lang.String,java.lang.String> attributeMap)
protected void	setAttributeMap(java.lang.String mapKey, java.util.Map<java.lang.String,java.lang.String> attributeMap)
void	setEnvironmentAttributes(java.util.Map<java.lang.String,java.lang.String> attributeMap)
void	setResourceAttributes(java.util.Map<java.lang.String,java.lang.String> attributeMap)
void	setSubjectAttributes(java.util.Map<java.lang.String,java.lang.String> attributeMap)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.fcrepo.server.security.xacml.pdp.data.PolicyIndex

addPolicy, clear, contains, deletePolicy, getPolicies, getPolicy, updatePolicy

Field Detail

SUBJECT_KEY

protected static final java.lang.String SUBJECT_KEY

See Also:

Constant Field Values

RESOURCE_KEY

protected static final java.lang.String RESOURCE_KEY

See Also:

Constant Field Values

ACTION_KEY

protected static final java.lang.String ACTION_KEY

See Also:

Constant Field Values

ENVIRONMENT_KEY

protected static final java.lang.String ENVIRONMENT_KEY

See Also:

Constant Field Values

SUBJECT_CATEGORY_DEFAULT

protected static final java.net.URI SUBJECT_CATEGORY_DEFAULT

indexed

public boolean indexed

indexMap

protected java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.String>> indexMap

m_policyReader

protected PolicyReader m_policyReader

METADATA_POLICY_NS

protected static final java.lang.String METADATA_POLICY_NS

See Also:

Constant Field Values

namespaces

public static final java.util.Map<java.lang.String,java.lang.String> namespaces

Constructor Detail

PolicyIndexBase

protected PolicyIndexBase(PolicyReader policyReader)
                   throws PolicyIndexException

Throws:

PolicyIndexException

Method Detail

setSubjectAttributes

public void setSubjectAttributes(java.util.Map<java.lang.String,java.lang.String> attributeMap)

setResourceAttributes

public void setResourceAttributes(java.util.Map<java.lang.String,java.lang.String> attributeMap)

setActionAttributes

public void setActionAttributes(java.util.Map<java.lang.String,java.lang.String> attributeMap)

setEnvironmentAttributes

public void setEnvironmentAttributes(java.util.Map<java.lang.String,java.lang.String> attributeMap)

setAttributeMap

protected void setAttributeMap(java.lang.String mapKey,
                   java.util.Map<java.lang.String,java.lang.String> attributeMap)

getAttributeMap

protected java.util.Map<java.lang.String,java.util.Collection<AttributeBean>> getAttributeMap(org.jboss.security.xacml.sunxacml.EvaluationCtx eval)
                                                                                       throws java.net.URISyntaxException

This method extracts the attributes listed in the indexMap from the given evaluation context.

Parameters:

eval - the Evaluation Context from which to extract Attributes

Returns:

a Map of Attributes for each category (Subject, Resource, Action, Environment)

Throws:

java.net.URISyntaxException

handleDocument

protected org.jboss.security.xacml.sunxacml.AbstractPolicy handleDocument(org.w3c.dom.Document doc,
                                                              org.jboss.security.xacml.sunxacml.finder.PolicyFinder policyFinder)
                                                                   throws org.jboss.security.xacml.sunxacml.ParsingException

A private method that handles reading the policy and creates the correct kind of AbstractPolicy. Because this makes use of the policyFinder, it cannot be reused between finders. Consider moving to policyManager, which is not intended to be reused outside of a policyFinderModule, which is not intended to be reused amongst PolicyFinder instances.

Throws:

org.jboss.security.xacml.sunxacml.ParsingException

makeComponents

protected static java.lang.String[] makeComponents(java.lang.String resourceId)

Splits a XACML hierarchical resource-id value into a set of resource-id values that can be matched against a policy. Eg an incoming request for /res1/res2/res3/.* should match /res1/.* /res1/res2/.* /res1/res2/res3/.* in policies.

Parameters:

resourceId - XACML hierarchical resource-id value

Returns:

array of individual resource-id values that can be used to match against policies