Package org.ldaptive
Class AbstractMessage
java.lang.Object
org.ldaptive.AbstractMessage
- All Implemented Interfaces:
Message
- Direct Known Subclasses:
AbstractResult
,IntermediateResponse
,LdapEntry
,SearchResultReference
LDAP message envelope defined as:
LDAPMessage ::= SEQUENCE { messageID MessageID, protocolOp CHOICE { ..., controls [0] Controls OPTIONAL } Control ::= SEQUENCE { controlType LDAPOID, criticality BOOLEAN DEFAULT FALSE, controlValue OCTET STRING OPTIONAL }
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionprotected static class
AbstractMessage.AbstractBuilder<B,
T extends AbstractMessage> protected static class
Parses a buffer containing an LDAP control.protected static class
Parse handler implementation for the message controls.protected static class
Parse handler implementation for the message ID. -
Field Summary
FieldsModifier and TypeFieldDescriptionprivate List<ResponseControl>
LDAP controls.private int
Protocol message ID. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
addControls
(ResponseControl... cntrls) Adds the supplied controls to this message.protected <T extends Message>
voidcopyValues
(T message) Copies the property values from the supplied message to this message.boolean
Returns the response controls for this message.int
Returns the ID for this message.abstract int
hashCode()
Returns the hash code for this object.void
setMessageID
(int id) toString()
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
Methods inherited from interface org.ldaptive.Message
getControl
-
Field Details
-
messageID
private int messageIDProtocol message ID. -
controls
LDAP controls.
-
-
Constructor Details
-
AbstractMessage
public AbstractMessage()
-
-
Method Details
-
getMessageID
public int getMessageID()Description copied from interface:Message
Returns the ID for this message.- Specified by:
getMessageID
in interfaceMessage
- Returns:
- message ID
-
setMessageID
public void setMessageID(int id) -
getControls
Description copied from interface:Message
Returns the response controls for this message.- Specified by:
getControls
in interfaceMessage
- Returns:
- response controls
-
addControls
Adds the supplied controls to this message.- Parameters:
cntrls
- to add
-
copyValues
Copies the property values from the supplied message to this message.- Type Parameters:
T
- type of message- Parameters:
message
- to copy from
-
equals
-
hashCode
public abstract int hashCode()Returns the hash code for this object. -
toString
-