Skip navigation links

oracle.security.jps.service.policystore.info
Class BuiltInFunctionsHandler

java.lang.Object
oracle.security.jps.service.policystore.info.BuiltInFunctionsHandler

public final class BuiltInFunctionsHandler

extends java.lang.Object

This class provides a wrapper for various definitions for all built in functions supported by OES. The functions themselves are separated in multiple enums and this class provides a common interface over all of them. Note, this class does not support a method to get all functions of a given category. This should be obtained using a FunctionSearchQuery and running a search.

Nested Class Summary

static class	BuiltInFunctionsHandler.ArithmeticFunctions
static class	BuiltInFunctionsHandler.DateTimeArithmeticFunctions Please see XACML3.0 core spec section A.3.7 to get a complete idea of all functions in this enum
static class	BuiltInFunctionsHandler.EqualityFunctions
static class	BuiltInFunctionsHandler.FromStringConversionFunctions Please see XACML3.0 core spec section A.3.9 to get a complete idea of all functions in this enum
static class	BuiltInFunctionsHandler.GreaterThanEqualFunctions
static class	BuiltInFunctionsHandler.GreaterThanFunctions
static class	BuiltInFunctionsHandler.LessThanEqualFunctions
static class	BuiltInFunctionsHandler.LessThanFunctions
static class	BuiltInFunctionsHandler.LogicalFunctions
static class	BuiltInFunctionsHandler.NumericConversionFunctions
static class	BuiltInFunctionsHandler.RegExpFunctions
static class	BuiltInFunctionsHandler.RuntimeIdentityContextAsserterFunction Custom OES function to validate runtime value of ID Context attribute against a specified value.
static class	BuiltInFunctionsHandler.RuntimeIdentityContextRetriverFunctions Custom OES function to return a String value of ID Context attribute of type String or Boolean or Integer.
static class	BuiltInFunctionsHandler.SpecialMatchFunctions Please see XACML3.0 core spec section A.3.14 to get a complete idea of all functions in this enum
static class	BuiltInFunctionsHandler.StringConversionFunctions
static class	BuiltInFunctionsHandler.StringFunctions
static class	BuiltInFunctionsHandler.SupportedArgTypes Represents the types of arguments OES can pass to a function, built-in or custom.
static class	BuiltInFunctionsHandler.ToStringConversionFunctions Please see XACML3.0 core spec section A.3.9 to get a complete idea of all functions in this enum
static class	BuiltInFunctionsHandler.TypeAtLeastOneMemberFunctions
static class	BuiltInFunctionsHandler.TypeBagFunctions
static class	BuiltInFunctionsHandler.TypeBagSizeFunctions
static class	BuiltInFunctionsHandler.TypeIntersectionFunctions
static class	BuiltInFunctionsHandler.TypeIsInBagFunctions
static class	BuiltInFunctionsHandler.TypeIsInFunctions
static class	BuiltInFunctionsHandler.TypeOneAndOnlyFunctions
static class	BuiltInFunctionsHandler.TypeSetEqualsFunctions
static class	BuiltInFunctionsHandler.TypeSubsetFunctions
static class	BuiltInFunctionsHandler.TypeUnionFunctions
static class	BuiltInFunctionsHandler.ValidForFunctions
static class	BuiltInFunctionsHandler.ValueExistenceCheckFunctions

Constructor Summary

BuiltInFunctionsHandler()

Method Summary

