Skip navigation links

com.bea.security.providers.authorization.asi
Interface InspectableFunction

public interface InspectableFunction

An argument meta data interface is used by Oracle Authorization Policy Manager (OAPM) to query for information about arguments expected by a custom OES function.

A developer building a custom OES function implements this optional interface to enable OAPM discover meta data about arguments used by custom function. OES loads this interface and calls interface method getArgMetadata to discover meta data such as number of arguments, argument names, types, etc. For each argument expected by the function starting with the first argument (argument number 0), getArgMetadata must return meta data describing the argument. Once OAPM collects meta data about each argument expected by the function, it then uses interface methods getArgValue and isValidArgValue to automate the process of working with custom OES functions.

There is an implicit assumption that a function argument ArgN may depend on arguments Arg1...ArgN-1. That is, a change in one argument may need to force a reset of values for all dependent arguments. This dependency is managed via meta data properties Dependent and OnChangeClearDependentArgs.

Nested Class Summary

static class

InspectableFunction.ArgMetadata Argument meta data class is used to track meta data about an argument.

Method Summary

java.util.ArrayList<InspectableFunction.ArgMetadata>	getArgMetadata(java.lang.String functionName) Return argument meta data for a specific function.
java.util.ArrayList<oracle.security.jps.service.policystore.info.DataType>	getArgValues(java.lang.String functionName, int argNumber, java.util.ArrayList<oracle.security.jps.service.policystore.info.DataType> prevArgValues) Request argument values for a specific argument.
java.lang.Class<? extends oracle.security.jps.service.policystore.info.DataType>	getReturnType(java.lang.String functionName) Request return type for a specific function.
java.util.ArrayList<oracle.security.jps.service.policystore.info.DataType>	getReturnValues(java.lang.String functionName, java.util.ArrayList<oracle.security.jps.service.policystore.info.DataType> argValues) Request return values for a specific function.
boolean	isValidArgValue(java.lang.String functionName, int argNumber, oracle.security.jps.service.policystore.info.DataType argValue, java.util.ArrayList<oracle.security.jps.service.policystore.info.DataType> prevArgValues) Validate if a value provided for a specific argument is valid.

Method Detail

getArgMetadata

java.util.ArrayList<InspectableFunction.ArgMetadata> getArgMetadata(java.lang.String functionName)
                                                                    throws java.lang.RuntimeException

Return argument meta data for a specific function.

Parameters:

functionName - function name.

Returns:

ArrayList<ArgMetaData> array of argument meta data object instances.

Throws:

java.lang.RuntimeException

getArgValues

java.util.ArrayList<oracle.security.jps.service.policystore.info.DataType> getArgValues(java.lang.String functionName,
                                                                                        int argNumber,
                                                                                        java.util.ArrayList<oracle.security.jps.service.policystore.info.DataType> prevArgValues)
                                                                                        throws java.lang.RuntimeException

Request argument values for a specific argument.

Parameters:

functionName - function name.

argNumber - argument number.

prevArgValues - previous argument values.

Returns:

ArrayList<DataType> array of argument meta data object instances.

Throws:

java.lang.RuntimeException

getReturnType

java.lang.Class<? extends oracle.security.jps.service.policystore.info.DataType> getReturnType(java.lang.String functionName)
                                                                                               throws java.lang.RuntimeException

Request return type for a specific function.

Parameters:

functionName - function name.

Returns:

DataType return data type.

Throws:

java.lang.RuntimeException

getReturnValues

java.util.ArrayList<oracle.security.jps.service.policystore.info.DataType> getReturnValues(java.lang.String functionName,
                                                                                           java.util.ArrayList<oracle.security.jps.service.policystore.info.DataType> argValues)
                                                                                           throws java.lang.RuntimeException

Request return values for a specific function.

Parameters:

functionName - function name.

argValues - values for all arguments.

Returns:

ArrayList<DataType> array of argument meta data object instances.

Throws:

java.lang.RuntimeException

isValidArgValue

boolean isValidArgValue(java.lang.String functionName,
                        int argNumber,
                        oracle.security.jps.service.policystore.info.DataType argValue,
                        java.util.ArrayList<oracle.security.jps.service.policystore.info.DataType> prevArgValues)
                        throws java.lang.RuntimeException

Validate if a value provided for a specific argument is valid.

Parameters:

functionName - function name.

argNumber - argument number.

argValue - argument value.

prevArgValues - previous argument values.

Returns:

boolean true if the value is valid; false otherwise

Throws:

java.lang.RuntimeException

Skip navigation links