public interface Procedure
There are two types of procedures — add-on and built-in. The add-on procedures are created and modified by the user with a set of configurable parameters (e.g. SQL text, connection pool names, etc). The built-in procedures are basically singleton procedures that cannot be modified by the user. The latter type provides services needed by the platform, such as introspection, administration and control.
Each procedure has a number of bindings, containing any resources required during execution. The bindings have different types to clarify their content, such as input argument, static data, adapter pool name or referenced procedure name.
Most classes implementing this interface should be subclasses of the AddOnProcedure class and follow the requirements for serialization and configurability defined by that class. Otherwise the procedure is considered a built-in procedure and is responsible for its own initialization and security checks. Great care must be taken when implementing this interface so that any sensitive operation is properly checked for security.
AddOnProcedure
,
Bindings
Modifier and Type | Method and Description |
---|---|
java.lang.Object |
call(CallContext cx,
Bindings bindings)
Executes a call of this procedure in the specified context
and with the specified call bindings.
|
Bindings |
getBindings()
Returns the bindings for this procedure.
|
java.lang.String |
getDescription()
Returns the procedure description.
|
java.lang.String |
getName()
Returns the procedure name.
|
java.lang.String getName()
java.lang.String getDescription()
Bindings getBindings()
java.lang.Object call(CallContext cx, Bindings bindings) throws ProcedureException
cx
- the procedure call contextbindings
- the call bindings to useProcedureException
- if the call execution caused an
error