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 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 }

  • Field Details

    • messageID

      private int messageID
      Protocol message ID.

    • controls

      private List<ResponseControl> 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 interface Message
      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 interface Message
      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(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public abstract int hashCode()
      Returns the hash code for this object.
      Overrides:
      hashCode in class Object
      Returns:
      hash code

    • toString

      public String toString()
      Overrides:
      toString in class Object