org.apache.directory.shared.ldap.message.extended

Class StoredProcedureRequest

java.lang.Object

org.apache.directory.shared.ldap.message.internal.InternalAbstractMessage

org.apache.directory.shared.ldap.message.internal.InternalAbstractRequest

org.apache.directory.shared.ldap.message.ExtendedRequestImpl

org.apache.directory.shared.ldap.message.extended.StoredProcedureRequest

All Implemented Interfaces:

Serializable, ExtendedRequest, InternalExtendedRequest, InternalMessage, InternalRequest, InternalResultResponseRequest, SingleReplyRequest

public class StoredProcedureRequest
extends ExtendedRequestImpl

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

Version:

$Rev$

Author:

Apache Directory Project

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	EXTENSION_OID

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

payload, response

Fields inherited from interface org.apache.directory.shared.ldap.message.internal.InternalExtendedRequest

RESP_TYPE, TYPE

Constructor Summary

Constructors

Constructor and Description
StoredProcedureRequest(int messageId)
StoredProcedureRequest(int messageId, String procedure, String language)

Method Summary

Modifier and Type	Method and Description
void	addParameter(Object type, Object value)
ExtendedResponse	createExtendedResponse(String id, byte[] berValue, int offset, int length)
byte[]	getEncodedValue()
Class<?>	getJavaParameterType(int index)
Object	getJavaParameterValue(int index)
String	getLanguage()
Object	getParameterType(int index)
Object	getParameterValue(int index)
byte[]	getPayload() Gets the extended request's requestValue portion of the PDU.
String	getProcedureSpecification()
InternalResultResponse	getResultResponse() The result containing response for this request.
void	setLanguage(String language)
void	setPayload(byte[] payload) Sets the extended request's requestValue portion of the PDU.
void	setProcedure(String procedure)
int	size()

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

equals, getID, getOid, getResponseType, setOid, toString

Methods inherited from class org.apache.directory.shared.ldap.message.internal.InternalAbstractRequest

hashCode, hasResponse

Methods inherited from class org.apache.directory.shared.ldap.message.internal.InternalAbstractMessage

add, addAll, get, getControls, getMessageId, getType, hasControl, put, remove

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.directory.shared.ldap.message.internal.InternalRequest

hasResponse

Methods inherited from interface org.apache.directory.shared.ldap.message.internal.InternalMessage

add, addAll, get, getControls, getMessageId, getType, hasControl, put, remove

Field Detail

EXTENSION_OID

public static final String EXTENSION_OID

See Also:

Constant Field Values

Constructor Detail

StoredProcedureRequest

public StoredProcedureRequest(int messageId)

StoredProcedureRequest

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

Method Detail

setPayload

public void setPayload(byte[] payload)

Description copied from class: ExtendedRequestImpl

Sets the extended request's requestValue portion of the PDU.

Specified by:

setPayload in interface InternalExtendedRequest

Overrides:

setPayload in class ExtendedRequestImpl

Parameters:

payload - byte array of data encapsulating ext. req. parameters

createExtendedResponse

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

Specified by:

createExtendedResponse in interface ExtendedRequest

Overrides:

createExtendedResponse in class ExtendedRequestImpl

Throws:

NamingException

getEncodedValue

public byte[] getEncodedValue()

Specified by:

getEncodedValue in interface ExtendedRequest

Overrides:

getEncodedValue in class ExtendedRequestImpl

getPayload

public byte[] getPayload()

Description copied from class: ExtendedRequestImpl

Gets the extended request's requestValue portion of the PDU. The form of the data is request specific and is determined by the extended request OID.

Specified by:

getPayload in interface InternalExtendedRequest

Overrides:

getPayload in class ExtendedRequestImpl

Returns:

byte array of data

getResultResponse

public InternalResultResponse getResultResponse()

Description copied from class: ExtendedRequestImpl

The result containing response for this request.

Specified by:

getResultResponse in interface InternalResultResponseRequest

Overrides:

getResultResponse in class ExtendedRequestImpl

Returns:

the result containing response for this request

getLanguage

public String getLanguage()

setLanguage

public void setLanguage(String language)

setProcedure

public void setProcedure(String procedure)

getProcedureSpecification

public String getProcedureSpecification()

size

public int size()

getParameterType

public Object getParameterType(int index)

getJavaParameterType

public Class<?> getJavaParameterType(int index)

getParameterValue

public Object getParameterValue(int index)

getJavaParameterValue

public Object getJavaParameterValue(int index)

addParameter

public void addParameter(Object type,
                         Object value)