Package org.ow2.authzforce.core.pdp.api

Interface Summary

Interface	Description
AttributeFqn	Attribute's Fully Qualified Name, including the attribute's Category, the AttributeId, and optional Issuer.
AttributeProvider	Attribute provider used to resolve AttributeDesignatorTypes in a specific way (e.g.
AttributeSource	Attribute source identifier (request? PDP? custom attribute provider module?)
CloseableNamedAttributeProvider	NamedAttributeProvider that extends Closeable because it may may use resources external to the JVM such as a cache, a disk, a connection to a remote server, etc.
CloseableNamedAttributeProvider.DependencyAwareFactory	Intermediate dependency-aware CloseableNamedAttributeProvider factory that can create instances of Attribute Providers from a XML/JAXB configuration, and also provides the dependencies (required attributes) (based on this configuration), that any such instance (created by it) will need.
CloseablePdpEngine	XACML PDP that implements Closeable because it may depend on various components that hold resources such as network resources and caches to get: the root policy or policies referenced by the root policy; or to get attributes used in the policies from remote sources when not provided in the Request; or to get cached decisions for requests already evaluated in the past, etc.
Decidable	"Decidable" policy element, i.e.
DecisionCache	Authorization (XACML) decision result cache.
DecisionRequest	Individual (in the sense of Multiple Decision Profile of XACML) authorization decision request used as input to PDP engine in AuthzForce-native model, for evaluating the policy decision.
DecisionRequestBuilder<R extends DecisionRequest>	Immutable DecisionRequest builder.
DecisionRequestFactory<R extends DecisionRequest>	DecisionRequest factory
DecisionRequestPreprocessor<INPUT_DECISION_REQUEST,OUTPUT_INDIVIDUAL_DECISION_REQUEST extends DecisionRequest>	XACML Decision Request pre-processor; applies some validation and processing of the input request prior to the policy evaluation.
DecisionRequestPreprocessor.Factory<IDR,OIDR extends DecisionRequest>	Factory of request preprocessors
DecisionResult	Result of evaluation of Decidable (Policy, Rule...) with PEP actions (Obligations/Advice).
DecisionResultPostprocessor<INDIVIDUAL_DECISION_REQUEST extends DecisionRequest,OUTPUT_DECISION_RESPONSE>	XACML Decision Result post-processor, i.e.
DecisionResultPostprocessor.Factory<IDREQ extends DecisionRequest,RES>	Factory of result post-processors
EnvironmentProperties	Environment properties set by PDP configuration parsers (before or during PDP instantiation) for later use by PDP extensions.
EvaluationContext	Manages context for the policy evaluation of a given authorization decision request.
EvaluationContext.Listener	Evaluation context listener.
ExtendedDecision	Extended decision, i.e.
HashCollectionFactory	Factory method to construct HashMaps/HashSets.
NamedAttributeProvider	"Named" Attribute Provider, i.e.
PdpEngine	This is the interface for the Authorization PDP engines, providing the starting point for decision request evaluation, independent of data representation/serialization formats.
PdpExtension	Marker Interface for all kinds of PDP extension (Attribute datatypes, functions, combining algorithms, AttributeProviderModule, RootPolicyProviderModule...)
PdpExtensionRegistry<T extends PdpExtension>	Registry of extensions of specific type.
UpdatableCollection<E>	Updatable collection; "updatable" means elements can only be added to the collection (no removal, no clear)
UpdatableList<E>	Updatable list; "updatable" means elements can only be added to the list (no removal, no clear)
UpdatableMap<K,V>	Updatable Map; "updatable" means elements can only be put to the Map (no removal, no clear)
UpdatableSet<E>	Updatable Set; "updatable" means elements can only be added to the Set (no removal, no clear)
XmlUtils.XmlnsFilteringParser	(Namespace-filtering) XML-to-JAXB parser
XmlUtils.XmlnsFilteringParserFactory	(Namespace-filtering) XACML-to-JAXB parser factory

Class Summary

Class	Description
AttributeFqns	Static utility methods pertaining to AttributeFqn instances.
AttributeSelectorId	AttributeSelector identifier (category, contextSelectorId, path).
AttributeSources	/** Static utility methods pertaining to AttributeSource instances.
BaseDecisionResult	This class provides a skeletal implementation of the DecisionResult interface to minimize the effort required to implement this interface.
BaseNamedAttributeProvider	This is a convenience class to help implement CloseableNamedAttributeProvider.
BasePdpExtensionRegistry<T extends PdpExtension>	This is a base implementation of PdpExtensionRegistry.
CloseableNamedAttributeProvider.FactoryBuilder<CONF_T extends org.ow2.authzforce.xmlns.pdp.ext.AbstractAttributeProvider>	Builder that creates a dependency-aware AttributeProvider factory from parsing the attribute dependencies (attributes on which the Providers created by this factory will depend on to find their own supported attributes) declared in the XML configuration (possibly dynamic).
DecisionCache.Factory<CONF_T extends org.ow2.authzforce.xmlns.pdp.ext.AbstractDecisionCache>	Factory for creating instance of DecisionCache extension
DecisionResultPostprocessor.Features	Standard feature identifiers that may be returned by DecisionResultPostprocessor.getFeatures()
DecisionResults	Factory for creating immutable DecisionResults
DefaultHashCollectionFactory	Default implementation of HashCollectionFactory based on Guava and native Java API.
ExtendedDecisions	(Immutable) ExtendedDecision factory
HashCollections	Static factory methods to construct HashMaps/HashSets based on alternatives to Java native implementations, which alternatives must support: Immutable HashMap/HashSet implementations.
ImmutableDecisionRequest	Immutable implementation of DecisionRequest to be used as input to PdpEngine.evaluate(DecisionRequest).
JaxbBoundPdpExtension<T extends org.ow2.authzforce.xmlns.pdp.ext.AbstractPdpExtension>	Marker Interface for PDP extensions bound to a specific XML/JAXB class (used for the configuration of the extension)
MutableAttributeBag<AV extends AttributeValue>	Growable/udpatable attribute bag, i.e.
PdpExtensionRegistry.PdpExtensionComparator<E extends PdpExtension>	PDP extension comparator (compares IDs)
PepAction	PEP Action, i.e.
PepActionAttributeAssignment<AV extends AttributeValue>	(XACML-like) AttributeAssignment to be passed to a PEP action (obligation, advice).
StatusHelper	Simplifies XACML Status handling.
UpdatableCollections	Factory for UpdatableLists
XmlUtils	Utilities for XML-to-JAXB binding
XmlUtils.NoXmlnsFilteringParser	This is a bare implementation of namespace-filtering parser, i.e.
XmlUtils.SAXBasedXmlnsFilteringParser	SAX-based namespace-filtering XML-to-JAXB parser.
XmlUtils.XPathEvaluator	Wrapper around XPathExecutable that provides the original XPath expression from which the XPathExecutable was compiled, via toString() method.

Enum Summary

Enum	Description
AttributeSource.Type	Type of attribute source
EnvironmentPropertyName	Enumeration of property names (or so-called global variables) usable in PDP configuration strings in form of ${PROPERTY_NAME}, set by the PDP configuration parser.

Exception Summary

Exception	Description
IndeterminateEvaluationException	Exception wrapper for XACML Indeterminate/error caused by evaluation