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

Class JavaStoredProcEngine

java.lang.Object

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

All Implemented Interfaces:

StoredProcEngine

public class JavaStoredProcEngine
extends Object
implements StoredProcEngine

A StoredProcEngine implementation specific to Java stored procedures.

Author:

Apache Directory Project

Field Summary

Fields

Modifier and Type	Field and Description
static String	STORED_PROC_LANG_ID

Constructor Summary

Constructors

Constructor and Description
JavaStoredProcEngine()

Method Summary

Modifier and Type	Method and Description
String	getSPLangId() Returns the unique identifier of the supported stored procedure language.
Object	invokeProcedure(CoreSession session, String fullSPName, 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.

Methods inherited from class java.lang.Object

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

Field Detail

STORED_PROC_LANG_ID

public static final String STORED_PROC_LANG_ID

See Also:

Constant Field Values

Constructor Detail

JavaStoredProcEngine

public JavaStoredProcEngine()

Method Detail

invokeProcedure

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

Description copied from interface: StoredProcEngine

Invokes the stored procedure handled by the engine.

Specified by:

invokeProcedure in interface StoredProcEngine

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.

getSPLangId

public String getSPLangId()

Description copied from interface: StoredProcEngine

Returns the unique identifier of the supported stored procedure language.

Specified by:

getSPLangId in interface StoredProcEngine

setSPUnitEntry

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

Description copied from interface: StoredProcEngine

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.

Specified by:

setSPUnitEntry in interface StoredProcEngine