org.apache.directory.shared.dsmlv2.request
Class CompareRequestDsml

java.lang.Object
  extended by org.apache.directory.shared.asn1.AbstractAsn1Object
      extended by org.apache.directory.shared.ldap.codec.LdapMessageCodec
          extended by org.apache.directory.shared.dsmlv2.LdapMessageDecorator
              extended by org.apache.directory.shared.dsmlv2.request.LdapRequestDecorator
                  extended by org.apache.directory.shared.dsmlv2.request.AbstractRequestDsml
                      extended by org.apache.directory.shared.dsmlv2.request.CompareRequestDsml
All Implemented Interfaces:
Asn1Object, DsmlDecorator

public class CompareRequestDsml
extends AbstractRequestDsml

DSML Decorator for CompareRequest

Version:
$Rev$, $Date$
Author:
Apache Directory Project

Field Summary
 
Fields inherited from class org.apache.directory.shared.dsmlv2.LdapMessageDecorator
instance
 
Fields inherited from class org.apache.directory.shared.ldap.codec.LdapMessageCodec
ldapMessageLength
 
Fields inherited from class org.apache.directory.shared.asn1.AbstractAsn1Object
parent
 
Constructor Summary
CompareRequestDsml()
          Creates a new instance of CompareRequestDsml.
CompareRequestDsml(CompareRequestCodec ldapMessage)
          Creates a new instance of CompareRequestDsml.
 
Method Summary
 java.lang.Object getAssertionValue()
          Get the assertion value
 java.lang.String getAttributeDesc()
          Get the attribute description
 DN getEntry()
          Get the entry to be compared
 MessageTypeEnum getMessageType()
          Get the message type
 void setAssertionValue(java.lang.Object assertionValue)
          Set the assertion value
 void setAttributeDesc(java.lang.String attributeDesc)
          Set the attribute description
 void setEntry(DN entry)
          Set the entry to be compared
 org.dom4j.Element toDsml(org.dom4j.Element root)
          Creates the Request Element and adds RequestID and Controls.
 
Methods inherited from class org.apache.directory.shared.dsmlv2.LdapMessageDecorator
addControl, addLength, computeLength, computeLengthProtocolOp, encode, encodeProtocolOp, getAbandonRequest, getAddRequest, getAddResponse, getBindRequest, getBindResponse, getCompareRequest, getCompareResponse, getControls, getControls, getCurrentControl, getCurrentLength, getDelRequest, getDelResponse, getExpectedLength, getExtendedRequest, getExtendedResponse, getLdapResponse, getMessageId, getMessageTypeName, getModifyDNRequest, getModifyDNResponse, getModifyRequest, getModifyResponse, getParent, getSearchRequest, getSearchResultDone, getSearchResultEntry, getSearchResultReference, getUnBindRequest, setCurrentLength, setExpectedLength, setMessageId, setParent, toString
 
Methods inherited from class org.apache.directory.shared.ldap.codec.LdapMessageCodec
addControls, encode, getCodecControl, initControls, toString
 
Methods inherited from class org.apache.directory.shared.asn1.AbstractAsn1Object
getTlvId
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

CompareRequestDsml

public CompareRequestDsml()
Creates a new instance of CompareRequestDsml.


CompareRequestDsml

public CompareRequestDsml(CompareRequestCodec ldapMessage)
Creates a new instance of CompareRequestDsml.

Parameters:
ldapMessage - the message to decorate
Method Detail

getMessageType

public MessageTypeEnum getMessageType()
Get the message type

Overrides:
getMessageType in class LdapMessageDecorator
Returns:
The message type

toDsml

public org.dom4j.Element toDsml(org.dom4j.Element root)
Creates the Request Element and adds RequestID and Controls.

Specified by:
toDsml in interface DsmlDecorator
Overrides:
toDsml in class AbstractRequestDsml
Parameters:
root - the root element
Returns:
the Request Element of the given name containing

getEntry

public DN getEntry()
Get the entry to be compared

Returns:
Returns the entry.

setEntry

public void setEntry(DN entry)
Set the entry to be compared

Parameters:
entry - The entry to set.

getAssertionValue

public java.lang.Object getAssertionValue()
Get the assertion value

Returns:
Returns the assertionValue.

setAssertionValue

public void setAssertionValue(java.lang.Object assertionValue)
Set the assertion value

Parameters:
assertionValue - The assertionValue to set.

getAttributeDesc

public java.lang.String getAttributeDesc()
Get the attribute description

Returns:
Returns the attributeDesc.

setAttributeDesc

public void setAttributeDesc(java.lang.String attributeDesc)
Set the attribute description

Parameters:
attributeDesc - The attributeDesc to set.


Copyright © 2003-2011 Apache Software Foundation. All Rights Reserved.