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

Class StoredProcedureRequestDecorator

java.lang.Object

org.apache.directory.api.ldap.codec.api.MessageDecorator<M>

org.apache.directory.api.ldap.codec.decorators.RequestDecorator<M>

org.apache.directory.api.ldap.codec.decorators.ResultResponseRequestDecorator<M>

org.apache.directory.api.ldap.codec.decorators.SingleReplyRequestDecorator<Q>

org.apache.directory.api.ldap.codec.api.ExtendedRequestDecorator<StoredProcedureRequest>

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

All Implemented Interfaces:

Asn1Object, Decorator<StoredProcedureRequest>, StoredProcedureRequest, AbandonableRequest, ExtendedRequest, Message, Request, ResultResponseRequest, SingleReplyRequest

public class StoredProcedureRequestDecorator
extends ExtendedRequestDecorator<StoredProcedureRequest>
implements StoredProcedureRequest

A Decorator for stored procedure extended operation requests.

Field Summary

Fields

Modifier and Type	Field and Description
private StoredProcedureParameter	currentParameter
private static org.slf4j.Logger	LOG
private java.util.List<java.lang.Integer>	parameterLength The list of all parameter lengths
private int	parametersLength The parameters length
private java.util.List<java.lang.Integer>	paramTypeLength The list of all parameter type lengths
private java.util.List<java.lang.Integer>	paramValueLength The list of all parameter value lengths
private int	storedProcedureLength The stored procedure length

Fields inherited from class org.apache.directory.api.ldap.codec.api.ExtendedRequestDecorator

requestValue

Fields inherited from class org.apache.directory.api.ldap.codec.api.MessageDecorator

messageLength

Fields inherited from interface org.apache.directory.api.ldap.extras.extended.storedProcedure.StoredProcedureRequest

EXTENSION_OID

Constructor Summary

Constructors

Constructor and Description
StoredProcedureRequestDecorator(LdapApiService codec)
StoredProcedureRequestDecorator(LdapApiService codec, StoredProcedureRequest decoratedRequest)

Method Summary

Modifier and Type	Method and Description
void	addParameter(java.lang.Object type, java.lang.Object value) Adds the parameter.
void	addParameter(StoredProcedureParameter parameter)
(package private) int	computeLengthInternal() Compute the StoredProcedure length
(package private) java.nio.ByteBuffer	encodeInternal() Encodes the StoredProcedure extended operation.
StoredProcedureParameter	getCurrentParameter()
java.lang.Class<?>	getJavaParameterType(int index) Gets the java parameter type.
java.lang.Object	getJavaParameterValue(int index) Gets the java parameter value.
java.lang.String	getLanguage() Gets the language.
java.util.List<StoredProcedureParameter>	getParameters()
java.lang.Object	getParameterType(int index) Gets the parameter type.
java.lang.Object	getParameterValue(int index) Gets the parameter value.
byte[]	getProcedure()
java.lang.String	getProcedureSpecification() Gets the procedure specification.
byte[]	getRequestValue()
void	setCurrentParameter(StoredProcedureParameter currentParameter)
void	setLanguage(java.lang.String language) Sets the language.
void	setProcedure(byte[] procedure)
void	setRequestValue(byte[] payload)
int	size() Size.
java.lang.String	toString() Returns the StoredProcedure string

Methods inherited from class org.apache.directory.api.ldap.codec.api.ExtendedRequestDecorator

addAllControls, addControl, computeLength, encode, getRequestName, removeControl, setMessageId, setRequestName

Methods inherited from class org.apache.directory.api.ldap.codec.decorators.SingleReplyRequestDecorator

abandon, addAbandonListener, getResponseType, isAbandoned

Methods inherited from class org.apache.directory.api.ldap.codec.decorators.ResultResponseRequestDecorator

getResultResponse, hasResponse

Methods inherited from class org.apache.directory.api.ldap.codec.api.MessageDecorator

get, getCodecService, getControl, getControls, getControlsLength, getCurrentControl, getDecorated, getDecorator, getMessageId, getMessageLength, getType, hasControl, put, setControlsLength, setMessageLength

Methods inherited from class java.lang.Object

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

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

LOG

private static final org.slf4j.Logger LOG

currentParameter

private StoredProcedureParameter currentParameter

storedProcedureLength

private int storedProcedureLength

The stored procedure length

parametersLength

private int parametersLength

The parameters length

parameterLength

private java.util.List<java.lang.Integer> parameterLength

