public class LDAPMessage extends Object implements ProtocolElement
Constructor and Description |
---|
LDAPMessage(int messageID,
ProtocolOp protocolOp)
Creates a new LDAP message with the provided message ID and protocol op but
no controls.
|
LDAPMessage(int messageID,
ProtocolOp protocolOp,
List<Control> controls)
Creates a new LDAP message with the provided message ID, protocol op, and
set of controls.
|
Modifier and Type | Method and Description |
---|---|
AbandonRequestProtocolOp |
getAbandonRequestProtocolOp()
Retrieves the protocol op for this LDAP message as an abandon request
protocol op.
|
AddRequestProtocolOp |
getAddRequestProtocolOp()
Retrieves the protocol op for this LDAP message as an add request protocol
op.
|
AddResponseProtocolOp |
getAddResponseProtocolOp()
Retrieves the protocol op for this LDAP message as an add response protocol
op.
|
BindRequestProtocolOp |
getBindRequestProtocolOp()
Retrieves the protocol op for this LDAP message as a bind request
protocol op.
|
BindResponseProtocolOp |
getBindResponseProtocolOp()
Retrieves the protocol op for this LDAP message as a bind response
protocol op.
|
CompareRequestProtocolOp |
getCompareRequestProtocolOp()
Retrieves the protocol op for this LDAP message as a compare request
protocol op.
|
CompareResponseProtocolOp |
getCompareResponseProtocolOp()
Retrieves the protocol op for this LDAP message as a compare response
protocol op.
|
List<Control> |
getControls()
Retrieves the set of controls for this LDAP message.
|
DeleteRequestProtocolOp |
getDeleteRequestProtocolOp()
Retrieves the protocol op for this LDAP message as a delete request
protocol op.
|
DeleteResponseProtocolOp |
getDeleteResponseProtocolOp()
Retrieves the protocol op for this LDAP message as a delete response
protocol op.
|
ExtendedRequestProtocolOp |
getExtendedRequestProtocolOp()
Retrieves the protocol op for this LDAP message as an extended request
protocol op.
|
ExtendedResponseProtocolOp |
getExtendedResponseProtocolOp()
Retrieves the protocol op for this LDAP message as an extended response
protocol op.
|
int |
getMessageID()
Retrieves the message ID for this LDAP message.
|
ModifyDNRequestProtocolOp |
getModifyDNRequestProtocolOp()
Retrieves the protocol op for this LDAP message as a modify DN request
protocol op.
|
ModifyDNResponseProtocolOp |
getModifyDNResponseProtocolOp()
Retrieves the protocol op for this LDAP message as a modify DN response
protocol op.
|
ModifyRequestProtocolOp |
getModifyRequestProtocolOp()
Retrieves the protocol op for this LDAP message as a modify request
protocol op.
|
ModifyResponseProtocolOp |
getModifyResponseProtocolOp()
Retrieves the protocol op for this LDAP message as a modify response
protocol op.
|
String |
getProtocolElementName()
Retrieves the name of the protocol associated with this protocol element.
|
ProtocolOp |
getProtocolOp()
Retrieves the protocol op for this LDAP message.
|
String |
getProtocolOpName()
Retrieves the protocol op name for this LDAP message.
|
byte |
getProtocolOpType()
Retrieves the protocol op type for this LDAP message.
|
SearchRequestProtocolOp |
getSearchRequestProtocolOp()
Retrieves the protocol op for this LDAP message as a search request
protocol op.
|
SearchResultDoneProtocolOp |
getSearchResultDoneProtocolOp()
Retrieves the protocol op for this LDAP message as a search result done
protocol op.
|
SearchResultEntryProtocolOp |
getSearchResultEntryProtocolOp()
Retrieves the protocol op for this LDAP message as a search result entry
protocol op.
|
SearchResultReferenceProtocolOp |
getSearchResultReferenceProtocolOp()
Retrieves the protocol op for this LDAP message as a search result
reference protocol op.
|
UnbindRequestProtocolOp |
getUnbindRequestProtocolOp()
Retrieves the protocol op for this LDAP message as an unbind request
protocol op.
|
String |
toString()
Retrieves a string representation of this LDAP message.
|
void |
toString(StringBuilder buffer)
Appends a string representation of this protocol element to the provided
buffer.
|
void |
toString(StringBuilder buffer,
int indent)
Appends a string representation of this protocol element to the provided
buffer.
|
void |
write(org.forgerock.opendj.io.Asn1Writer stream)
Writes this protocol op to an ASN.1 output stream.
|
public LDAPMessage(int messageID, ProtocolOp protocolOp)
messageID
- The message ID for this LDAP message.protocolOp
- The protocol op for this LDAP message.public LDAPMessage(int messageID, ProtocolOp protocolOp, List<Control> controls)
messageID
- The message ID for this LDAP message.protocolOp
- The protocol op for this LDAP message.controls
- The set of controls for this LDAP message.public int getMessageID()
public ProtocolOp getProtocolOp()
public byte getProtocolOpType()
public String getProtocolOpName()
public AbandonRequestProtocolOp getAbandonRequestProtocolOp() throws ClassCastException
ClassCastException
- If the protocol op is not an abandon request
protocol op.public AddRequestProtocolOp getAddRequestProtocolOp() throws ClassCastException
ClassCastException
- If the protocol op is not an add request
protocol op.public AddResponseProtocolOp getAddResponseProtocolOp() throws ClassCastException
ClassCastException
- If the protocol op is not an add response
protocol op.public BindRequestProtocolOp getBindRequestProtocolOp() throws ClassCastException
ClassCastException
- If the protocol op is not a bind request
protocol op.public BindResponseProtocolOp getBindResponseProtocolOp() throws ClassCastException
ClassCastException
- If the protocol op is not a bind response
protocol op.public CompareRequestProtocolOp getCompareRequestProtocolOp() throws ClassCastException
ClassCastException
- If the protocol op is not a compare request
protocol op.public CompareResponseProtocolOp getCompareResponseProtocolOp() throws ClassCastException
ClassCastException
- If the protocol op is not a compare response
protocol op.public DeleteRequestProtocolOp getDeleteRequestProtocolOp() throws ClassCastException
ClassCastException
- If the protocol op is not a delete request
protocol op.public DeleteResponseProtocolOp getDeleteResponseProtocolOp() throws ClassCastException
ClassCastException
- If the protocol op is not a delete response
protocol op.public ExtendedRequestProtocolOp getExtendedRequestProtocolOp() throws ClassCastException
ClassCastException
- If the protocol op is not an extended request
protocol op.public ExtendedResponseProtocolOp getExtendedResponseProtocolOp() throws ClassCastException
ClassCastException
- If the protocol op is not an extended response
protocol op.public ModifyRequestProtocolOp getModifyRequestProtocolOp() throws ClassCastException
ClassCastException
- If the protocol op is not a modify request
protocol op.public ModifyResponseProtocolOp getModifyResponseProtocolOp() throws ClassCastException
ClassCastException
- If the protocol op is not a modify response
protocol op.public ModifyDNRequestProtocolOp getModifyDNRequestProtocolOp() throws ClassCastException
ClassCastException
- If the protocol op is not a modify DN request
protocol op.public ModifyDNResponseProtocolOp getModifyDNResponseProtocolOp() throws ClassCastException
ClassCastException
- If the protocol op is not a modify DN response
protocol op.public SearchRequestProtocolOp getSearchRequestProtocolOp() throws ClassCastException
ClassCastException
- If the protocol op is not a search request
protocol op.public SearchResultDoneProtocolOp getSearchResultDoneProtocolOp() throws ClassCastException
ClassCastException
- If the protocol op is not a search result done
protocol op.public SearchResultEntryProtocolOp getSearchResultEntryProtocolOp() throws ClassCastException
ClassCastException
- If the protocol op is not a search result
entry protocol op.public SearchResultReferenceProtocolOp getSearchResultReferenceProtocolOp() throws ClassCastException
ClassCastException
- If the protocol op is not a search result
reference protocol op.public UnbindRequestProtocolOp getUnbindRequestProtocolOp() throws ClassCastException
ClassCastException
- If the protocol op is not an unbind request
protocol op.public List<Control> getControls()
public void write(org.forgerock.opendj.io.Asn1Writer stream) throws IOException
stream
- The ASN.1 output stream to write to.IOException
- If a problem occurs while writing to the stream.public String getProtocolElementName()
getProtocolElementName
in interface ProtocolElement
public void toString(StringBuilder buffer)
toString
in interface ProtocolElement
buffer
- The buffer into which the string representation should be
written.public void toString(StringBuilder buffer, int indent)
toString
in interface ProtocolElement
buffer
- The buffer into which the string representation should be
written.indent
- The number of spaces that should be used to indent the
resulting string representation.Copyright © 2010-2017 ForgeRock AS. All Rights Reserved.