org.opends.admin.ads
Class TopologyCacheFilter

java.lang.Object
  extended by org.opends.admin.ads.TopologyCacheFilter

public class TopologyCacheFilter
extends java.lang.Object

Class used to filter what we look for in the topology cache. This is done in particular to avoid problems of performance when we know what we are looking for. It is particularly useful to avoid searching for monitoring information.


Constructor Summary
TopologyCacheFilter()
           
 
Method Summary
 void addBaseDNToSearch(java.lang.String dn)
          Adds one of the base DNs we must search for.
 java.util.Set<java.lang.String> getBaseDNsToSearch()
          Returns the list of base DNs that will be searched for.
 void removeBaseDNToSearch(java.lang.String dn)
          Removes a base DN fom the list of baseDNs to search.
 boolean searchAllBaseDNs()
          Tells whether this filter specifies to search for all the base DNs or not.
 boolean searchBaseDNInformation()
          Returns whether we must search for base DN information or not.
 boolean searchMonitoringInformation()
          Returns whether we must search for monitoring information or not.
 void setSearchBaseDNInformation(boolean searchBaseDNInformation)
          Sets whether we must search for base DN information or not.
 void setSearchMonitoringInformation(boolean searchMonitoringInformation)
          Sets whether we must search for monitoring information or not.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

TopologyCacheFilter

public TopologyCacheFilter()
Method Detail

searchBaseDNInformation

public boolean searchBaseDNInformation()
Returns whether we must search for base DN information or not.

Returns:
true if we must search base DN information and false otherwise.

setSearchBaseDNInformation

public void setSearchBaseDNInformation(boolean searchBaseDNInformation)
Sets whether we must search for base DN information or not.

Parameters:
searchBaseDNInformation - whether we must search for base DN information or not.

searchMonitoringInformation

public boolean searchMonitoringInformation()
Returns whether we must search for monitoring information or not.

Returns:
true if we must search monitoring information and false otherwise.

setSearchMonitoringInformation

public void setSearchMonitoringInformation(boolean searchMonitoringInformation)
Sets whether we must search for monitoring information or not.

Parameters:
searchMonitoringInformation - whether we must search for monitoring information or not.

addBaseDNToSearch

public void addBaseDNToSearch(java.lang.String dn)
Adds one of the base DNs we must search for. If at least one baseDN is added using this method, only the added baseDNs are searched. If no base DN is added, all the base DNs will be retrieved.

Parameters:
dn - the DN of the base DN to look for.

removeBaseDNToSearch

public void removeBaseDNToSearch(java.lang.String dn)
Removes a base DN fom the list of baseDNs to search.

Parameters:
dn - the DN of the base DN to be removed.

getBaseDNsToSearch

public java.util.Set<java.lang.String> getBaseDNsToSearch()
Returns the list of base DNs that will be searched for. If the list is empty we will search for all the base DNs.

Returns:
the list of base DNs we will search for.

searchAllBaseDNs

public boolean searchAllBaseDNs()
Tells whether this filter specifies to search for all the base DNs or not.

Returns:
true if the filter specifies to search for all the base DNs and false otherwise.