org.apache.directory.server.core.api.sp

Interface StoredProcEngine

All Known Implementing Classes:

JavaStoredProcEngine

public interface StoredProcEngine

An abstraction over stored procedure execution depending on the type of the language supported.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getSPLangId() Returns the unique identifier of the supported stored procedure language.
java.lang.Object	invokeProcedure(CoreSession session, java.lang.String fullSPName, java.lang.Object[] spArgs) Invokes the stored procedure handled by the engine.
void	setSPUnitEntry(org.apache.directory.api.ldap.model.entry.Entry spUnit) Registers an entry found to be contaning a stored procedure unit which this engine can operate on.

Method Detail

getSPLangId

java.lang.String getSPLangId()

Returns the unique identifier of the supported stored procedure language.

setSPUnitEntry

void setSPUnitEntry(org.apache.directory.api.ldap.model.entry.Entry spUnit)

Registers an entry found to be contaning a stored procedure unit which this engine can operate on.

This method should be called before an attempt to invoke a stored procedure via this Engine.

invokeProcedure

java.lang.Object invokeProcedure(CoreSession session,
                                 java.lang.String fullSPName,
                                 java.lang.Object[] spArgs)
                          throws org.apache.directory.api.ldap.model.exception.LdapException

Invokes the stored procedure handled by the engine.

Parameters:

fullSPName - A fully qualified name of the stored procedure including its unit name.

spArgs - A list or arguments to be passed to the stored procedure. It should be an empty array if there aren't any parameters defined.

Returns:

The value obtained from invoked procedure. The client should know what will return exactly so that it can downcast to the appropriate type.

Throws:

org.apache.directory.api.ldap.model.exception.LdapException - If an error occurs during invocation.