com.att.research.xacmlatt.pdp.policy.PolicyFinder Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of xacml-pdp Show documentation

ATT reference implementation of XACML PDP engine

The newest version!

/*
 *
 * Copyright (c) 2013,2019-2020 AT&T Knowledge Ventures SPDX-License-Identifier: MIT
 */
package com.att.research.xacmlatt.pdp.policy;

import com.att.research.xacml.api.IdReferenceMatch;
import com.att.research.xacmlatt.pdp.eval.EvaluationContext;

/**
 * PolicyFinder is the interface for objects that can locate XACML Policies and PolicySets by identifier and contains the root
 * Policy or Policy set.  The interface is designed to allow for finders that can retrieve a root policy from a repository based on
 * matching a {@link com.att.research.xacml.api.Request}.
 * 
 * @author car
 * @version $Revision: 1.1 $
 */
public interface PolicyFinder {
	/**
	 * Gets the root {@link com.att.research.xacmlatt.pdp.policy.PolicyDef} from the policy store
	 * configured by the particular implementation of the PolicyFinderFactory class that
	 * is applicable to the {@link com.att.research.xacml.api.Request} in the given {@link com.att.research.xacmlatt.pdp.eval.EvaluationContext}.
	 * @param evaluationContext Evaluation Context object
	 * 
	 * @return a PolicyFinderResult with the root PolicyDef
	 */
	public PolicyFinderResult getRootPolicyDef(EvaluationContext evaluationContext);
	
	/**
	 * Gets the {@link com.att.research.xacmlatt.pdp.policy.Policy} that matches the given {@link com.att.research.xacml.api.IdReferenceMatch}.
	 * 
	 * @param idReferenceMatch the IdReferenceMatch to search for
	 * @return a PolicyFinderResult with the Policy matching the given IdReferenceMatch
	 */
	public PolicyFinderResult getPolicy(IdReferenceMatch idReferenceMatch);
	
	/**
	 * Gets the {@link com.att.research.xacmlatt.pdp.policy.PolicySet} that matches the given {@link com.att.research.xacml.api.IdReferenceMatch}.
	 * 
	 * @param idReferenceMatch the IdReferenceMatch to search for
	 * @return a PolicyFinderResult with the PolicySet matching the given IdReferenceMatch.
	 */
	public PolicyFinderResult getPolicySet(IdReferenceMatch idReferenceMatch);

    /**
     * Shutdown the polcy finder to release handles.
     */
    public void shutdown();
}