org.apache.directory.shared.ldap.codec
Class TwixTransformer

java.lang.Object
  org.apache.directory.shared.ldap.codec.TwixTransformer

public class TwixTransformer
extends java.lang.Object

A Twix to Snickers Message transformer.

Version:

$Rev: 798005 $, $Date: 2009-07-27 01:43:19 +0200 (Lun, 27 jul 2009) $,

Author:

Apache Directory Project

Constructor Summary

TwixTransformer()

Method Summary

static java.lang.Object	transform(InternalMessage msg) Transform the Snickers message to a Twix message.
static InternalMessage	transform(java.lang.Object obj) Transform the Twix message to a codec neutral message.
static InternalMessage	transformAbandonRequest(LdapMessageCodec twixMessage, int messageId) Transform an AbandonRequest message from a TwixMessage to a SnickersMessage
static InternalMessage	transformAddRequest(LdapMessageCodec twixMessage, int messageId) Transform an AddRequest message from a TwixMessage to a SnickersMessage
static void	transformAddResponse(LdapMessageCodec twixMessage, InternalMessage snickersMessage) Transform a Snickers AddResponse to a Twix AddResponse
static InternalMessage	transformBindRequest(LdapMessageCodec twixMessage, int messageId) Transform a BindRequest message from a TwixMessage to a SnickersMessage
static void	transformBindRequest(LdapMessageCodec twixMessage, InternalMessage snickersMessage) Transform a Snickers BindRequest to a Twix BindRequest
static InternalMessage	transformBindResponse(LdapMessageCodec twixMessage, int messageId) Transform a BindResponse message from a TwixMessage to a SnickersMessage.
static void	transformBindResponse(LdapMessageCodec twixMessage, InternalMessage snickersMessage) Transform a Snickers BindResponse to a Twix BindResponse
static InternalMessage	transformCompareRequest(LdapMessageCodec twixMessage, int messageId) Transform a CompareRequest message from a TwixMessage to a SnickersMessage
static void	transformCompareResponse(LdapMessageCodec twixMessage, InternalMessage snickersMessage) Transform a Snickers CompareResponse to a Twix CompareResponse
static void	transformControls(LdapMessageCodec twixMessage, InternalMessage msg) Transforms the controls
static void	transformControlsTwixToSnickers(LdapMessageCodec twixMessage, InternalMessage msg) TODO finish this implementation.
static InternalMessage	transformDelRequest(LdapMessageCodec twixMessage, int messageId) Transform a DelRequest message from a TwixMessage to a SnickersMessage
static void	transformDelResponse(LdapMessageCodec twixMessage, InternalMessage snickersMessage) Transform a Snickers DelResponse to a Twix DelResponse
static InternalMessage	transformExtendedRequest(LdapMessageCodec twixMessage, int messageId) Transform an ExtendedRequest message from a TwixMessage to a SnickersMessage
static void	transformExtendedResponse(LdapMessageCodec twixMessage, InternalMessage snickersMessage) Transform a Snickers ExtendedResponse to a Twix ExtendedResponse
static Filter	transformFilter(ExprNode exprNode) Transform an ExprNode filter to a TwixFilter
static ExprNode	transformFilter(Filter twixFilter) Transform the Filter part of a SearchRequest to an ExprNode
static LdapResultCodec	transformLdapResult(LdapResultImpl snickersLdapResult) Transform a Ldapresult part of a Snickers Response to a Twix LdapResult
static void	transformLdapResultTwixToSnickers(LdapResultCodec twixResult, InternalLdapResult snickersResult) Transforms parameters of a Twix LdapResult into a Snickers LdapResult.
static InternalMessage	transformModifyDNRequest(LdapMessageCodec twixMessage, int messageId) Transform a ModifyDNRequest message from a TwixMessage to a SnickersMessage
static void	transformModifyDNResponse(LdapMessageCodec twixMessage, InternalMessage snickersMessage) Transform a Snickers ModifyDNResponse to a Twix ModifyDNResponse
static InternalMessage	transformModifyRequest(LdapMessageCodec twixMessage, int messageId) Transform a ModifyRequest message from a TwixMessage to a SnickersMessage
static void	transformModifyResponse(LdapMessageCodec twixMessage, InternalMessage snickersMessage) Transform a Snickers ModifyResponse to a Twix ModifyResponse
static InternalMessage	transformSearchRequest(LdapMessageCodec twixMessage, int messageId) Transform a SearchRequest message from a TwixMessage to a SnickersMessage
static void	transformSearchResultDone(LdapMessageCodec twixMessage, InternalMessage snickersMessage) Transform a Snickers SearchResponseDone to a Twix SearchResultDone
static void	transformSearchResultEntry(LdapMessageCodec twixMessage, InternalMessage snickersMessage) Transform a Snickers SearchResponseEntry to a Twix SearchResultEntry
static void	transformSearchResultReference(LdapMessageCodec twixMessage, InternalMessage snickersMessage) Transform a Snickers SearchResponseReference to a Twix SearchResultReference
static InternalMessage	transformUnBindRequest(LdapMessageCodec twixMessage, int messageId) Transform an UnBindRequest message from a TwixMessage to a SnickersMessage

