Message

All Known Subinterfaces:

AbandonableRequest, AbandonableResultResponseRequest, AbandonRequest, AddRequest, AddResponse, BindRequest, BindResponse, CancelRequest, CancelResponse, CertGenerationRequest, CertGenerationResponse, CompareRequest, CompareResponse, DeleteRequest, DeleteResponse, ExtendedRequest, ExtendedResponse, GracefulDisconnectResponse, GracefulShutdownRequest, GracefulShutdownResponse, IntermediateResponse, ManyReplyRequest, ModifyDnRequest, ModifyDnResponse, ModifyRequest, ModifyResponse, PasswordModifyRequest, PasswordModifyResponse, Request, Response, ResultResponse, ResultResponseRequest, SearchRequest, SearchResultDone, SearchResultEntry, SearchResultReference, SingleReplyRequest, StartTlsRequest, StartTlsResponse, StoredProcedureRequest, StoredProcedureResponse, UnbindRequest, WhoAmIRequest, WhoAmIResponse

All Known Implementing Classes:

AbandonableRequestDecorator, AbandonableResultResponseRequestDecorator, AbandonRequestDecorator, AbandonRequestDsml, AbandonRequestImpl, AbstractAbandonableRequest, AbstractDsmlMessageDecorator, AbstractExtendedRequest, AbstractMessage, AbstractRequest, AbstractRequestDsml, AbstractResponse, AbstractResponseDsml, AbstractResultResponse, AbstractResultResponseDsml, AbstractResultResponseRequestDsml, AddNoDResponse, AddRequestDecorator, AddRequestDsml, AddRequestImpl, AddResponseDecorator, AddResponseDsml, AddResponseImpl, BindNoDResponse, BindRequestDecorator, BindRequestDsml, BindRequestImpl, BindResponseDecorator, BindResponseDsml, BindResponseImpl, CancelRequestDecorator, CancelRequestImpl, CancelResponseDecorator, CancelResponseImpl, CertGenerationRequestDecorator, CertGenerationRequestImpl, CertGenerationResponseDecorator, CertGenerationResponseImpl, CompareNoDResponse, CompareRequestDecorator, CompareRequestDsml, CompareRequestImpl, CompareResponseDecorator, CompareResponseDsml, CompareResponseImpl, DeleteNoDResponse, DeleteRequestDecorator, DeleteRequestImpl, DeleteResponseDecorator, DeleteResponseImpl, DelRequestDsml, DelResponseDsml, ErrorResponse, ExtendedNoDResponse, ExtendedRequestDecorator, ExtendedRequestDsml, ExtendedRequestImpl, ExtendedResponseDecorator, ExtendedResponseDsml, ExtendedResponseImpl, GracefulDisconnectResponseDecorator, GracefulDisconnectResponseImpl, GracefulShutdownRequestDecorator, GracefulShutdownRequestImpl, GracefulShutdownResponseDecorator, GracefulShutdownResponseImpl, IntermediateResponseDecorator, IntermediateResponseImpl, MessageDecorator, ModDNResponseDsml, ModifyDnNoDResponse, ModifyDnRequestDecorator, ModifyDNRequestDsml, ModifyDnRequestImpl, ModifyDnResponseDecorator, ModifyDnResponseImpl, ModifyNoDResponse, ModifyRequestDecorator, ModifyRequestDsml, ModifyRequestImpl, ModifyResponseDecorator, ModifyResponseDsml, ModifyResponseImpl, NoticeOfDisconnect, PasswordModifyRequestDecorator, PasswordModifyRequestImpl, PasswordModifyResponseDecorator, PasswordModifyResponseImpl, RequestDecorator, ResponseDecorator, ResultResponseRequestDecorator, SearchNoDResponse, SearchRequestDecorator, SearchRequestDsml, SearchRequestImpl, SearchResponse, SearchResponseDsml, SearchResultDoneDecorator, SearchResultDoneDsml, SearchResultDoneImpl, SearchResultEntryDecorator, SearchResultEntryDsml, SearchResultEntryImpl, SearchResultReferenceDecorator, SearchResultReferenceDsml, SearchResultReferenceImpl, SingleReplyRequestDecorator, StartTlsRequestDecorator, StartTlsRequestImpl, StartTlsResponseDecorator, StartTlsResponseImpl, StoredProcedureRequestDecorator, StoredProcedureRequestImpl, StoredProcedureResponseDecorator, StoredProcedureResponseImpl, UnbindRequestDecorator, UnbindRequestImpl, WhoAmIRequestDecorator, WhoAmIRequestImpl, WhoAmIResponseDecorator, WhoAmIResponseImpl
```
public interface Message
```
Root interface for all LDAP message type interfaces.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`Message`	`addAllControls(Control[] controlsToAdd)` Adds an array of controls to this Message.
`Message`	`addControl(Control control)` Adds a control to this Message.
`java.lang.Object`	`get(java.lang.Object key)` Gets a message scope parameter.
`Control`	`getControl(java.lang.String oid)` Gets the control associated with the given OID.
`java.util.Map<java.lang.String,Control>`	`getControls()` Gets the controls associated with this message mapped by OID.
`int`	`getMessageId()` Gets the session unique message sequence id for this message.
`MessageTypeEnum`	`getType()` Gets the LDAP message type code associated with this Message.
`boolean`	`hasControl(java.lang.String oid)` Checks whether or not this message has the specified control.
`java.lang.Object`	`put(java.lang.Object key, java.lang.Object value)` Sets a message scope parameter.
`Message`	`removeControl(Control control)` Deletes a control removing it from this Message.
`Message`	`setMessageId(int messageId)` Sets the Message ID for this request

