complexType "tns:StaticPolicyProvider"
Namespace:
http://authzforce.github.io/core/xmlns/pdp/7
Content:
complex, 2 attributes, 1 element
Defined:
globally in pdp.xsd; see XML source
Includes:
definitions of 1 attribute, 1 element
Used:
never
Component Diagram
XML Representation Summary
<...
   
id
 = 
xs:ID
ignoreOldVersions
 = 
xs:boolean : "false"
   
>
   
Content: 
tns:policyLocation+
</...>
Content Model Elements (1):
tns:policyLocation
Annotation

Policy(Set) Provider loading policies statically from URLs. Any PolicyIdReference used in a PolicySet here must refer to a Policy loaded here as well. Besides, a PolicySet P1 must be loaded before any other PolicySet P2 with a reference (PolicySetIdReference) to P1. As PolicySets are loaded in the order of declaration of policyLocations, the order matters for PolicySetIdReference resolution. This PolicyProvider implements the PolicyProvider#getCandidateRootPolicy() - the method provides a default root policy to be used when the PDP's configuration parameter rootPolicyRef is undefined - as follows:

Type Definition Detail
Type Derivation Tree
authz-ext:AbstractPdpExtension (extension)
  authz-ext:AbstractPolicyProvider (extension)
      tns:StaticPolicyProvider
XML Source (w/o annotations (3); see within schema source)
<xs:complexType name="StaticPolicyProvider">
<xs:complexContent>
<xs:extension base="authz-ext:AbstractPolicyProvider">
<xs:sequence>
<xs:element maxOccurs="unbounded" minOccurs="1" name="policyLocation" type="xs:anyURI"/>
</xs:sequence>
<xs:attribute default="false" name="ignoreOldVersions" type="xs:boolean" use="optional"/>
</xs:extension>
</xs:complexContent>
</xs:complexType>
Attribute Detail (all declarations; defined within this component only; 1/2)
ignoreOldVersions
Type:
xs:boolean, predefined
Use:
optional
true iff all versions of any policy must be ignored except the last, i.e. whenever there are multiple versions for the same policy ID, do as if only the last one exists.
Attribute Value
Default:
"false"
XML Source (w/o annotations (1); see within schema source)
<xs:attribute default="false" name="ignoreOldVersions" type="xs:boolean" use="optional"/>
Content Element Detail (all declarations; defined within this component only; 1/1)
tns:policyLocation
Type:
xs:anyURI, predefined, simple content

Location of the XML file that is expected to contain the Policy or PolicySet element to be referenced by a Policy(Set)IdReference in the root PolicySet loaded by a root policy Provider. The location may also be a file pattern in the form file://DIRECTORY_PATH/*SUFFIX or file://DIRECTORY_PATH/**...*SUFFIX, etc. (arbitrarily long sequence of wildcard characters) in which case the location is expanded to all regular files in the directory located at DIRECTORY_PATH with suffix SUFFIX, not crossing directory boundaries if using a single wildcard; but crossing directory boundaries if using more than a single wildcard (there may not be a SUFFIX; in other words, SUFFIX may be an empty string). The number of wildcards in the sequence **....* defines the maximum number of directory levels to search.

In the location, you may use placeholders enclosed between ${ and } for the following properties:

  • The global property PARENT_DIR for defining - in a generic way - a path relative to the parent directory to the XML file where this is used;
  • Java system properties;
  • System environment variables.

You may use ! (exclamation mark) as a separating character between the placeholder property name and a default value that is used if the property is undefined. E.g. ${PARENT_DIR!/home/foo/conf} will be replaced with /home/foo/conf if PARENT_DIR is undefined.

XML Source (w/o annotations (1); see within schema source)
<xs:element maxOccurs="unbounded" minOccurs="1" name="policyLocation" type="xs:anyURI"/>
XML schema documentation generated with FlexDoc/XML 1.12.2 using FlexDoc/XML XSDDoc 2.9.1 template set. All XSD diagrams generated by FlexDoc/XML DiagramKit.