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.decorators.ExtendedRequestDecorator<org.apache.directory.api.ldap.extras.extended.storedProcedure.StoredProcedureRequest>

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

All Implemented Interfaces:

org.apache.directory.api.asn1.Asn1Object, org.apache.directory.api.ldap.codec.api.Decorator<org.apache.directory.api.ldap.extras.extended.storedProcedure.StoredProcedureRequest>, org.apache.directory.api.ldap.extras.extended.storedProcedure.StoredProcedureRequest, org.apache.directory.api.ldap.model.message.AbandonableRequest, 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

public class StoredProcedureRequestDecorator
extends org.apache.directory.api.ldap.codec.decorators.ExtendedRequestDecorator<org.apache.directory.api.ldap.extras.extended.storedProcedure.StoredProcedureRequest>
implements org.apache.directory.api.ldap.extras.extended.storedProcedure.StoredProcedureRequest

A Decorator for stored procedure extended operation requests.

Author:

Apache Directory Project

Field Summary

Fields

Modifier and Type	Field and Description
private org.apache.directory.api.ldap.extras.extended.storedProcedure.StoredProcedureParameter	currentParameter
private static org.slf4j.Logger	LOG
private List<Integer>	parameterLength The list of all parameter lengths
private int	parametersLength The parameters length
private int	storedProcedureLength The stored procedure length

Fields inherited from class org.apache.directory.api.ldap.codec.decorators.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(org.apache.directory.api.ldap.codec.api.LdapApiService codec) Create a new StoredProcedureRequestDecorator instance
StoredProcedureRequestDecorator(org.apache.directory.api.ldap.codec.api.LdapApiService codec, org.apache.directory.api.ldap.extras.extended.storedProcedure.StoredProcedureRequest decoratedRequest) Create a new StoredProcedureRequestDecorator instance

Method Summary

Modifier and Type	Method and Description
void	addParameter(Object type, Object value)
void	addParameter(org.apache.directory.api.ldap.extras.extended.storedProcedure.StoredProcedureParameter parameter)
(package private) int	computeLengthInternal() Compute the StoredProcedure length
(package private) ByteBuffer	encodeInternal() Encodes the StoredProcedure extended operation.
org.apache.directory.api.ldap.extras.extended.storedProcedure.StoredProcedureParameter	getCurrentParameter()
Class<?>	getJavaParameterType(int index)
Object	getJavaParameterValue(int index)
String	getLanguage()
List<org.apache.directory.api.ldap.extras.extended.storedProcedure.StoredProcedureParameter>	getParameters()
Object	getParameterType(int index)
Object	getParameterValue(int index)
byte[]	getProcedure()
String	getProcedureSpecification()
byte[]	getRequestValue()
void	setCurrentParameter(org.apache.directory.api.ldap.extras.extended.storedProcedure.StoredProcedureParameter currentParameter) Sets the current parameter
void	setLanguage(String language)
void	setProcedure(byte[] procedure)
void	setRequestValue(byte[] payload)
int	size()
String	toString() Returns the StoredProcedure string

Methods inherited from class org.apache.directory.api.ldap.codec.decorators.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 org.apache.directory.api.ldap.extras.extended.storedProcedure.StoredProcedureParameter currentParameter

storedProcedureLength

private int storedProcedureLength

The stored procedure length

parametersLength

private int parametersLength

The parameters length

parameterLength

private List<Integer> parameterLength

The list of all parameter lengths

Constructor Detail

StoredProcedureRequestDecorator

public StoredProcedureRequestDecorator(org.apache.directory.api.ldap.codec.api.LdapApiService codec)

Create a new StoredProcedureRequestDecorator instance

Parameters:

codec - The LDAP API service to use

StoredProcedureRequestDecorator

public StoredProcedureRequestDecorator(org.apache.directory.api.ldap.codec.api.LdapApiService codec,
                                       org.apache.directory.api.ldap.extras.extended.storedProcedure.StoredProcedureRequest decoratedRequest)

Create a new StoredProcedureRequestDecorator instance

Parameters:

codec - The LDAP API service to use

decoratedRequest - The decorated request