The list of all parameter lengths

paramTypeLength

private java.util.List<java.lang.Integer> paramTypeLength

The list of all parameter type lengths

paramValueLength

private java.util.List<java.lang.Integer> paramValueLength

The list of all parameter value lengths

Constructor Detail

StoredProcedureRequestDecorator

public StoredProcedureRequestDecorator(LdapApiService codec)

StoredProcedureRequestDecorator

public StoredProcedureRequestDecorator(LdapApiService codec,
                                       StoredProcedureRequest decoratedRequest)

Method Detail

getCurrentParameter

public StoredProcedureParameter getCurrentParameter()

setCurrentParameter

public void setCurrentParameter(StoredProcedureParameter currentParameter)

computeLengthInternal

int computeLengthInternal()

Compute the StoredProcedure length

 0x30 L1 
   | 
   +--> 0x04 L2 language
   +--> 0x04 L3 procedure
  [+--> 0x30 L4 (parameters)
          |
          +--> 0x30 L5-1 (parameter)
          |      |
          |      +--> 0x04 L6-1 type
          |      +--> 0x04 L7-1 value
          |      
          +--> 0x30 L5-2 (parameter)
          |      |
          |      +--> 0x04 L6-2 type
          |      +--> 0x04 L7-2 value
          |
          +--> ...
          |      
          +--> 0x30 L5-m (parameter)
                 |
                 +--> 0x04 L6-m type
                 +--> 0x04 L7-m value
 

encodeInternal

java.nio.ByteBuffer encodeInternal()
                            throws EncoderException

Encodes the StoredProcedure extended operation.

Returns:

A ByteBuffer that contains the encoded PDU

Throws:

EncoderException - If anything goes wrong.

toString

public java.lang.String toString()

Returns the StoredProcedure string

Overrides:

toString in class MessageDecorator<StoredProcedureRequest>

Returns:

The StoredProcedure string

setProcedure

public void setProcedure(byte[] procedure)

Specified by:

setProcedure in interface StoredProcedureRequest

Parameters:

procedure - The procedure's bytecode

setRequestValue

public void setRequestValue(byte[] payload)

Overrides:

setRequestValue in class ExtendedRequestDecorator<StoredProcedureRequest>

getRequestValue

public byte[] getRequestValue()

Overrides:

getRequestValue in class ExtendedRequestDecorator<StoredProcedureRequest>

getLanguage

public java.lang.String getLanguage()

Gets the language.

Specified by:

getLanguage in interface StoredProcedureRequest

Returns:

the language

setLanguage

public void setLanguage(java.lang.String language)

Sets the language.

Specified by:

setLanguage in interface StoredProcedureRequest

Parameters:

language - the new language

getProcedureSpecification

public java.lang.String getProcedureSpecification()

Gets the procedure specification.

Specified by:

getProcedureSpecification in interface StoredProcedureRequest

Returns:

the procedure specification

size

public int size()

Size.

Specified by:

size in interface StoredProcedureRequest

Returns:

the procedure's bytcode size

getParameterType

public java.lang.Object getParameterType(int index)

Gets the parameter type.

Specified by:

getParameterType in interface StoredProcedureRequest

Parameters:

index - the index

Returns:

the parameter type

getJavaParameterType

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

Gets the java parameter type.

Specified by:

getJavaParameterType in interface StoredProcedureRequest

Parameters:

index - the index

Returns:

the java parameter type

getParameterValue

public java.lang.Object getParameterValue(int index)

Gets the parameter value.

Specified by:

getParameterValue in interface StoredProcedureRequest

Parameters:

index - the index

Returns:

the parameter value

getJavaParameterValue

public java.lang.Object getJavaParameterValue(int index)

Gets the java parameter value.

Specified by:

getJavaParameterValue in interface StoredProcedureRequest

Parameters:

index - the index

Returns:

the java parameter value

addParameter

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

Adds the parameter.

Specified by:

addParameter in interface StoredProcedureRequest

Parameters:

type - the type

value - the value

getProcedure

public byte[] getProcedure()

Specified by:

getProcedure in interface StoredProcedureRequest

Returns:

The byte[] containing the procedure's bytecode

getParameters

public java.util.List<StoredProcedureParameter> getParameters()

Specified by:

getParameters in interface StoredProcedureRequest

addParameter

public void addParameter(StoredProcedureParameter parameter)

Specified by:

addParameter in interface StoredProcedureRequest