- Method Detail
  - getType
```
MessageTypeEnum getType()
```
    Gets the LDAP message type code associated with this Message. Each request and response type has a unique message type code defined by the protocol in RFC 2251.
    
    Returns:
    
    the message type code.
  - getControls
```
java.util.Map<java.lang.String,Control> getControls()
```
    Gets the controls associated with this message mapped by OID.
    
    Returns:
    
    Map of OID strings to Control object instances.
  - getControl
```
Control getControl(java.lang.String oid)
```
    Gets the control associated with the given OID.
    
    Parameters:
    
    oid - The Cntrol's OID we are looking for
    
    Returns:
    
    The Control object instance with the OID.
  - hasControl
```
boolean hasControl(java.lang.String oid)
```
    Checks whether or not this message has the specified control.
    
    Parameters:
    
    oid - the OID of the control
    
    Returns:
    
    true if this message has the control, false if it does not
  - addControl
```
Message addControl(Control control)
```
    Adds a control to this Message.
    
    Parameters:
    
    control - the control to add.
    
    Returns:
    
    A Message reference
  - addAllControls
```
Message addAllControls(Control[] controlsToAdd)
```
    Adds an array of controls to this Message.
    
    Parameters:
    
    controlsToAdd - the controls to add.
    
    Returns:
    
    A Message reference
  - removeControl
```
Message removeControl(Control control)
```
    Deletes a control removing it from this Message.
    
    Parameters:
    
    control - the control to remove.
    
    Returns:
    
    A Message reference
  - getMessageId
```
int getMessageId()
```
    Gets the session unique message sequence id for this message. Requests and their responses if any have the same message id. Clients at the initialization of a session start with the first message's id set to 1 and increment it with each transaction.
    
    Returns:
    
    the session unique message id.
  - get
```
java.lang.Object get(java.lang.Object key)
```
    Gets a message scope parameter. Message scope parameters are temporary variables associated with a message and are set locally to be used to associate housekeeping information with a request or its processing. These parameters are never transmitted nor recieved, think of them as transient data associated with the message or its processing. These transient parameters are not locked down so modifications can occur without firing LockExceptions even when this Lockable is in the locked state.
    
    Parameters:
    
    key - the key used to access a message parameter.
    
    Returns:
    
    the transient message parameter value.
  - put
```
java.lang.Object put(java.lang.Object key,
                     java.lang.Object value)
```
    Sets a message scope parameter. These transient parameters are not locked down so modifications can occur without firing LockExceptions even when this Lockable is in the locked state.
    
    Parameters:
    
    key - the parameter key
    
    value - the parameter value
    
    Returns:
    
    the old value or null
  - setMessageId
```
Message setMessageId(int messageId)
```
    Sets the Message ID for this request
    
    Parameters:
    
    messageId - The message Id
    
    Returns:
    
    A Message reference

Interface Message

Method Summary

Method Detail

getType

getControls

getControl

hasControl

addControl

addAllControls

removeControl

getMessageId

get

put

setMessageId