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,R>

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

org.apache.directory.api.ldap.codec.api.ExtendedRequestDecorator<org.apache.directory.api.ldap.extras.extended.StoredProcedureRequest,org.apache.directory.api.ldap.extras.extended.StoredProcedureResponse>

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

All Implemented Interfaces:

org.apache.directory.api.ldap.codec.api.Decorator<org.apache.directory.api.ldap.extras.extended.StoredProcedureRequest>, org.apache.directory.api.ldap.extras.extended.StoredProcedureRequest, org.apache.directory.api.ldap.model.message.AbandonableRequest, org.apache.directory.api.ldap.model.message.ExtendedRequest<org.apache.directory.api.ldap.extras.extended.StoredProcedureResponse>, 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.extras.extended.StoredProcedureResponse>, org.apache.directory.api.ldap.model.message.SingleReplyRequest<org.apache.directory.api.ldap.extras.extended.StoredProcedureResponse>

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

A Decorator for stored procedure extended operation requests.

Author:

Apache Directory Project

Field Summary

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.StoredProcedureRequest

EXTENSION_OID

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

RESP_TYPE, TYPE

Constructor Summary

Constructors

Constructor and Description
StoredProcedureRequestDecorator(org.apache.directory.api.ldap.codec.api.LdapApiService codec)
StoredProcedureRequestDecorator(org.apache.directory.api.ldap.codec.api.LdapApiService codec, org.apache.directory.api.ldap.extras.extended.StoredProcedureRequest decoratedRequest)

Method Summary

Methods

Modifier and Type	Method and Description
void	addParameter(Object type, Object value)
void	addParameter(org.apache.directory.api.ldap.extras.extended.StoredProcedureParameter parameter)
int	computeLength() 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 | +--> ...
ByteBuffer	encode() Encode the StoredProcedure message to a PDU.
org.apache.directory.api.ldap.extras.extended.StoredProcedureParameter	getCurrentParameter()
Class<?>	getJavaParameterType(int index)
Object	getJavaParameterValue(int index)
String	getLanguage()
List<org.apache.directory.api.ldap.extras.extended.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.StoredProcedureParameter currentParameter)
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.api.ExtendedRequestDecorator

addAllControls, addControl, encode, getExtendedRequestLength, getRequestName, getRequestNameBytes, removeControl, setExtendedRequestLength, setMessageId, setRequestName, setRequestNameBytes

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

Constructor Detail

StoredProcedureRequestDecorator

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

StoredProcedureRequestDecorator

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

Method Detail

getCurrentParameter

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

setCurrentParameter

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

computeLength

public int computeLength()

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

Specified by:

computeLength in interface org.apache.directory.api.ldap.codec.api.Decorator<org.apache.directory.api.ldap.extras.extended.StoredProcedureRequest>

Overrides:

computeLength in class org.apache.directory.api.ldap.codec.api.ExtendedRequestDecorator<org.apache.directory.api.ldap.extras.extended.StoredProcedureRequest,org.apache.directory.api.ldap.extras.extended.StoredProcedureResponse>

encode

public ByteBuffer encode()
                  throws org.apache.directory.api.asn1.EncoderException

Encode the StoredProcedure message to a PDU.

Returns:

The PDU.

Throws:

org.apache.directory.api.asn1.EncoderException

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.StoredProcedureRequest>

Returns:

The StoredProcedure string

setProcedure

public void setProcedure(byte[] procedure)

Specified by:

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

setRequestValue

public void setRequestValue(byte[] payload)

Overrides:

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

getRequestValue

public byte[] getRequestValue()

Overrides:

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

getLanguage

public String getLanguage()

Specified by:

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

setLanguage

public void setLanguage(String language)

Specified by:

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

getProcedureSpecification

public String getProcedureSpecification()

Specified by:

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

size

public int size()

Specified by:

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

getParameterType

public Object getParameterType(int index)

Specified by:

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

getJavaParameterType

public Class<?> getJavaParameterType(int index)

Specified by:

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

getParameterValue

public Object getParameterValue(int index)

Specified by:

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

getJavaParameterValue

public Object getJavaParameterValue(int index)

Specified by:

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

addParameter

public void addParameter(Object type,
                Object value)

Specified by:

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

getProcedure

public byte[] getProcedure()

Specified by:

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

getParameters

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

Specified by:

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

addParameter

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

Specified by:

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