org.pfsw.tools.beluga.ldap.messages
Class SearchRequest

java.lang.Object
  extended by org.pfsw.tools.beluga.ldap.messages.AbstractMessage
      extended by org.pfsw.tools.beluga.ldap.messages.RequestMessage
          extended by org.pfsw.tools.beluga.ldap.messages.SearchRequest

public class SearchRequest
extends RequestMessage

Represents a LDAP serach request message

Version:
1.0
Author:
Manfred Duchrow

Field Summary
static int DEREF_ALWAYS
           
static int DEREF_FINDING_BASE
           
static int DEREF_IN_SEARCH
           
static int DEREF_NEVER
           
static int SCOPE_BASE_OBJECT
           
static int SCOPE_SINGLE_LEVEL
           
static int SCOPE_WHOLE_SUBTREE
           
 
Constructor Summary
SearchRequest()
          Initialize the new instance with default values.
 
Method Summary
 String[] getAttributeNames()
           
 String getBaseDN()
           
 int getDerefAliases()
           
 String getFilter()
           
 int getScope()
           
 int getSizeLimit()
           
 int getTimeLimit()
           
 boolean getTypesOnly()
           
 boolean isScopeBaseObject()
          Returns true if the scope of this search is the base object only
 boolean isScopeSingleLevel()
          Returns true if the scope of this search is the single level
 boolean isScopeWholeSubtree()
          Returns true if the scope of this search is the whole subtree
 boolean isSearchRequest()
          Returns true if the receiver is a search request.
 void setAttributeNames(String[] newValue)
           
 void setBaseDN(String newValue)
           
 void setDerefAliases(int newValue)
           
 void setFilter(String newValue)
           
 void setScope(int newValue)
           
 void setSizeLimit(int newValue)
           
 void setTimeLimit(int newValue)
           
 void setTypesOnly(boolean newValue)
           
 
Methods inherited from class org.pfsw.tools.beluga.ldap.messages.RequestMessage
isAddRequest, isBindRequest, isDeleteRequest, isModifyRequest, isUnbindRequest
 
Methods inherited from class org.pfsw.tools.beluga.ldap.messages.AbstractMessage
getControls, getMessageId, getRawData, setControls, setMessageId, setRawData, toString
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

SCOPE_BASE_OBJECT

public static final int SCOPE_BASE_OBJECT
See Also:
Constant Field Values

SCOPE_SINGLE_LEVEL

public static final int SCOPE_SINGLE_LEVEL
See Also:
Constant Field Values

SCOPE_WHOLE_SUBTREE

public static final int SCOPE_WHOLE_SUBTREE
See Also:
Constant Field Values

DEREF_NEVER

public static final int DEREF_NEVER
See Also:
Constant Field Values

DEREF_IN_SEARCH

public static final int DEREF_IN_SEARCH
See Also:
Constant Field Values

DEREF_FINDING_BASE

public static final int DEREF_FINDING_BASE
See Also:
Constant Field Values

DEREF_ALWAYS

public static final int DEREF_ALWAYS
See Also:
Constant Field Values
Constructor Detail

SearchRequest

public SearchRequest()
Initialize the new instance with default values.

Method Detail

getBaseDN

public String getBaseDN()

setBaseDN

public void setBaseDN(String newValue)

getScope

public int getScope()

setScope

public void setScope(int newValue)

getDerefAliases

public int getDerefAliases()

setDerefAliases

public void setDerefAliases(int newValue)

getSizeLimit

public int getSizeLimit()

setSizeLimit

public void setSizeLimit(int newValue)

getTimeLimit

public int getTimeLimit()

setTimeLimit

public void setTimeLimit(int newValue)

getTypesOnly

public boolean getTypesOnly()

setTypesOnly

public void setTypesOnly(boolean newValue)

getFilter

public String getFilter()

setFilter

public void setFilter(String newValue)

getAttributeNames

public String[] getAttributeNames()

setAttributeNames

public void setAttributeNames(String[] newValue)

isSearchRequest

public boolean isSearchRequest()
Returns true if the receiver is a search request.

Overrides:
isSearchRequest in class RequestMessage

isScopeBaseObject

public boolean isScopeBaseObject()
Returns true if the scope of this search is the base object only


isScopeSingleLevel

public boolean isScopeSingleLevel()
Returns true if the scope of this search is the single level


isScopeWholeSubtree

public boolean isScopeWholeSubtree()
Returns true if the scope of this search is the whole subtree



Copyright © 2012 Manfred Duchrow Consulting & Software. All Rights Reserved.