Methods inherited from class java.lang.Object

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

Constructor Detail

TwixTransformer

public TwixTransformer()

Method Detail

transformAbandonRequest

public static InternalMessage transformAbandonRequest(LdapMessageCodec twixMessage,
                                                      int messageId)

Transform an AbandonRequest message from a TwixMessage to a SnickersMessage

Parameters:

twixMessage - The message to transform

messageId - The message Id

Returns:

A Snickers AbandonRequestImpl

transformAddRequest

public static InternalMessage transformAddRequest(LdapMessageCodec twixMessage,
                                                  int messageId)

Transform an AddRequest message from a TwixMessage to a SnickersMessage

Parameters:

twixMessage - The message to transform

messageId - The message Id

Returns:

A Snickers AddRequestImpl

transformBindRequest

public static InternalMessage transformBindRequest(LdapMessageCodec twixMessage,
                                                   int messageId)

Transform a BindRequest message from a TwixMessage to a SnickersMessage

Parameters:

twixMessage - The message to transform

messageId - The message Id

Returns:

A Snickers BindRequestImpl

transformBindResponse

public static InternalMessage transformBindResponse(LdapMessageCodec twixMessage,
                                                    int messageId)

Transform a BindResponse message from a TwixMessage to a SnickersMessage. This is used by clients which are receiving a BindResponse PDU and must decode it to return the Snickers representation.

Parameters:

twixMessage - The message to transform

messageId - The message Id

Returns:

a Snickers BindResponseImpl

transformLdapResultTwixToSnickers

public static void transformLdapResultTwixToSnickers(LdapResultCodec twixResult,
                                                     InternalLdapResult snickersResult)

Transforms parameters of a Twix LdapResult into a Snickers LdapResult.

Parameters:

twixResult - the Twix LdapResult representation

snickersResult - the Snickers LdapResult representation

transformCompareRequest

public static InternalMessage transformCompareRequest(LdapMessageCodec twixMessage,
                                                      int messageId)

Transform a CompareRequest message from a TwixMessage to a SnickersMessage

Parameters:

twixMessage - The message to transform

messageId - The message Id

Returns:

A Snickers CompareRequestImpl

transformDelRequest

public static InternalMessage transformDelRequest(LdapMessageCodec twixMessage,
                                                  int messageId)

Transform a DelRequest message from a TwixMessage to a SnickersMessage

Parameters:

twixMessage - The message to transform

messageId - The message Id

Returns:

A Snickers DeleteRequestImpl

transformExtendedRequest

public static InternalMessage transformExtendedRequest(LdapMessageCodec twixMessage,
                                                       int messageId)

Transform an ExtendedRequest message from a TwixMessage to a SnickersMessage

Parameters:

twixMessage - The message to transform

messageId - The message Id

Returns:

A Snickers ExtendedRequestImpl

transformModifyDNRequest

public static InternalMessage transformModifyDNRequest(LdapMessageCodec twixMessage,
                                                       int messageId)

Transform a ModifyDNRequest message from a TwixMessage to a SnickersMessage

Parameters:

twixMessage - The message to transform

messageId - The message Id

Returns:

A Snickers ModifyDNRequestImpl

transformModifyRequest

public static InternalMessage transformModifyRequest(LdapMessageCodec twixMessage,
                                                     int messageId)

Transform a ModifyRequest message from a TwixMessage to a SnickersMessage

Parameters:

twixMessage - The message to transform

messageId - The message Id

Returns:

A Snickers ModifyRequestImpl

transformFilter

public static ExprNode transformFilter(Filter twixFilter)

Transform the Filter part of a SearchRequest to an ExprNode

Parameters:

twixFilter - The filter to be transformed

Returns:

An ExprNode

transformFilter

public static Filter transformFilter(ExprNode exprNode)

Transform an ExprNode filter to a TwixFilter

Parameters:

exprNode - The filter to be transformed

Returns:

A Twix filter

transformSearchRequest

public static InternalMessage transformSearchRequest(LdapMessageCodec twixMessage,
                                                     int messageId)

Transform a SearchRequest message from a TwixMessage to a SnickersMessage

Parameters:

twixMessage - The message to transform

messageId - The message Id

Returns:

A Snickers SearchRequestImpl

transformUnBindRequest

public static InternalMessage transformUnBindRequest(LdapMessageCodec twixMessage,
                                                     int messageId)

Transform an UnBindRequest message from a TwixMessage to a SnickersMessage

Parameters:

twixMessage - The message to transform

messageId - The message Id

Returns:

A Snickers UnBindRequestImpl

