org.wso2.balana.cond.xacml3

Class XACML3HigherOrderFunction

java.lang.Object

org.wso2.balana.cond.xacml3.XACML3HigherOrderFunction

All Implemented Interfaces:

Expression, Function

public class XACML3HigherOrderFunction
extends Object
implements Function

Represents all of the XACML3 higher order functions. (any-of, all-of and any-of-any)

Field Summary

Fields

Modifier and Type	Field and Description
static String	NAME_ALL_OF
static String	NAME_ANY_OF
static String	NAME_ANY_OF_ANY

Constructor Summary

Constructors

Constructor and Description
XACML3HigherOrderFunction(String functionName) Creates a new instance of the given function.

Method Summary

Modifier and Type	Method and Description
void	checkInputs(List inputs) Checks that the given inputs are of the right types, in the right order, and are the right number for this function to evaluate.
void	checkInputsNoBag(List inputs) Checks that the given inputs are of the right types, in the right order, and are the right number for this function to evaluate.
String	encode() Encodes this Function into its XML form
void	encode(StringBuilder builder) Encodes this Function into its XML form and writes this out to the provided StringBuilder
EvaluationResult	evaluate(List inputs, EvaluationCtx context) Evaluates the Function using the given inputs.
URI	getIdentifier() Returns the identifier of this function as known by the factories.
URI	getReturnType() Provides the type of AttributeValue that this function returns from evaluate in a successful evaluation.
static Set	getSupportedIdentifiers() Returns a Set containing all the function identifiers supported by this class.
URI	getType() Returns the type of the expression.
boolean	returnsBag() Tells whether this function will return a bag of values or just a single value.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

NAME_ANY_OF

public static final String NAME_ANY_OF

See Also:

Constant Field Values

NAME_ALL_OF

public static final String NAME_ALL_OF

See Also:

Constant Field Values

NAME_ANY_OF_ANY

public static final String NAME_ANY_OF_ANY

See Also:

Constant Field Values

Constructor Detail

XACML3HigherOrderFunction

public XACML3HigherOrderFunction(String functionName)

Creates a new instance of the given function.

Parameters:

functionName - the function to create

Throws:

IllegalArgumentException - if the function is unknown

Method Detail

getSupportedIdentifiers

public static Set getSupportedIdentifiers()

Returns a Set containing all the function identifiers supported by this class.

Returns:

a Set of Strings

checkInputs

public void checkInputs(List inputs)
                 throws IllegalArgumentException

Description copied from interface: Function

Checks that the given inputs are of the right types, in the right order, and are the right number for this function to evaluate. If the function cannot accept the inputs for evaluation, an IllegalArgumentException is thrown.

Specified by:

checkInputs in interface Function

Parameters:

inputs - a List of Evaluatables, with the first argument being a Function if this is a higher-order function

Throws:

IllegalArgumentException - if the inputs do match what the function accepts for evaluation

checkInputsNoBag

public void checkInputsNoBag(List inputs)
                      throws IllegalArgumentException

Description copied from interface: Function

Checks that the given inputs are of the right types, in the right order, and are the right number for this function to evaluate. If the function cannot accept the inputs for evaluation, an IllegalArgumentException is thrown. Unlike the other checkInput method in this interface, this assumes that the parameters will never provide bags of values. This is useful if you're considering a target function which has a designator or selector in its input list, but which passes the values from the derived bags one at a time to the function, so the function doesn't have to deal with the bags that the selector or designator generates.

Specified by:

checkInputsNoBag in interface Function

Parameters:

inputs - a List of Evaluatables, with the first argument being a Function if this is a higher-order function

Throws:

IllegalArgumentException - if the inputs do match what the function accepts for evaluation

evaluate

public EvaluationResult evaluate(List inputs,
                                 EvaluationCtx context)

Description copied from interface: Function

Evaluates the Function using the given inputs. The List contains Evaluatables which are all of the correct type if the Function has been created as part of an Apply or TargetMatch, but which may otherwise be invalid. Each parameter should be evaluated by the Function, unless the Function doesn't need to evaluate all inputs to determine a result (as in the case of the or function). The order of the List is significant, so a Function should have a very good reason if it wants to evaluate the inputs in a different order.

Note that if this is a higher-order function, like any-of, then some argument (typically the first) in the List will actually be a Function object representing the function to apply to some bag. A function needs to know if it's a higher-order function, and therefore whether or not to look for this case. Also, a higher-order function is responsible for checking that the inputs that it will pass to the Function provided as the first parameter are valid, ie. it must do a checkInputs on its sub-function when checkInputs is called on the higher-order function.

Specified by:

evaluate in interface Function

Parameters:

inputs - the List of inputs for the function

context - the representation of the request

Returns:

a result containing the AttributeValue computed when evaluating the function, or Status specifying some error condition

getIdentifier

public URI getIdentifier()

Description copied from interface: Function

Returns the identifier of this function as known by the factories. In the case of the standard XACML functions, this will be one of the URIs defined in the standard namespace. This function must always return the complete namespace and identifier of this function.

Specified by:

getIdentifier in interface Function

Returns:

the function's identifier

getType

public URI getType()

Description copied from interface: Expression

Returns the type of the expression. This may be the data type of an AttributeValue, the return type of a Function, etc.

Specified by:

getType in interface Expression

Returns:

the attribute type of the referenced expression

getReturnType

public URI getReturnType()

Description copied from interface: Function

Provides the type of AttributeValue that this function returns from evaluate in a successful evaluation.

Specified by:

getReturnType in interface Function

Returns:

the type returned by this function

returnsBag

public boolean returnsBag()

Description copied from interface: Function

Tells whether this function will return a bag of values or just a single value.

Specified by:

returnsBag in interface Expression

Specified by:

returnsBag in interface Function

Returns:

true if evaluation will return a bag, false otherwise

encode

public String encode()

Description copied from interface: Function

Encodes this Function into its XML form

Specified by:

encode in interface Function

Returns:

String

encode

public void encode(StringBuilder builder)

Description copied from interface: Function

Encodes this Function into its XML form and writes this out to the provided StringBuilder

Specified by:

encode in interface Expression

Specified by:

encode in interface Function

Parameters:

builder - string stream into which the XML-encoded data is written