static boolean	functionHasVariableArgs(java.lang.String name) Returns true if the given function has variable number of arguments.
static java.lang.String[]	getAllBuiltInFunctions() Returns all supported built-in functions.
static DataType.TYPE	getDataTypeOfArg(BuiltInFunctionsHandler.SupportedArgTypes spt) Get DataType.TYPE for given SupportedArgType.
static java.lang.String	getDescriptionInEnglish(java.lang.String functionName) Returns english language description for a funtion given simple name
static java.lang.String	getDisplayNameInEnglish(java.lang.String functionName) Returns english language display name for a funtion given simple name
static java.lang.String	getFullyQualifiedName(java.lang.String name) Return fully qualified name of this function.
static RuleExpressionEntry.FunctionCategory	getFunctionCategory(java.lang.String name) Returns category of a funtion given simple name
static java.lang.String	getFunctionFullyQualifiedName(java.lang.String name) Returns fully qualified name for a funtion given simple name
static BuiltInFunctionsHandler.SupportedArgTypes[]	getFunctionInputParameters(java.lang.String name) Returns list of function input parameters given name.
static java.util.List<FunctionEntry.ARG_TYPE>	getFunctionParameterValueTypes(java.lang.String name) Returns parameter value types of input parameters for a function (whether input parameter is a single object/ bag/ set of objects).
static java.lang.Class<? extends DataType>	getFunctionReturnType(java.lang.String name) Returns return type of a funtion given simple name
static FunctionEntry.ARG_TYPE	getFunctionReturnValueType(java.lang.String name) Returns type of value returned by a funtion given simple name
static VarArgsInfo	getFunctionVarArgsInfo(java.lang.String name) Returns variable argument information for a funtion given simple name
static java.util.List<java.lang.Class<? extends ExpressionComponent>>	getList(BuiltInFunctionsHandler.SupportedArgTypes... a)
static java.lang.String	getOperator(java.lang.String funcName) REturns the operand for a function if the function is an operator.
static java.lang.String	getSimpleName(java.lang.String qualifiedName) Returns simple name of this function given fully qualified name.
static boolean	isBuiltInFunction(java.lang.String name) Returns true if the given function is supported out of the box.

Methods inherited from class java.lang.Object

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

Constructor Detail

BuiltInFunctionsHandler

public BuiltInFunctionsHandler()

Method Detail

getDataTypeOfArg

public static DataType.TYPE getDataTypeOfArg(BuiltInFunctionsHandler.SupportedArgTypes spt)

Get DataType.TYPE for given SupportedArgType. For Set and Bag types, returns null.

getFullyQualifiedName

public static java.lang.String getFullyQualifiedName(java.lang.String name)
                                              throws InvalidArgumentException

Return fully qualified name of this function. If it is a function supported in XACML 3.0 core specification, the standard name will be returned.

Parameters:

name - Expected to be in form of <some enum constant>.name() For example, EqualiyFunctions.DOUBLE_EQUAL.name() You can also use RuleExpressionEntry.BuiltInFunctions.DATE_EQUAL.name()

Throws:

InvalidArgumentException - if function name is not one of the supported built-in functions

getSimpleName

public static java.lang.String getSimpleName(java.lang.String qualifiedName)

Returns simple name of this function given fully qualified name.

Parameters:

name - Expected to be in form of a complete name For example, urn:oasis:names:tc:xacml:1.0:function:boolean-equal

Throws:

InvalidArgumentException - if function name is not one of the supported built-in functions

getFunctionCategory

public static RuleExpressionEntry.FunctionCategory getFunctionCategory(java.lang.String name)
                                                                throws InvalidArgumentException

Returns category of a funtion given simple name

Parameters:

name - Expected to be in form of <some enum constant>.name() For example, EqualiyFunctions.DATE_EQUAL.name() You can also use RuleExpressionEntry.BuiltInFunctions.DATE_EQUAL.name()

Throws:

InvalidArgumentException - if function name is not one of the supported built-in functions

isBuiltInFunction

public static boolean isBuiltInFunction(java.lang.String name)

Returns true if the given function is supported out of the box.

Parameters:

name - Name of the function, expected to be a simple name; not fully qualified one.

getAllBuiltInFunctions

public static java.lang.String[] getAllBuiltInFunctions()

Returns all supported built-in functions. Does not return functions that are deprecated. To get those, use getDeprecatedBuiltInFunctions API.

getOperator

public static java.lang.String getOperator(java.lang.String funcName)

REturns the operand for a function if the function is an operator. Otherwise returns null. For example, this method returns "=" for STRING_EQUAL function and "<" for TIME_LESS_THAN.

Parameters:

funcName -

getFunctionReturnType

public static java.lang.Class<? extends DataType> getFunctionReturnType(java.lang.String name)
                                                                 throws InvalidArgumentException

Returns return type of a funtion given simple name

Parameters:

name - Expected to be in form of <some enum constant>.name() For example, EqualiyFunctions.DATE_EQUAL.name() You can also use RuleExpressionEntry.BuiltInFunctions.DATE_EQUAL.name()

