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

java.lang.Object
  extended by org.apache.directory.shared.ldap.message.internal.InternalAbstractMessage
      extended by org.apache.directory.shared.ldap.message.internal.InternalAbstractRequest
          extended by org.apache.directory.shared.ldap.message.ExtendedRequestImpl
              extended by org.apache.directory.shared.ldap.message.extended.StoredProcedureRequest
All Implemented Interfaces:
java.io.Serializable, javax.naming.ldap.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
static java.lang.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
StoredProcedureRequest(int messageId)
           
StoredProcedureRequest(int messageId, java.lang.String procedure, java.lang.String language)
           
 
Method Summary
 void addParameter(java.lang.Object type, java.lang.Object value)
           
 javax.naming.ldap.ExtendedResponse createExtendedResponse(java.lang.String id, byte[] berValue, int offset, int length)
           
 byte[] getEncodedValue()
           
 java.lang.Class<?> getJavaParameterType(int index)
           
 java.lang.Object getJavaParameterValue(int index)
           
 java.lang.String getLanguage()
           
 java.lang.Object getParameterType(int index)
           
 java.lang.Object getParameterValue(int index)
           
 byte[] getPayload()
          Gets the extended request's requestValue portion of the PDU.
 java.lang.String getProcedureSpecification()
           
 InternalResultResponse getResultResponse()
          The result containing response for this request.
 void setLanguage(java.lang.String language)
           
 void setPayload(byte[] payload)
          Sets the extended request's requestValue portion of the PDU.
 void setProcedure(java.lang.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 java.lang.String EXTENSION_OID
See Also:
Constant Field Values
Constructor Detail

StoredProcedureRequest

public StoredProcedureRequest(int messageId)

StoredProcedureRequest

public StoredProcedureRequest(int messageId,
                              java.lang.String procedure,
                              java.lang.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 javax.naming.ldap.ExtendedResponse createExtendedResponse(java.lang.String id,
                                                                 byte[] berValue,
                                                                 int offset,
                                                                 int length)
                                                          throws javax.naming.NamingException
Specified by:
createExtendedResponse in interface javax.naming.ldap.ExtendedRequest
Overrides:
createExtendedResponse in class ExtendedRequestImpl
Throws:
javax.naming.NamingException

getEncodedValue

public byte[] getEncodedValue()
Specified by:
getEncodedValue in interface javax.naming.ldap.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 java.lang.String getLanguage()

setLanguage

public void setLanguage(java.lang.String language)

setProcedure

public void setProcedure(java.lang.String procedure)

getProcedureSpecification

public java.lang.String getProcedureSpecification()

size

public int size()

getParameterType

public java.lang.Object getParameterType(int index)

getJavaParameterType

public java.lang.Class<?> getJavaParameterType(int index)

getParameterValue

public java.lang.Object getParameterValue(int index)

getJavaParameterValue

public java.lang.Object getJavaParameterValue(int index)

addParameter

public void addParameter(java.lang.Object type,
                         java.lang.Object value)


Copyright © 2003-2011 Apache Software Foundation. All Rights Reserved.