org.apache.directory.shared.ldap.extras.extended
Class StoredProcedureRequest

java.lang.Object
  org.apache.directory.shared.ldap.model.message.AbstractMessage
      org.apache.directory.shared.ldap.model.message.AbstractRequest
          org.apache.directory.shared.ldap.model.message.ExtendedRequestImpl
              org.apache.directory.shared.ldap.extras.extended.StoredProcedureRequest

All Implemented Interfaces:

ExtendedRequest, Message, Request, ResultResponseRequest, SingleReplyRequest

public class StoredProcedureRequest
extends ExtendedRequestImpl

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

Author:

Apache Directory Project

Field Summary

static String

EXTENSION_OID The OID for the stored procedure extended operation request.

Fields inherited from class org.apache.directory.shared.ldap.model.message.ExtendedRequestImpl

requestValue, response

Fields inherited from class org.apache.directory.shared.ldap.model.message.AbstractMessage

controls

Fields inherited from interface org.apache.directory.shared.ldap.model.message.ExtendedRequest

RESP_TYPE, TYPE

Constructor Summary

StoredProcedureRequest(int messageId)
Instantiates a new stored procedure request.

StoredProcedureRequest(int messageId, String procedure, String language)
Instantiates a new stored procedure request.

Method Summary

void	addParameter(Object type, Object value) Adds the parameter.
ExtendedResponse	createExtendedResponse(String id, byte[] berValue, int offset, int length)
Class<?>	getJavaParameterType(int index) Gets the java parameter type.
Object	getJavaParameterValue(int index) Gets the java parameter value.
String	getLanguage() Gets the language.
Object	getParameterType(int index) Gets the parameter type.
Object	getParameterValue(int index) Gets the parameter value.
String	getProcedureSpecification() Gets the procedure specification.
byte[]	getRequestValue()
ResultResponse	getResultResponse()
void	setLanguage(String language) Sets the language.
void	setProcedure(String procedure) Sets the procedure.
void	setRequestValue(byte[] payload)
int	size() Size.

Methods inherited from class org.apache.directory.shared.ldap.model.message.ExtendedRequestImpl

equals, getRequestName, getResponseType, hashCode, setRequestName, toString

Methods inherited from class org.apache.directory.shared.ldap.model.message.AbstractRequest

hasResponse

Methods inherited from class org.apache.directory.shared.ldap.model.message.AbstractMessage

addAllControls, addControl, get, getControl, getControls, getMessageId, getType, hasControl, put, removeControl, setMessageId

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

hasResponse

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

addAllControls, addControl, get, getControl, getControls, getMessageId, getType, hasControl, put, removeControl, setMessageId

Field Detail

EXTENSION_OID

public static final String EXTENSION_OID

The OID for the stored procedure extended operation request.

See Also:

Constant Field Values

Constructor Detail

StoredProcedureRequest

public StoredProcedureRequest(int messageId)

Instantiates a new stored procedure request.

Parameters:

messageId - the message id

StoredProcedureRequest

public StoredProcedureRequest(int messageId,
                              String procedure,
                              String language)

Instantiates a new stored procedure request.

Parameters:

messageId - the message id

procedure - the procedure

language - the language

Method Detail

setRequestValue

public void setRequestValue(byte[] payload)

Specified by:

setRequestValue in interface ExtendedRequest

Overrides:

setRequestValue in class ExtendedRequestImpl

createExtendedResponse

public ExtendedResponse createExtendedResponse(String id,
                                               byte[] berValue,
                                               int offset,
                                               int length)
                                        throws NamingException

Overrides:

createExtendedResponse in class ExtendedRequestImpl

Throws:

NamingException

getRequestValue

public byte[] getRequestValue()

Specified by:

getRequestValue in interface ExtendedRequest

Overrides:

getRequestValue in class ExtendedRequestImpl

getResultResponse

public ResultResponse getResultResponse()

Specified by:

getResultResponse in interface ResultResponseRequest

Overrides:

getResultResponse in class ExtendedRequestImpl

getLanguage

public String getLanguage()

Gets the language.

Returns:

the language

setLanguage

public void setLanguage(String language)

Sets the language.

Parameters:

language - the new language

setProcedure

public void setProcedure(String procedure)

Sets the procedure.

Parameters:

procedure - the new procedure

getProcedureSpecification

public String getProcedureSpecification()

Gets the procedure specification.

Returns:

the procedure specification

size

public int size()

Size.

Returns:

the int

getParameterType

public Object getParameterType(int index)

Gets the parameter type.

Parameters:

index - the index

Returns:

the parameter type

getJavaParameterType

public Class<?> getJavaParameterType(int index)

Gets the java parameter type.

Parameters:

index - the index

Returns:

the java parameter type

getParameterValue

public Object getParameterValue(int index)

Gets the parameter value.

Parameters:

index - the index

Returns:

the parameter value

getJavaParameterValue

public Object getJavaParameterValue(int index)

Gets the java parameter value.

Parameters:

index - the index

Returns:

the java parameter value

addParameter

public void addParameter(Object type,
                         Object value)

Adds the parameter.

Parameters:

type - the type

value - the value