Class SearchResultReferenceDsml
- java.lang.Object
-
- org.apache.directory.api.dsmlv2.AbstractDsmlMessageDecorator<E>
-
- org.apache.directory.api.dsmlv2.response.AbstractResponseDsml<SearchResultReference>
-
- org.apache.directory.api.dsmlv2.response.SearchResultReferenceDsml
-
- All Implemented Interfaces:
DsmlDecorator<SearchResultReference>
,Message
,Response
,SearchResultReference
public class SearchResultReferenceDsml extends AbstractResponseDsml<SearchResultReference> implements SearchResultReference
DSML Decorator for SearchResultReference- Author:
- Apache Directory Project
-
-
Constructor Summary
Constructors Constructor Description SearchResultReferenceDsml(LdapApiService codec)
Creates a new getDecoratedMessage() of SearchResultReferenceDsml.SearchResultReferenceDsml(LdapApiService codec, SearchResultReference ldapMessage)
Creates a new getDecoratedMessage() of SearchResultReferenceDsml.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addSearchResultReference(LdapUrl searchResultReference)
Add a new reference to the list.Referral
getReferral()
Gets the sequence of LdapUrls as a Referral instance.Collection<String>
getSearchResultReferences()
Get the list of referencesMessageTypeEnum
getType()
Gets the LDAP message type code associated with this Message.void
setReferral(Referral referral)
Sets the sequence of LdapUrls as a Referral instance.org.dom4j.Element
toDsml(org.dom4j.Element root)
Converts the request/reponse to its XML representation in the DSMLv2 format-
Methods inherited from class org.apache.directory.api.dsmlv2.AbstractDsmlMessageDecorator
addAllControls, addControl, get, getCodecService, getControl, getControls, getCurrentControl, getDecorated, getMessageId, hasControl, put, removeControl, setMessageId
-
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface org.apache.directory.api.ldap.model.message.Message
addAllControls, addControl, get, getControl, getControls, getMessageId, hasControl, put, removeControl, setMessageId
-
-
-
-
Constructor Detail
-
SearchResultReferenceDsml
public SearchResultReferenceDsml(LdapApiService codec)
Creates a new getDecoratedMessage() of SearchResultReferenceDsml.- Parameters:
codec
- The LDAP Service to use
-
SearchResultReferenceDsml
public SearchResultReferenceDsml(LdapApiService codec, SearchResultReference ldapMessage)
Creates a new getDecoratedMessage() of SearchResultReferenceDsml.- Parameters:
codec
- The LDAP Service to useldapMessage
- the message to decorate
-
-
Method Detail
-
getType
public MessageTypeEnum getType()
Gets the LDAP message type code associated with this Message. Each request and response type has a unique message type code defined by the protocol in RFC 2251.- Specified by:
getType
in interfaceMessage
- Overrides:
getType
in classAbstractDsmlMessageDecorator<SearchResultReference>
- Returns:
- the message type code.
-
toDsml
public org.dom4j.Element toDsml(org.dom4j.Element root)
Converts the request/reponse to its XML representation in the DSMLv2 format- Specified by:
toDsml
in interfaceDsmlDecorator<SearchResultReference>
- Parameters:
root
- the root dom4j Element- Returns:
- the dom4j Element corresponding to the entry.
-
addSearchResultReference
public void addSearchResultReference(LdapUrl searchResultReference)
Add a new reference to the list.- Parameters:
searchResultReference
- The search result reference
-
getSearchResultReferences
public Collection<String> getSearchResultReferences()
Get the list of references- Returns:
- An ArrayList of SearchResultReferences
-
getReferral
public Referral getReferral()
Gets the sequence of LdapUrls as a Referral instance.- Specified by:
getReferral
in interfaceSearchResultReference
- Returns:
- the sequence of LdapUrls
-
setReferral
public void setReferral(Referral referral)
Sets the sequence of LdapUrls as a Referral instance.- Specified by:
setReferral
in interfaceSearchResultReference
- Parameters:
referral
- the sequence of LdapUrls
-
-