com.att.research.xacmlatt.pdp.eval.Matchable 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  AT&T Knowledge Ventures
 *                     SPDX-License-Identifier: MIT
 */

package com.att.research.xacmlatt.pdp.eval;

/**
 * Matchable is the interface objects implement to indicate they are part of a XACML Target matching tree.
 * 
 * @author car
 * @version $Revision: 1.1 $
 */
public interface Matchable {
	/**
	 * Matches this Matchable in the given {@link com.att.research.xacmlatt.pdp.eval.EvaluationContext} and
	 * returns a {@link com.att.research.xacmlatt.pdp.eval.MatchResult}.
	 * 
	 * @param evaluationContext the EvaluationContext to use in matching
	 * @return a MatchResult indicating whether this Matchable matches against the given EvaluationContext.
	 * @throws EvaluationException if there is an error testing the match.
	 */
	public MatchResult match(EvaluationContext evaluationContext) throws EvaluationException;
}