transform

public static InternalMessage transform(java.lang.Object obj)

Transform the Twix message to a codec neutral message.

Parameters:

obj - the object to transform

Returns:

the object transformed

transformLdapResult

public static LdapResultCodec transformLdapResult(LdapResultImpl snickersLdapResult)

Transform a Ldapresult part of a Snickers Response to a Twix LdapResult

Parameters:

snickersLdapResult - the Snickers LdapResult to transform

Returns:

A Twix LdapResult

transformAddResponse

public static void transformAddResponse(LdapMessageCodec twixMessage,
                                        InternalMessage snickersMessage)

Transform a Snickers AddResponse to a Twix AddResponse

Parameters:

twixMessage - The Twix AddResponse to produce

snickersMessage - The incoming Snickers AddResponse

transformBindResponse

public static void transformBindResponse(LdapMessageCodec twixMessage,
                                         InternalMessage snickersMessage)

Transform a Snickers BindResponse to a Twix BindResponse

Parameters:

twixMessage - The Twix BindResponse to produce

snickersMessage - The incoming Snickers BindResponse

transformBindRequest

public static void transformBindRequest(LdapMessageCodec twixMessage,
                                        InternalMessage snickersMessage)

Transform a Snickers BindRequest to a Twix BindRequest

Parameters:

twixMessage - The Twix BindRequest to produce

snickersMessage - The incoming Snickers BindRequest

transformCompareResponse

public static void transformCompareResponse(LdapMessageCodec twixMessage,
                                            InternalMessage snickersMessage)

Transform a Snickers CompareResponse to a Twix CompareResponse

Parameters:

twixMessage - The Twix CompareResponse to produce

snickersMessage - The incoming Snickers CompareResponse

transformDelResponse

public static void transformDelResponse(LdapMessageCodec twixMessage,
                                        InternalMessage snickersMessage)

Transform a Snickers DelResponse to a Twix DelResponse

Parameters:

twixMessage - The Twix DelResponse to produce

snickersMessage - The incoming Snickers DelResponse

transformExtendedResponse

public static void transformExtendedResponse(LdapMessageCodec twixMessage,
                                             InternalMessage snickersMessage)

Transform a Snickers ExtendedResponse to a Twix ExtendedResponse

Parameters:

twixMessage - The Twix ExtendedResponse to produce

snickersMessage - The incoming Snickers ExtendedResponse

transformModifyResponse

public static void transformModifyResponse(LdapMessageCodec twixMessage,
                                           InternalMessage snickersMessage)

Transform a Snickers ModifyResponse to a Twix ModifyResponse

Parameters:

twixMessage - The Twix ModifyResponse to produce

snickersMessage - The incoming Snickers ModifyResponse

transformModifyDNResponse

public static void transformModifyDNResponse(LdapMessageCodec twixMessage,
                                             InternalMessage snickersMessage)

Transform a Snickers ModifyDNResponse to a Twix ModifyDNResponse

Parameters:

twixMessage - The Twix ModifyDNResponse to produce

snickersMessage - The incoming Snickers ModifyDNResponse

transformSearchResultDone

public static void transformSearchResultDone(LdapMessageCodec twixMessage,
                                             InternalMessage snickersMessage)

Transform a Snickers SearchResponseDone to a Twix SearchResultDone

Parameters:

twixMessage - The Twix SearchResultDone to produce

snickersMessage - The incoming Snickers SearchResponseDone

transformSearchResultEntry

public static void transformSearchResultEntry(LdapMessageCodec twixMessage,
                                              InternalMessage snickersMessage)

Transform a Snickers SearchResponseEntry to a Twix SearchResultEntry

Parameters:

twixMessage - The Twix SearchResultEntry to produce

snickersMessage - The incoming Snickers SearchResponseEntry

transformSearchResultReference

public static void transformSearchResultReference(LdapMessageCodec twixMessage,
                                                  InternalMessage snickersMessage)

Transform a Snickers SearchResponseReference to a Twix SearchResultReference

Parameters:

twixMessage - The Twix SearchResultReference to produce

snickersMessage - The incoming Snickers SearchResponseReference

transform

public static java.lang.Object transform(InternalMessage msg)

Transform the Snickers message to a Twix message.

Parameters:

msg - the message to transform

Returns:

the msg transformed

transformControlsTwixToSnickers

public static void transformControlsTwixToSnickers(LdapMessageCodec twixMessage,
                                                   InternalMessage msg)

TODO finish this implementation. Takes Twix Controls, transforming them to Snickers Controls and populates the Snickers message with them.

Parameters:

twixMessage - the Twix message

msg - the Snickers message

transformControls

public static void transformControls(LdapMessageCodec twixMessage,
                                     InternalMessage msg)

Transforms the controls

Parameters:

twixMessage - The Twix SearchResultReference to produce

msg - The incoming Snickers SearchResponseReference