org.wso2.balana

Class PolicyMetaData

java.lang.Object

org.wso2.balana.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

Fields

Modifier and Type	Field and Description
static int	XACML_DEFAULT_VERSION The default version of XACML, 1.0, used if no namespace string is specified
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

Constructors

Constructor and Description
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(String xacmlVersion, String xpathVersion) Creates a PolicyMetaData instance with the given parameters.

Method Summary

Modifier and Type	Method and Description
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_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. 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

PolicyMetaData

public PolicyMetaData(String xacmlVersion,
                      String xpathVersion)

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) the XACML policy, if null use default factories

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