Method Detail

getCurrentParameter

public org.apache.directory.api.ldap.extras.extended.storedProcedure.StoredProcedureParameter getCurrentParameter()

Returns:

The current parameter

setCurrentParameter

public void setCurrentParameter(org.apache.directory.api.ldap.extras.extended.storedProcedure.StoredProcedureParameter currentParameter)

Sets the current parameter

Parameters:

currentParameter - The current parameter

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

ByteBuffer encodeInternal()
                   throws org.apache.directory.api.asn1.EncoderException

Encodes the StoredProcedure extended operation.

Returns:

A ByteBuffer that contains the encoded PDU

Throws:

org.apache.directory.api.asn1.EncoderException - If anything goes wrong.

toString

public String toString()

Returns the StoredProcedure string

Overrides:

toString in class org.apache.directory.api.ldap.codec.api.MessageDecorator<org.apache.directory.api.ldap.extras.extended.storedProcedure.StoredProcedureRequest>

Returns:

The StoredProcedure string

setProcedure

public void setProcedure(byte[] procedure)

Specified by:

setProcedure in interface org.apache.directory.api.ldap.extras.extended.storedProcedure.StoredProcedureRequest

setRequestValue

public void setRequestValue(byte[] payload)

Overrides:

setRequestValue in class org.apache.directory.api.ldap.codec.decorators.ExtendedRequestDecorator<org.apache.directory.api.ldap.extras.extended.storedProcedure.StoredProcedureRequest>

getRequestValue

public byte[] getRequestValue()

Overrides:

getRequestValue in class org.apache.directory.api.ldap.codec.decorators.ExtendedRequestDecorator<org.apache.directory.api.ldap.extras.extended.storedProcedure.StoredProcedureRequest>

getLanguage

public String getLanguage()

Specified by:

getLanguage in interface org.apache.directory.api.ldap.extras.extended.storedProcedure.StoredProcedureRequest

setLanguage

public void setLanguage(String language)

Specified by:

setLanguage in interface org.apache.directory.api.ldap.extras.extended.storedProcedure.StoredProcedureRequest

getProcedureSpecification

public String getProcedureSpecification()

Specified by:

getProcedureSpecification in interface org.apache.directory.api.ldap.extras.extended.storedProcedure.StoredProcedureRequest

size

public int size()

Specified by:

size in interface org.apache.directory.api.ldap.extras.extended.storedProcedure.StoredProcedureRequest

getParameterType

public Object getParameterType(int index)

Specified by:

getParameterType in interface org.apache.directory.api.ldap.extras.extended.storedProcedure.StoredProcedureRequest

getJavaParameterType

public Class<?> getJavaParameterType(int index)

Specified by:

getJavaParameterType in interface org.apache.directory.api.ldap.extras.extended.storedProcedure.StoredProcedureRequest

getParameterValue

public Object getParameterValue(int index)

Specified by:

getParameterValue in interface org.apache.directory.api.ldap.extras.extended.storedProcedure.StoredProcedureRequest

getJavaParameterValue

public Object getJavaParameterValue(int index)

Specified by:

getJavaParameterValue in interface org.apache.directory.api.ldap.extras.extended.storedProcedure.StoredProcedureRequest

addParameter

public void addParameter(Object type,
                         Object value)

Specified by:

addParameter in interface org.apache.directory.api.ldap.extras.extended.storedProcedure.StoredProcedureRequest

getProcedure

public byte[] getProcedure()

Specified by:

getProcedure in interface org.apache.directory.api.ldap.extras.extended.storedProcedure.StoredProcedureRequest

getParameters

public List<org.apache.directory.api.ldap.extras.extended.storedProcedure.StoredProcedureParameter> getParameters()

Specified by:

getParameters in interface org.apache.directory.api.ldap.extras.extended.storedProcedure.StoredProcedureRequest

addParameter

public void addParameter(org.apache.directory.api.ldap.extras.extended.storedProcedure.StoredProcedureParameter parameter)

Specified by:

addParameter in interface org.apache.directory.api.ldap.extras.extended.storedProcedure.StoredProcedureRequest