Skip navigation links

oracle.security.jps.service.policystore.info
Interface FunctionEntry

public interface FunctionEntry

A representation of a function used in policy rule condition.

A function must have return value type, may have a list of parameters.

Note: This interface is defined as a mechanism to exchange information only. The consumer must not implement this interface. Rather, the consumer should rely upon the existing public classes that implement this interface.

Nested Class Summary

static class

FunctionEntry.ARG_TYPE Specifies type of input parameter or return value, whether it is single/ bag/ set.

Method Summary

java.lang.String	getCategory() Returns category of this function.
java.lang.String	getDescription() Get the description of the entity.
java.lang.String	getDisplayName() Returns the Display name.
java.lang.String	getFunctionClassName() Get the class name which implements the function at runtime
java.net.URI	getFunctionURI() Return complete function name in URI format.
java.lang.String	getName() Name of the entry.
java.util.List<java.lang.Class<? extends DataType>>	getParameterTypes() Get a list of input parameters.
java.util.List<FunctionEntry.ARG_TYPE>	getParameterValueTypes() Returns the value type of each input parameter to the function.
java.lang.Class<? extends DataType>	getReturnType() Get return value type.
FunctionEntry.ARG_TYPE	getReturnValueType() Get type of returned value
java.lang.String	getSimpleName() Return partial name of the function.
VarArgsInfo	getVarArgsDetails() Returns details of the variable number of input parameters.
boolean	hasVariableParameters() Returns true if this function takes variable number of input parameters.
boolean	isBuiltInFunction() If it is a built-in function, return true, else, return false
void	setDescription(java.lang.String description) Set the description of this entry.
void	setDisplayName(java.lang.String displayName) Set the display name of this entry.
void	setFunctionClassName(java.lang.String className) Set the class name which implements the function at runtime
void	setParameterTypes(java.util.List<java.lang.Class<? extends DataType>> parameters) Set the input parameters' type.
void	setReturnType(java.lang.Class<? extends DataType> type) Set return value type.

Method Detail

getParameterTypes

java.util.List<java.lang.Class<? extends DataType>> getParameterTypes()

Get a list of input parameters. In case this function takes a variable number of input parameters, this method will return the types of minimum required inputs, if any. For example, logical functions like AND and OR can take an unbound number of input parameters but require minimum 2 OpssBoolean type parameters. So this method will return {OpssBoolean.class,OpssBoolean.class} for AND or OR functions.

Returns:

list of input parameters

getParameterValueTypes

java.util.List<FunctionEntry.ARG_TYPE> getParameterValueTypes()

Returns the value type of each input parameter to the function. The list returned corresponds to the list of input parameters returned by the getParameterTypes() method. Each element represents value type of the corresponding element in the input parameters list.

hasVariableParameters

boolean hasVariableParameters()

Returns true if this function takes variable number of input parameters. For most functions this method will remain false. For functions like AND or OR, this method will return true.

getVarArgsDetails

VarArgsInfo getVarArgsDetails()

Returns details of the variable number of input parameters. For methods that have a fixed number of input parameters (that is for which hasVariableParameters() returns false) this method will return null.

getReturnType

java.lang.Class<? extends DataType> getReturnType()

Get return value type.

Returns:

return value type

getReturnValueType

FunctionEntry.ARG_TYPE getReturnValueType()

Get type of returned value

getFunctionClassName

java.lang.String getFunctionClassName()

Get the class name which implements the function at runtime

Returns:

function class name.

setFunctionClassName

void setFunctionClassName(java.lang.String className)

Set the class name which implements the function at runtime

Parameters:

className -

setParameterTypes

void setParameterTypes(java.util.List<java.lang.Class<? extends DataType>> parameters)
                       throws PolicyStoreException

Set the input parameters' type.

Parameters:

parameters - input parameters' type

Throws:

PolicyStoreException

setReturnType

void setReturnType(java.lang.Class<? extends DataType> type)
                   throws PolicyStoreException

Set return value type.

Parameters:

type - return value type

Throws:

PolicyStoreException

getSimpleName

java.lang.String getSimpleName()

Return partial name of the function.

Returns:

partial name of the function

getFunctionURI

java.net.URI getFunctionURI()

Return complete function name in URI format.

Returns:

complete function name in URI format

isBuiltInFunction

boolean isBuiltInFunction()

If it is a built-in function, return true, else, return false

Returns:

true if this is a built in function, false otherwise.

getDescription

java.lang.String getDescription()

Get the description of the entity.

Returns:

the description of the entity.

getDisplayName

java.lang.String getDisplayName()

Returns the Display name.

Returns:

the display name.

getName

java.lang.String getName()

Name of the entry.

Returns:

the name of the entry.

setDescription

void setDescription(java.lang.String description)

Set the description of this entry.

Parameters:

description -

setDisplayName

void setDisplayName(java.lang.String displayName)

Set the display name of this entry.

Parameters:

displayName -

getCategory

java.lang.String getCategory()

Returns category of this function.

Skip navigation links