com.att.research.xacmlatt.pdp.std.StdEvaluationContext 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.std;

import java.util.Collection;
import java.util.Properties;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import com.att.research.xacml.api.IdReferenceMatch;
import com.att.research.xacml.api.Request;
import com.att.research.xacml.api.pip.PIPEngine;
import com.att.research.xacml.api.pip.PIPException;
import com.att.research.xacml.api.pip.PIPFinder;
import com.att.research.xacml.api.pip.PIPRequest;
import com.att.research.xacml.api.pip.PIPResponse;
import com.att.research.xacml.api.trace.TraceEngine;
import com.att.research.xacml.api.trace.TraceEngineFactory;
import com.att.research.xacml.api.trace.TraceEvent;
import com.att.research.xacml.std.pip.engines.RequestEngine;
import com.att.research.xacml.std.pip.finders.RequestFinder;
import com.att.research.xacml.util.FactoryException;
import com.att.research.xacmlatt.pdp.eval.EvaluationContext;
import com.att.research.xacmlatt.pdp.policy.Policy;
import com.att.research.xacmlatt.pdp.policy.PolicyDef;
import com.att.research.xacmlatt.pdp.policy.PolicyFinder;
import com.att.research.xacmlatt.pdp.policy.PolicyFinderResult;
import com.att.research.xacmlatt.pdp.policy.PolicySet;

/**
 * StdEvaluationContext implements the {@link com.att.research.xacmlatt.pdp.eval.EvaluationContext} interface using
 * default factories to load the XACML policies, and get the PIP engines.
 * 
 * @author car
 * @version $Revision: 1.1 $
 */
public class StdEvaluationContext implements EvaluationContext {
	private final Logger logger	= LoggerFactory.getLogger(this.getClass());
	private Properties properties;
	private Request request;
	private RequestFinder requestFinder;
	private PolicyFinder policyFinder;
	private TraceEngine traceEngine;
    private boolean shutdown = false;
	
	/**
	 * Creates a new StdEvaluationContext with the given {@link com.att.research.xacml.api.Request} and
	 * {@link com.att.research.xacmlatt.pdp.policy.PolicyDef}.
	 * 
	 * @param requestIn the Request
	 * @param policyFinderIn Input PolicyFinder
	 * @param pipFinder  Input PIPFinder
	 * @param traceEngineIn  TraceEngine
	 * @param properties Properties
	 */
	public StdEvaluationContext(Request requestIn, PolicyFinder policyFinderIn, PIPFinder pipFinder, TraceEngine traceEngineIn, Properties properties) {
		this.properties		= properties;
		this.request		= requestIn;
		this.policyFinder	= policyFinderIn;
		if (traceEngineIn != null) {
			this.traceEngine	= traceEngineIn;
		} else {
			try {
				if (this.properties == null) {
					this.traceEngine	= TraceEngineFactory.newInstance().getTraceEngine();
				} else {
					this.traceEngine	= TraceEngineFactory.newInstance(this.properties).getTraceEngine(this.properties);
				}
			} catch (FactoryException ex) {
				this.logger.error("FactoryException creating TraceEngine", ex);
			}
		}
		
		if (pipFinder == null) {
			this.requestFinder		= new RequestFinder(null, new RequestEngine(requestIn));
		} else {
			if (pipFinder instanceof RequestFinder) {
				this.requestFinder	= (RequestFinder)pipFinder;
			} else {
				this.requestFinder	= new RequestFinder(pipFinder, new RequestEngine(requestIn));
			}
		}
	}
	
	public StdEvaluationContext(Request requestIn, PolicyFinder policyFinderIn, PIPFinder pipFinder, TraceEngine traceEngineIn) {
		this(requestIn, policyFinderIn, pipFinder, traceEngineIn, null);
	}
	
	public StdEvaluationContext(Request requestIn, PolicyFinder policyFinderIn, PIPFinder pipFinder) {
		this(requestIn, policyFinderIn, pipFinder, null);
	}

	@Override
	public Request getRequest() {
		return this.request;
	}

	@Override
	public PIPResponse getAttributes(PIPRequest pipRequest) throws PIPException {
		return this.requestFinder.getAttributes(pipRequest, null);
	}
	
	@Override
	public PIPResponse getAttributes(PIPRequest pipRequest, PIPEngine exclude) throws PIPException {
		return this.requestFinder.getAttributes(pipRequest, exclude);
	}
	
	@Override
	public PIPResponse getAttributes(PIPRequest pipRequest, PIPEngine exclude, PIPFinder pipFinderRoot) throws PIPException {
		return this.requestFinder.getAttributes(pipRequest, exclude, pipFinderRoot);
	}

	@Override
	public PolicyFinderResult getRootPolicyDef() {
		return this.policyFinder.getRootPolicyDef(this);
	}

	@Override
	public PolicyFinderResult getPolicy(IdReferenceMatch idReferenceMatch) {
		return this.policyFinder.getPolicy(idReferenceMatch);
	}

	@Override
	public PolicyFinderResult getPolicySet(IdReferenceMatch idReferenceMatch) {
		return this.policyFinder.getPolicySet(idReferenceMatch);
	}

	@Override
	public void trace(TraceEvent traceEvent) {
		if (this.traceEngine != null) {
			this.traceEngine.trace(traceEvent);
		}
	}

	@Override
	public boolean isTracing() {
		if (this.traceEngine != null) {
		  return this.traceEngine.isTracing();
		}
		return false;
	}

	@Override
	public PIPResponse getMatchingAttributes(PIPRequest pipRequest, PIPEngine exclude) throws PIPException {
        if (this.shutdown) {
            throw new PIPException("Engine is shutdown.");
        }
		return this.requestFinder.getMatchingAttributes(pipRequest, exclude);
	}

	@Override
	public PIPResponse getMatchingAttributes(PIPRequest pipRequest, PIPEngine exclude, PIPFinder pipFinderParent) throws PIPException {
        if (this.shutdown) {
            throw new PIPException("Engine is shutdown.");
        }
		return this.requestFinder.getMatchingAttributes(pipRequest, exclude, pipFinderParent);
	}

	@Override
	public Collection getPIPEngines() {
		return this.requestFinder.getPIPEngines();
	}

    @Override
    public void shutdown() {
        this.policyFinder.shutdown();
        this.requestFinder.shutdown();
        this.shutdown = true;
    }
}