public class PolicySet extends AbstractPolicy
metaData
Constructor and Description |
---|
PolicySet(URI id,
PolicyCombiningAlgorithm combiningAlg,
AbstractTarget target)
Creates a new
PolicySet with only the required elements. |
PolicySet(URI id,
PolicyCombiningAlgorithm combiningAlg,
AbstractTarget target,
List policies)
Creates a new
PolicySet with only the required elements, plus some policies. |
PolicySet(URI id,
String version,
PolicyCombiningAlgorithm combiningAlg,
String description,
AbstractTarget target,
List policies)
Creates a new
PolicySet with the required elements plus some policies and a
String description. |
PolicySet(URI id,
String version,
PolicyCombiningAlgorithm combiningAlg,
String description,
AbstractTarget target,
List<AbstractPolicy> policies,
String defaultVersion,
Set<AbstractObligation> obligations)
Creates a new
PolicySet with the required elements plus some policies, a String
description, policy defaults, and obligations. |
PolicySet(URI id,
String version,
PolicyCombiningAlgorithm combiningAlg,
String description,
AbstractTarget target,
List policies,
String defaultVersion)
Creates a new
PolicySet with the required elements plus some policies, a String
description, and policy defaults. |
PolicySet(URI id,
String version,
PolicyCombiningAlgorithm combiningAlg,
String description,
AbstractTarget target,
List policyElements,
String defaultVersion,
Set<AbstractObligation> obligations,
List<CombinerParameter> parameters)
Creates a new
PolicySet with the required and optional elements. |
Modifier and Type | Method and Description |
---|---|
String |
encode()
Encodes this
PolicySet into its XML form |
void |
encode(StringBuilder builder)
Encodes this
PolicySet into its XML form and writes this out to the provided
StringBuilder |
static PolicySet |
getInstance(Node root)
Creates an instance of a
PolicySet object based on a DOM node. |
static PolicySet |
getInstance(Node root,
PolicyFinder finder)
Creates an instance of a
PolicySet object based on a DOM node. |
encodeCommonElements, evaluate, getActionPolicyValue, getAdviceExpressions, getChildElements, getChildren, getCombiningAlg, getCombiningParameters, getDefaultVersion, getDescription, getEnvPolicyValue, getId, getMetaData, getObligationExpressions, getResourcePolicyValue, getSubjectPolicyValue, getTarget, getVersion, match, setActionPolicyValue, setChildren, setEnvPolicyValue, setResourcePolicyValue, setSubjectPolicyValue
public PolicySet(URI id, PolicyCombiningAlgorithm combiningAlg, AbstractTarget target)
PolicySet
with only the required elements.id
- the policy set identifiercombiningAlg
- the CombiningAlgorithm
used on the policies in this settarget
- the AbstractTarget
for this setpublic PolicySet(URI id, PolicyCombiningAlgorithm combiningAlg, AbstractTarget target, List policies)
PolicySet
with only the required elements, plus some policies.id
- the policy set identifiercombiningAlg
- the CombiningAlgorithm
used on the policies in this settarget
- the AbstractTarget
for this setpolicies
- a list of AbstractPolicy
objectsIllegalArgumentException
- if the List
of policies contains an object that
is not an AbstractPolicy
public PolicySet(URI id, String version, PolicyCombiningAlgorithm combiningAlg, String description, AbstractTarget target, List policies)
PolicySet
with the required elements plus some policies and a
String description.id
- the policy set identifierversion
- the policy version or null for the default (this is always null for pre-2.0
policies)combiningAlg
- the CombiningAlgorithm
used on the policies in this setdescription
- a String
describing the policytarget
- the AbstractTarget
for this setpolicies
- a list of AbstractPolicy
objectsIllegalArgumentException
- if the List
of policies contains an object that
is not an AbstractPolicy
public PolicySet(URI id, String version, PolicyCombiningAlgorithm combiningAlg, String description, AbstractTarget target, List policies, String defaultVersion)
PolicySet
with the required elements plus some policies, a String
description, and policy defaults.id
- the policy set identifierversion
- the policy version or null for the default (this is always null for pre-2.0
policies)combiningAlg
- the CombiningAlgorithm
used on the policies in this setdescription
- a String
describing the policytarget
- the AbstractTarget
for this setpolicies
- a list of AbstractPolicy
objectsdefaultVersion
- the XPath version to useIllegalArgumentException
- if the List
of policies contains an object that
is not an AbstractPolicy
public PolicySet(URI id, String version, PolicyCombiningAlgorithm combiningAlg, String description, AbstractTarget target, List<AbstractPolicy> policies, String defaultVersion, Set<AbstractObligation> obligations)
PolicySet
with the required elements plus some policies, a String
description, policy defaults, and obligations.id
- the policy set identifierversion
- the policy version or null for the default (this is always null for pre-2.0
policies)combiningAlg
- the CombiningAlgorithm
used on the policies in this setdescription
- a String
describing the policytarget
- the AbstractTarget
for this setpolicies
- a list of AbstractPolicy
objectsdefaultVersion
- the XPath version to useobligations
- a set of Obligation
objectsIllegalArgumentException
- if the List
of policies contains an object that
is not an AbstractPolicy
public PolicySet(URI id, String version, PolicyCombiningAlgorithm combiningAlg, String description, AbstractTarget target, List policyElements, String defaultVersion, Set<AbstractObligation> obligations, List<CombinerParameter> parameters)
PolicySet
with the required and optional elements. If you need to
provide combining algorithm parameters, you need to use this constructor. Note that unlike
the other constructors in this class, the policies list is actually a list of
CombinerElement
s used to match a policy with any combiner parameters it may
have.id
- the policy set identifierversion
- the policy version or null for the default (this is always null for pre-2.0
policies)combiningAlg
- the CombiningAlgorithm
used on the rules in this setdescription
- a String
describing the policy or null if there is no
descriptiontarget
- the AbstractTarget
for this policypolicyElements
- a list of CombinerElement
objects or null if there are no
policiesdefaultVersion
- the XPath version to use or null if there is no default versionobligations
- a set of Obligations
objects or null if there are no
obligationsparameters
- the List
of CombinerParameter
s provided for
general use by the combining algorithmIllegalArgumentException
- if the List
of rules contains an object that is
not a Rule
public static PolicySet getInstance(Node root) throws ParsingException
PolicySet
object based on a DOM node. The node must be
the root of PolicySetType XML object, otherwise an exception is thrown. This
PolicySet
will not support references because it has no
PolicyFinder
.root
- the DOM root of a PolicySetType XML typePolicySet
objectParsingException
- if the PolicySetType is invalidpublic static PolicySet getInstance(Node root, PolicyFinder finder) throws ParsingException
PolicySet
object based on a DOM node. The node must be
the root of PolicySetType XML object, otherwise an exception is thrown. The finder is used to
handle policy references.root
- the DOM root of a PolicySetType XML typefinder
- the PolicyFinder
used to handle referencesPolicySet
objectParsingException
- if the PolicySetType is invalidpublic String encode()
PolicySet
into its XML formString
public void encode(StringBuilder builder)
PolicySet
into its XML form and writes this out to the provided
StringBuilder
builder
- string stream into which the XML-encoded data is writtenCopyright © 2016 WSO2. All rights reserved.