com.att.research.xacmlatt.pdp.std.functions.FunctionDefinitionBagIsIn 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
Show all versions of xacml-pdp Show documentation
ATT reference implementation of XACML PDP engine
/*
*
* Copyright (c) 2013,2019 AT&T Knowledge Ventures
* SPDX-License-Identifier: MIT
*/
package com.att.research.xacmlatt.pdp.std.functions;
import java.util.Iterator;
import java.util.List;
import com.att.research.xacml.api.AttributeValue;
import com.att.research.xacml.api.DataType;
import com.att.research.xacml.api.Identifier;
import com.att.research.xacml.std.StdStatus;
import com.att.research.xacml.std.StdStatusCode;
import com.att.research.xacml.std.datatypes.DataTypes;
import com.att.research.xacmlatt.pdp.eval.EvaluationContext;
import com.att.research.xacmlatt.pdp.policy.Bag;
import com.att.research.xacmlatt.pdp.policy.ExpressionResult;
import com.att.research.xacmlatt.pdp.policy.FunctionArgument;
/**
* FunctionDefinitionBagIsIn implements {@link com.att.research.xacmlatt.pdp.policy.FunctionDefinition} to
* implement the XACML 'type'-is-in predicates as functions taking two arguments, the first of type and the second of type Bag,
* and returning a Boolean for whether the first argument is contained in the second.
*
* In the first implementation of XACML we had separate files for each XACML Function.
* This release combines multiple Functions in fewer files to minimize code duplication.
* This file supports the following XACML codes:
* string-is-in
* boolean-is-in
* integer-is-in
* double-is-in
* time-is-in
* date-is-in
* dateTime-is-in
* anyURI-is-in
* hexBinary-is-in
* base64Binary-is-in
* dayTimeDuration-is-in (version 1 and3)
* yearMonthDuration-is-in (version 1 and 3)
* x500Name-is-in
* rfc822Name-is-in
* ipAddress-is-in
* dnsName-is-in
*
*
* @author glenngriffin
* @version $Revision: 1.1 $
*
* @param the java class for the data type of the elements in the Input argument Bag
*
* The Output for these functions is always a Boolean.
*/
public class FunctionDefinitionBagIsIn extends FunctionDefinitionBase {
/**
* Constructor - need dataType input because of java Generic type-erasure during compilation.
*
* @param idIn
* @param dataTypeArgsIn
*/
public FunctionDefinitionBagIsIn(Identifier idIn, DataType dataTypeArgsIn) {
super(idIn, DataTypes.DT_BOOLEAN, dataTypeArgsIn, false);
}
/**
* Evaluates this FunctionDefinition on the given List of{@link com.att.research.xacmlatt.pdp.policy.FunctionArgument}s.
*
* @param evaluationContext the {@link com.att.research.xacmlatt.pdp.eval.EvaluationContext} to use in the evaluation
* @param arguments the List of FunctionArguments for the evaluation
* @return an {@link com.att.research.xacmlatt.pdp.policy.ExpressionResult} with the results of the call
*/
@Override
public ExpressionResult evaluate(EvaluationContext evaluationContext, List arguments) {
if (arguments == null || arguments.size() != 2) {
return ExpressionResult.newError(new StdStatus(StdStatusCode.STATUS_CODE_PROCESSING_ERROR, this.getShortFunctionId() + " Expected 2 arguments, got " +
((arguments == null) ? "null" : arguments.size()) ));
}
// get the thing to look for in the bag
FunctionArgument elementArgument = arguments.get(0);
ConvertedArgument convertedTargetArgument = new ConvertedArgument(elementArgument, this.getDataTypeArgs(), false);
if ( ! convertedTargetArgument.isOk()) {
return ExpressionResult.newError(getFunctionStatus(convertedTargetArgument.getStatus()));
}
// Special case: Most methods want the value contained in the AttributeValue object inside the FunctionArgument.
// This one wants the AttributeValue itself.
// We use the ConvertedArgument constructor to validate that the argument is ok, then use the AttributeValue
// from the FunctionArgument.
AttributeValue attributeValueElement = elementArgument.getValue();
// now get the bag
FunctionArgument bagArgument = arguments.get(1);
ConvertedArgument convertedBagArgument = new ConvertedArgument(bagArgument, null, true);
if ( ! convertedBagArgument.isOk()) {
return ExpressionResult.newError(getFunctionStatus(convertedBagArgument.getStatus()));
}
Bag bag = convertedBagArgument.getBag();
Iterator> iterBagContents = bag.getAttributeValues();
while (iterBagContents.hasNext()) {
AttributeValue attributeValueBagContents = iterBagContents.next();
/*
* Should we be checking the type of the bag contents and returning an error if the bag contents are not of the
* right type? The spec does not say this, so we just use the AttributeValue.equals() method for now.
*/
if (attributeValueElement.equals(attributeValueBagContents)) {
return ER_TRUE;
}
}
return ER_FALSE;
}
}