Package org.forgerock.opendj.ldap.messages

Class LdapMessage

java.lang.Object

org.forgerock.opendj.ldap.messages.LdapMessage

public final class LdapMessage
extends Object

Encapsulates a ProtocolOp with LDAP specific message information.

Method Summary

Modifier and Type	Method	Description
int	getMessageId()	Returns the message-id.
ProtocolOp	getProtocolOp()	Returns the protocol-op contained in this message.
byte	getProtocolOpType()	Returns the protocol-op type.
static LdapMessage	newLdapMessage(int messageId, byte protocolOpType, ProtocolOp protocolOp)	Creates a new ProtocolOp containing a fully decoded LDAP message.
static LdapMessage	newRequestMessage(int messageId, Request request)	Builds and returns an LdapMessage containing a Request.
static LdapMessage	newResponseMessage(int messageId, BindResult response)	Builds and returns an LdapMessage containing a BindResult.
static LdapMessage	newResponseMessage(int messageId, CompareResult response)	Builds and returns an LdapMessage containing a CompareResult.
static LdapMessage	newResponseMessage(int messageId, ExtendedResult response)	Builds and returns an LdapMessage containing a ExtendedResult.
static LdapMessage	newResponseMessage(int messageId, IntermediateResponse response)	Builds and returns an LdapMessage containing a IntermediateResponse.
static LdapMessage	newResponseMessage(int messageId, Request forRequest, Response response)	Builds and returns an LdapMessage containing a Response.
static LdapMessage	newResponseMessage(int messageId, SearchResultEntry response)	Builds and returns an LdapMessage containing a SearchResultEntry.
static LdapMessage	newResponseMessage(int messageId, SearchResultReference response)	Builds and returns an LdapMessage containing a SearchResultReference.
LdapMessage	newResponseMessage(Response response)	Returns a new LdapMessage containing the provided Response.
static LdapMessage	newSearchResultDoneMessage(int messageId, Result result)	Builds and returns an LdapMessage for a search result done operation type.
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

newLdapMessage

public static LdapMessage newLdapMessage(int messageId,
                                         byte protocolOpType,
                                         ProtocolOp protocolOp)

Creates a new ProtocolOp containing a fully decoded LDAP message.

Parameters:

messageId - Unique identifier of this message

protocolOpType - Type of protocol-op contained in this message

protocolOp - The fully decoded ProtocolOp

Returns:

A new LdapMessage

newRequestMessage

public static LdapMessage newRequestMessage(int messageId,
                                            Request request)

Builds and returns an LdapMessage containing a Request.
This method simplifies newLdapMessage(int, byte, ProtocolOp) by inferring the protocolOpType from the actual type of request.

Parameters:

messageId - Identifier of this message

request - The fully decoded Request

Returns:

a new LdapMessage

newResponseMessage

public static LdapMessage newResponseMessage(int messageId,
                                             Request forRequest,
                                             Response response)

Builds and returns an LdapMessage containing a Response.
This method simplifies newLdapMessage(int, byte, ProtocolOp) by inferring the protocolOpType from the actual type of request this response respond to.

Parameters:

messageId - Identifier of this message

forRequest - The Request the response is responding to.

response - The response which will be contained in the returned message

Returns:

a new LdapMessage

newResponseMessage

public static LdapMessage newResponseMessage(int messageId,
                                             SearchResultEntry response)

Builds and returns an LdapMessage containing a SearchResultEntry.
This method simplifies newLdapMessage(int, byte, ProtocolOp) by inferring the protocolOpType.

Parameters:

messageId - Identifier of this message

response - The response which will be contained in the returned message

Returns:

a new LdapMessage

newResponseMessage

public static LdapMessage newResponseMessage(int messageId,
                                             SearchResultReference response)

Builds and returns an LdapMessage containing a SearchResultReference.
This method simplifies newLdapMessage(int, byte, ProtocolOp) by inferring the protocolOpType.

Parameters:

messageId - Identifier of this message

response - The response which will be contained in the returned message

Returns:

a new LdapMessage

newResponseMessage

public static LdapMessage newResponseMessage(int messageId,
                                             IntermediateResponse response)

Builds and returns an LdapMessage containing a IntermediateResponse.
This method simplifies newLdapMessage(int, byte, ProtocolOp) by inferring the protocolOpType.

Parameters:

messageId - Identifier of this message

response - The response which will be contained in the returned message

Returns:

a new LdapMessage

newResponseMessage

public static LdapMessage newResponseMessage(int messageId,
                                             BindResult response)

Builds and returns an LdapMessage containing a BindResult.
This method simplifies newLdapMessage(int, byte, ProtocolOp) by inferring the protocolOpType.

Parameters:

messageId - Identifier of this message

response - The response which will be contained in the returned message

Returns:

a new LdapMessage

newResponseMessage

public static LdapMessage newResponseMessage(int messageId,
                                             ExtendedResult response)

Builds and returns an LdapMessage containing a ExtendedResult.
This method simplifies newLdapMessage(int, byte, ProtocolOp) by inferring the protocolOpType.

Parameters:

messageId - Identifier of this message

response - The response which will be contained in the returned message

Returns:

a new LdapMessage

newResponseMessage

public static LdapMessage newResponseMessage(int messageId,
                                             CompareResult response)

Builds and returns an LdapMessage containing a CompareResult.
This method simplifies newLdapMessage(int, byte, ProtocolOp) by inferring the protocolOpType.

Parameters:

messageId - Identifier of this message

response - The response which will be contained in the returned message

Returns:

a new LdapMessage

newSearchResultDoneMessage

public static LdapMessage newSearchResultDoneMessage(int messageId,
                                                     Result result)

Builds and returns an LdapMessage for a search result done operation type.
This method simplifies newLdapMessage(int, byte, ProtocolOp) by removing the protocolOpType parameter when it can be inferred from the actual type of protocolOp.

Parameters:

messageId - Unique identifier of this message

result - The search result done result

Returns:

a new LdapMessage

getMessageId

public int getMessageId()

Returns the message-id.

Returns:

The message-id

getProtocolOpType

public byte getProtocolOpType()

Returns the protocol-op type.

Returns:

the protocol-op type

getProtocolOp

public ProtocolOp getProtocolOp()

Returns the protocol-op contained in this message.

Returns:

the ProtocolOp

newResponseMessage

public LdapMessage newResponseMessage(Response response)

Returns a new LdapMessage containing the provided Response.

Parameters:

response - The response which will be contained in the returned message

Returns:

a new LdapMessage

toString

public String toString()

Overrides:

toString in class Object