Throws:

InvalidArgumentException - if function name is not one of the supported built-in functions

getFunctionReturnValueType

public static FunctionEntry.ARG_TYPE getFunctionReturnValueType(java.lang.String name)
                                                         throws InvalidArgumentException

Returns type of value returned by a funtion given simple name

Parameters:

name - Expected to be in form of <some enum constant>.name() For example, EqualiyFunctions.DATE_EQUAL.name() You can also use RuleExpressionEntry.BuiltInFunctions.DATE_EQUAL.name()

Throws:

InvalidArgumentException - if function name is not one of the supported built-in functions

getFunctionInputParameters

public static BuiltInFunctionsHandler.SupportedArgTypes[] getFunctionInputParameters(java.lang.String name)
                                                                              throws InvalidArgumentException

Returns list of function input parameters given name. Note, for functions with variable number of arguments, this list will contain types of minimum number of input parameters. Use getVarArgsInfo method to get information about variable arguments.

Parameters:

name - Expected to be in form of <some enum constant>.name() For example, EqualiyFunctions.DATE_EQUAL.name() You can also use RuleExpressionEntry.BuiltInFunctions.DATE_EQUAL.name()

Throws:

InvalidArgumentException - if function name is not one of the supported built-in functions

getFunctionParameterValueTypes

public static java.util.List<FunctionEntry.ARG_TYPE> getFunctionParameterValueTypes(java.lang.String name)
                                                                             throws InvalidArgumentException

Returns parameter value types of input parameters for a function (whether input parameter is a single object/ bag/ set of objects). A null value implies all input parameters for the function are single objects.

Throws:

InvalidArgumentException - if function name is not one of the supported built-in functions

functionHasVariableArgs

public static boolean functionHasVariableArgs(java.lang.String name)
                                       throws InvalidArgumentException

Returns true if the given function has variable number of arguments.

Parameters:

name - Expected to be in form of <some enum constant>.name() For example, EqualiyFunctions.DATE_EQUAL.name() You can also use RuleExpressionEntry.BuiltInFunctions.DATE_EQUAL.name()

Throws:

InvalidArgumentException - if function name is not one of the supported built-in functions

getFunctionVarArgsInfo

public static VarArgsInfo getFunctionVarArgsInfo(java.lang.String name)
                                          throws InvalidArgumentException

Returns variable argument information for a funtion given simple name

Parameters:

name - Expected to be in form of <some enum constant>.name() For example, EqualiyFunctions.DATE_EQUAL.name() You can also use RuleExpressionEntry.BuiltInFunctions.DATE_EQUAL.name()

Throws:

InvalidArgumentException - if function name is not one of the supported built-in functions

getFunctionFullyQualifiedName

public static java.lang.String getFunctionFullyQualifiedName(java.lang.String name)
                                                      throws InvalidArgumentException

Returns fully qualified name for a funtion given simple name

Parameters:

name - Expected to be in form of <some enum constant>.name() For example, EqualiyFunctions.DATE_EQUAL.name() You can also use RuleExpressionEntry.BuiltInFunctions.DATE_EQUAL.name()

Throws:

InvalidArgumentException - if function name is not one of the supported built-in functions

getList

public static java.util.List<java.lang.Class<? extends ExpressionComponent>> getList(BuiltInFunctionsHandler.SupportedArgTypes... a)

getDisplayNameInEnglish

public static java.lang.String getDisplayNameInEnglish(java.lang.String functionName)

Returns english language display name for a funtion given simple name

Parameters:

name - Expected to be in form of <some enum constant>.name() For example, EqualiyFunctions.DATE_EQUAL.name() You can also use RuleExpressionEntry.BuiltInFunctions.DATE_EQUAL.name() Returns null, if the function is not supported.

getDescriptionInEnglish

public static java.lang.String getDescriptionInEnglish(java.lang.String functionName)

Returns english language description for a funtion given simple name

Parameters:

name - Expected to be in form of <some enum constant>.name() For example, EqualiyFunctions.DATE_EQUAL.name() You can also use RuleExpressionEntry.BuiltInFunctions.DATE_EQUAL.name() Returns null, if the function is not supported.

Skip navigation links