Interface Message
-
- All Known Subinterfaces:
AbandonableRequest
,AbandonableResultResponseRequest
,AbandonRequest
,AddRequest
,AddResponse
,BindRequest
,BindResponse
,CancelRequest
,CancelResponse
,CertGenerationRequest
,CertGenerationResponse
,CompareRequest
,CompareResponse
,DeleteRequest
,DeleteResponse
,EndTransactionRequest
,EndTransactionResponse
,ExtendedRequest
,ExtendedResponse
,GracefulDisconnectResponse
,GracefulShutdownRequest
,GracefulShutdownResponse
,IntermediateResponse
,ManyReplyRequest
,ModifyDnRequest
,ModifyDnResponse
,ModifyRequest
,ModifyResponse
,PasswordModifyRequest
,PasswordModifyResponse
,Request
,Response
,ResultResponse
,ResultResponseRequest
,SearchRequest
,SearchResultDone
,SearchResultEntry
,SearchResultReference
,SingleReplyRequest
,StartTlsRequest
,StartTlsResponse
,StartTransactionRequest
,StartTransactionResponse
,StoredProcedureRequest
,StoredProcedureResponse
,SyncInfoValue
,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
,EndTransactionRequestDecorator
,EndTransactionRequestImpl
,EndTransactionResponseDecorator
,EndTransactionResponseImpl
,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
,StartTransactionRequestDecorator
,StartTransactionRequestImpl
,StartTransactionResponseDecorator
,StartTransactionResponseImpl
,StoredProcedureRequestDecorator
,StoredProcedureRequestImpl
,StoredProcedureResponseDecorator
,StoredProcedureResponseImpl
,SyncInfoValueDecorator
,SyncInfoValueImpl
,UnbindRequestDecorator
,UnbindRequestImpl
,WhoAmIRequestDecorator
,WhoAmIRequestImpl
,WhoAmIResponseDecorator
,WhoAmIResponseImpl
public interface Message
Root interface for all LDAP message type interfaces.- Author:
- Apache Directory Project
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description Message
addAllControls(Control[] controlsToAdd)
Adds an array of controls to this Message.Message
addControl(Control control)
Adds a control to this Message.Object
get(Object key)
Gets a message scope parameter.Control
getControl(String oid)
Gets the control associated with the given OID.Map<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(String oid)
Checks whether or not this message has the specified control.Object
put(Object key, 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
Map<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(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(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
Object get(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
Object put(Object key, 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 keyvalue
- 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
-
-