Interface Function<RETURN_T extends Value>
-
- Type Parameters:
RETURN_T
- return type of this function
- All Superinterfaces:
PdpExtension
,PrimitiveValue
,Value
- All Known Implementing Classes:
BaseFunction
,ComparisonFunction
,DatatypeConversionFunction
,EqualTypeMatchFunction
,FirstOrderBagFunctions.AtLeastOneMemberOf
,FirstOrderBagFunctions.BagContains
,FirstOrderBagFunctions.BagSize
,FirstOrderBagFunctions.Intersection
,FirstOrderBagFunctions.PrimitiveToBag
,FirstOrderBagFunctions.SetEquals
,FirstOrderBagFunctions.SetFunction
,FirstOrderBagFunctions.SingletonBagToPrimitive
,FirstOrderBagFunctions.Subset
,FirstOrderBagFunctions.Union
,FirstOrderFunction
,HigherOrderBagFunction
,MultiParameterTypedFirstOrderFunction
,NonEqualTypeMatchFunction
,SingleParameterTypedFirstOrderFunction
public interface Function<RETURN_T extends Value> extends PrimitiveValue, PdpExtension
XACML function.
-
-
Field Summary
Fields Modifier and Type Field Description static String
AUTHZFORCE_EXTENSION_PREFIX
Prefix used by AuthZForce non-standard functions (PDP extensions).static String
XACML_NS_1_0
The standard namespace where all XACML 1.0 spec-defined functions are definedstatic String
XACML_NS_2_0
The standard namespace where all XACML 2.0 spec-defined functions are definedstatic String
XACML_NS_3_0
The standard namespace where all XACML 3.0 spec-defined functions are defined
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description Datatype<RETURN_T>
getReturnType()
Gets the return type of the functionFunctionCall<RETURN_T>
newCall(List<Expression<?>> argExpressions)
Creates new function call with given arguments (Expressions).-
Methods inherited from interface org.ow2.authzforce.core.pdp.api.PdpExtension
getId
-
-
-
-
Field Detail
-
AUTHZFORCE_EXTENSION_PREFIX
static final String AUTHZFORCE_EXTENSION_PREFIX
Prefix used by AuthZForce non-standard functions (PDP extensions). Third-party (outside AuthZForce project) contributions must use a different prefix to avoid conflicts.- See Also:
- Constant Field Values
-
XACML_NS_1_0
static final String XACML_NS_1_0
The standard namespace where all XACML 1.0 spec-defined functions are defined- See Also:
- Constant Field Values
-
XACML_NS_2_0
static final String XACML_NS_2_0
The standard namespace where all XACML 2.0 spec-defined functions are defined- See Also:
- Constant Field Values
-
XACML_NS_3_0
static final String XACML_NS_3_0
The standard namespace where all XACML 3.0 spec-defined functions are defined- See Also:
- Constant Field Values
-
-
Method Detail
-
getReturnType
Datatype<RETURN_T> getReturnType()
Gets the return type of the function- Returns:
- function return type
-
newCall
FunctionCall<RETURN_T> newCall(List<Expression<?>> argExpressions) throws IllegalArgumentException
Creates new function call with given arguments (Expressions). Any implementation of this method should first validate inputs according to the function signature/definition.- Parameters:
argExpressions
- function arguments (expressions)- Returns:
- Function call handle for calling this function which such inputs (with possible changes from original inputs due to optimizations for instance)
- Throws:
IllegalArgumentException
- if inputs are invalid for this function
-
-