org.apache.directory.api.ldap.extras.extended.storedProcedure

Interface StoredProcedureRequest

All Superinterfaces:

org.apache.directory.api.ldap.model.message.ExtendedRequest, org.apache.directory.api.ldap.model.message.Message, org.apache.directory.api.ldap.model.message.Request, org.apache.directory.api.ldap.model.message.ResultResponseRequest, org.apache.directory.api.ldap.model.message.SingleReplyRequest

All Known Implementing Classes:

StoredProcedureRequestImpl

public interface StoredProcedureRequest
extends org.apache.directory.api.ldap.model.message.ExtendedRequest

An extended operation requesting the server to execute a stored procedure.

Author:

Apache Directory Project

Field Summary

Fields

Modifier and Type	Field and Description
static String	EXTENSION_OID The OID for the stored procedure extended operation request.

Method Summary

Modifier and Type	Method and Description
void	addParameter(Object type, Object value) Adds the parameter.
void	addParameter(StoredProcedureParameter parameter) Adds a parameter
Class<?>	getJavaParameterType(int index) Gets the java parameter type.
Object	getJavaParameterValue(int index) Gets the java parameter value.
String	getLanguage() Gets the language.
List<StoredProcedureParameter>	getParameters()
Object	getParameterType(int index) Gets the parameter type.
Object	getParameterValue(int index) Gets the parameter value.
byte[]	getProcedure()
String	getProcedureSpecification() Gets the procedure specification.
void	setLanguage(String language) Sets the language.
void	setProcedure(byte[] procedure)
int	size() Size.

Methods inherited from interface org.apache.directory.api.ldap.model.message.ExtendedRequest

addAllControls, addControl, getRequestName, removeControl, setMessageId, setRequestName

Methods inherited from interface org.apache.directory.api.ldap.model.message.SingleReplyRequest

getResponseType

Methods inherited from interface org.apache.directory.api.ldap.model.message.ResultResponseRequest

getResultResponse

Methods inherited from interface org.apache.directory.api.ldap.model.message.Request

hasResponse

Methods inherited from interface org.apache.directory.api.ldap.model.message.Message

get, getControl, getControls, getMessageId, getType, hasControl, put

Field Detail

EXTENSION_OID

static final String EXTENSION_OID

The OID for the stored procedure extended operation request.

See Also:

Constant Field Values

Method Detail

getLanguage

String getLanguage()

Gets the language.

Returns:

the language

setLanguage

void setLanguage(String language)

Sets the language.

Parameters:

language - the new language

getProcedure

byte[] getProcedure()

Returns:

The byte[] containing the procedure's bytecode

setProcedure

void setProcedure(byte[] procedure)

Parameters:

procedure - The procedure's bytecode

getProcedureSpecification

String getProcedureSpecification()

Gets the procedure specification.

Returns:

the procedure specification

size

int size()

Size.

Returns:

the procedure's bytcode size

getParameterType

Object getParameterType(int index)

Gets the parameter type.

Parameters:

index - the index

Returns:

the parameter type

getJavaParameterType

Class<?> getJavaParameterType(int index)

Gets the java parameter type.

Parameters:

index - the index

Returns:

the java parameter type

getParameterValue

Object getParameterValue(int index)

Gets the parameter value.

Parameters:

index - the index

Returns:

the parameter value

getJavaParameterValue

Object getJavaParameterValue(int index)

Gets the java parameter value.

Parameters:

index - the index

Returns:

the java parameter value

addParameter

void addParameter(Object type,
                  Object value)

Adds the parameter.

Parameters:

type - the type

value - the value

addParameter

void addParameter(StoredProcedureParameter parameter)

Adds a parameter

Parameters:

parameter - The parameter to add

getParameters

List<StoredProcedureParameter> getParameters()

Returns:

The list of parameters for this stored procedure