Package org.ldaptive
Class AbstractMessage
- java.lang.Object
-
- org.ldaptive.AbstractMessage
-
- All Implemented Interfaces:
Message
- Direct Known Subclasses:
AbstractResult
,IntermediateResponse
,LdapEntry
,SearchResultReference
public abstract class AbstractMessage extends java.lang.Object implements Message
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 }
- Author:
- Middleware Services
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description protected static class
AbstractMessage.AbstractBuilder<B,T extends AbstractMessage>
protected static class
AbstractMessage.ControlParser
Parses a buffer containing an LDAP control.protected static class
AbstractMessage.ControlsHandler
Parse handler implementation for the message controls.protected static class
AbstractMessage.MessageIDHandler
Parse handler implementation for the message ID.
-
Constructor Summary
Constructors Constructor Description AbstractMessage()
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description void
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
equals(java.lang.Object o)
ResponseControl[]
getControls()
Returns the response controls for this message.int
getMessageID()
Returns the ID for this message.abstract int
hashCode()
Returns the hash code for this object.void
setMessageID(int id)
java.lang.String
toString()
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface org.ldaptive.Message
getControl
-
-
-
-
Method Detail
-
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
public ResponseControl[] getControls()
Description copied from interface:Message
Returns the response controls for this message.- Specified by:
getControls
in interfaceMessage
- Returns:
- response controls
-
addControls
public void addControls(ResponseControl... cntrls)
Adds the supplied controls to this message.- Parameters:
cntrls
- to add
-
copyValues
protected <T extends Message> void copyValues(T message)
Copies the property values from the supplied message to this message.- Type Parameters:
T
- type of message- Parameters:
message
- to copy from
-
equals
public boolean equals(java.lang.Object o)
- Overrides:
equals
in classjava.lang.Object
-
hashCode
public abstract int hashCode()
Returns the hash code for this object.- Overrides:
hashCode
in classjava.lang.Object
- Returns:
- hash code
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
-
-