JBoss port of sunxacml 2.0.5

org.jboss.security.xacml.sunxacml
Class PolicyMetaData

java.lang.Object
  extended by org.jboss.security.xacml.sunxacml.PolicyMetaData

public class PolicyMetaData
extends Object

This is used to share polcy meta-data throughout the policy tree. Examples of common meta-data include the version of XACML or XPath being used in a policy.

Since:
2.0
Author:
Seth Proctor

Field Summary
static String XACML_1_0_IDENTIFIER
          XACML 1.0 identifier
static String XACML_2_0_IDENTIFIER
          XACML 2.0 identifier
static int XACML_DEFAULT_VERSION
          The default version of XACML, 1.0, used if no namespace string is specified
static int XACML_VERSION_1_0
          Version identifier for XACML 1.0
static int XACML_VERSION_1_1
          Version identifier for XACML 1.1 (which isn't a formal release so has no namespace string, but still exists as a separate specification)
static int XACML_VERSION_2_0
          Version identifier for XACML 1.2
static String XPATH_1_0_IDENTIFIER
          XPath 1.0 identifier
static int XPATH_VERSION_1_0
          Version identifier for XPath 1.0
static int XPATH_VERSION_UNSPECIFIED
          Version identifier for an unspecified version of XPath
 
Constructor Summary
PolicyMetaData()
          Creates a PolicyMetaData instance with all the parameters set to their default values.
PolicyMetaData(int xacmlVersion, int xpathVersion)
          Creates a PolicyMetaData instance with the given parameters.
PolicyMetaData(int xacmlVersion, int xpathVersion, AttributeFactoryProxy attributeFactoryProxy, CombiningAlgFactoryProxy combiningAlgFactoryProxy, FunctionFactoryProxy functionFactoryProxy)
          Creates a PolicyMetaData instance with the given parameters.
PolicyMetaData(String xacmlVersion, String xpathVersion)
          Creates a PolicyMetaData instance with the given parameters.
PolicyMetaData(String xacmlVersion, String xpathVersion, AttributeFactoryProxy attributeFactoryProxy, CombiningAlgFactoryProxy combiningAlgFactoryProxy, FunctionFactoryProxy functionFactoryProxy)
          Creates a PolicyMetaData instance with the given parameters.
 
Method Summary
 AttributeFactory getAttributeFactory()
          Returns the AttributeFactory used by the associated policy.
 CombiningAlgFactory getCombiningAlgFactory()
          Returns the CombiningAlgFactory used by the associated policy.
 FunctionFactory getConditionFunctionFactory()
          Returns the Condition FunctionFactory used by the associated policy.
 FunctionFactory getGeneralFunctionFactory()
          Returns the General FunctionFactory used by the associated policy.
 FunctionFactory getTargetFunctionFactory()
          Returns the Target FunctionFactory used by the associated policy.
 String getXACMLIdentifier()
          Returns the identifier string for the specified version of XACML.
 int getXACMLVersion()
          Returns which version of XACML is specified in this meta-data.
 String getXPathIdentifier()
          Returns the identifier string for the specified version of XPath, or null if no version is specified.
 int getXPathVersion()
          Returns which version of XPath is specified in this meta-data.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

XACML_1_0_IDENTIFIER

public static final String XACML_1_0_IDENTIFIER
XACML 1.0 identifier

See Also:
Constant Field Values

XACML_2_0_IDENTIFIER

public static final String XACML_2_0_IDENTIFIER
XACML 2.0 identifier

See Also:
Constant Field Values

XACML_VERSION_1_0

public static final int XACML_VERSION_1_0
Version identifier for XACML 1.0

See Also:
Constant Field Values

XACML_VERSION_1_1

public static final int XACML_VERSION_1_1
Version identifier for XACML 1.1 (which isn't a formal release so has no namespace string, but still exists as a separate specification)

See Also:
Constant Field Values

XACML_VERSION_2_0

public static final int XACML_VERSION_2_0
Version identifier for XACML 1.2

See Also:
Constant Field Values

XACML_DEFAULT_VERSION

public static final int XACML_DEFAULT_VERSION
The default version of XACML, 1.0, used if no namespace string is specified

See Also:
Constant Field Values

XPATH_1_0_IDENTIFIER

public static final String XPATH_1_0_IDENTIFIER
XPath 1.0 identifier

See Also:
Constant Field Values

XPATH_VERSION_UNSPECIFIED

public static final int XPATH_VERSION_UNSPECIFIED
Version identifier for an unspecified version of XPath

See Also:
Constant Field Values

XPATH_VERSION_1_0

public static final int XPATH_VERSION_1_0
Version identifier for XPath 1.0

See Also:
Constant Field Values
Constructor Detail

PolicyMetaData

public PolicyMetaData()
Creates a PolicyMetaData instance with all the parameters set to their default values.


PolicyMetaData

public PolicyMetaData(int xacmlVersion,
                      int xpathVersion)
Creates a PolicyMetaData instance with the given parameters. The default factories are assumed.

Parameters:
xacmlVersion - the version of XACML used in a policy
xpathVersion - the XPath version to use in any selectors

PolicyMetaData

public PolicyMetaData(String xacmlVersion,
                      String xpathVersion)
Creates a PolicyMetaData instance with the given parameters. The default factories are assumed.

Parameters:
xacmlVersion - the version of XACML used in a policy
xpathVersion - the XPath version to use in any selectors, or null if this is unspecified (ie, not supplied in the defaults section of the policy)
Throws:
IllegalArgumentException - if the identifier strings are unknown

PolicyMetaData

public PolicyMetaData(int xacmlVersion,
                      int xpathVersion,
                      AttributeFactoryProxy attributeFactoryProxy,
                      CombiningAlgFactoryProxy combiningAlgFactoryProxy,
                      FunctionFactoryProxy functionFactoryProxy)
Creates a PolicyMetaData instance with the given parameters. A proxy value of null implies the default factory.

Parameters:
xacmlVersion - the version of XACML used in a policy
xpathVersion - the XPath version to use in any selectors
attributeFactoryProxy -
combiningAlgFactoryProxy -
functionFactoryProxy -

PolicyMetaData

public PolicyMetaData(String xacmlVersion,
                      String xpathVersion,
                      AttributeFactoryProxy attributeFactoryProxy,
                      CombiningAlgFactoryProxy combiningAlgFactoryProxy,
                      FunctionFactoryProxy functionFactoryProxy)
Creates a PolicyMetaData instance with the given parameters.

Parameters:
xacmlVersion - the version of XACML used in a policy
xpathVersion - the XPath version to use in any selectors, or null if this is unspecified (ie, not supplied in the defaults section of the policy)
-
Throws:
IllegalArgumentException - if the identifier strings are unknown
Method Detail

getXACMLVersion

public int getXACMLVersion()
Returns which version of XACML is specified in this meta-data.

Returns:
the XACML version

getXACMLIdentifier

public String getXACMLIdentifier()
Returns the identifier string for the specified version of XACML.

Returns:
the identifier string

getXPathVersion

public int getXPathVersion()
Returns which version of XPath is specified in this meta-data.

Returns:
the XPath version or null

getXPathIdentifier

public String getXPathIdentifier()
Returns the identifier string for the specified version of XPath, or null if no version is specified.

Returns:
the identifier string or null

getAttributeFactory

public AttributeFactory getAttributeFactory()
Returns the AttributeFactory used by the associated policy.

Returns:
a AttributeFactory

getCombiningAlgFactory

public CombiningAlgFactory getCombiningAlgFactory()
Returns the CombiningAlgFactory used by the associated policy.

Returns:
a CombiningAlgFactory

getTargetFunctionFactory

public FunctionFactory getTargetFunctionFactory()
Returns the Target FunctionFactory used by the associated policy.

Returns:
a FunctionFactory

getConditionFunctionFactory

public FunctionFactory getConditionFunctionFactory()
Returns the Condition FunctionFactory used by the associated policy.

Returns:
a FunctionFactory

getGeneralFunctionFactory

public FunctionFactory getGeneralFunctionFactory()
Returns the General FunctionFactory used by the associated policy.

Returns:
a FunctionFactory

JBoss port of sunxacml 2.0.5

Copyright © 2011 JBoss, a division of Red Hat, Inc.. All Rights Reserved.