Skip navigation links

Oracle Virtual Directory Java API Reference
11g Release 1 (11.1.1)

E10688-01


com.octetstring.vde.chain.plugins.tree
Class NodeEntrySet

java.lang.Object
  extended by com.octetstring.vde.chain.plugins.tree.NodeEntrySet

All Implemented Interfaces:
EntrySet

public class NodeEntrySet
extends java.lang.Object
implements EntrySet

Generic entryset class. A Vector of Entry objects defines the results to be returned. This class can be extended to support paging by extending the retrieveNextPage() method.


Field Summary
static VDELogger logger
           

 

Constructor Summary
NodeEntrySet(TreePlugin plugin, Chain chain, java.lang.Object searchInfo, java.util.Vector entries)
          This constructor used when returning only "static" entries that are part of the logical Node hierachy generated by this adapter.
NodeEntrySet(TreePlugin plugin, Chain chain, java.lang.Object searchInfo, java.util.Vector entries, java.util.Vector baseComps, Filter filter)
          This constructor is used when returning "static" entries as well as entries generated by querying the the search function of the web service.

 

Method Summary
 void cancelEntrySet()
           
 java.util.Vector getBaseComps()
           
 Chain getChain()
           
 Filter getFilter()
           
 Entry getNext()
          Retrieves the next available entry from the Entry Set
 TreePlugin getPlugin()
           
 java.lang.Object getSearchRequest()
           
 java.lang.Object getSequence()
           
 boolean hasMore()
          Determines whether this EntrySet has any more available entries
 void retrieveNextPage()
          retrieveNextPage() enables results from a service to be returned in pages.
 void setPagingSearchRequest(java.lang.Object request)
           
 void setSequence(java.lang.Object sequence)
           

 

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

 

Field Detail

logger

public static VDELogger logger

Constructor Detail

NodeEntrySet

public NodeEntrySet(TreePlugin plugin,
                    Chain chain,
                    java.lang.Object searchInfo,
                    java.util.Vector entries)
             throws DirectoryException
This constructor used when returning only "static" entries that are part of the logical Node hierachy generated by this adapter.
Parameters:
plugin - The parent plug-in
chain - The chain instance for the current transaction
searchInfo - Optional object to pass additional search info into the entry set.
entries - The entries to be returned
Throws:
DirectoryException

NodeEntrySet

public NodeEntrySet(TreePlugin plugin,
                    Chain chain,
                    java.lang.Object searchInfo,
                    java.util.Vector entries,
                    java.util.Vector baseComps,
                    Filter filter)
             throws DirectoryException
This constructor is used when returning "static" entries as well as entries generated by querying the the search function of the web service. If, during the construction of this results set, the search base is determined to be invalid, the NO SUCH OBJECT directory exception should be thrown. exception.
Parameters:
plugin - The parent plug-in
chain - The chain instance for the current transaction
searchInfo - Optional object to pass additional search info into the entry set.
entries - Static entries to be returned (e.g. parent objects)
baseComps - The parent DN (exploded into a Vector) for all generated results
filter - The LDAP search filter specified by the user
Throws:
DirectoryException

Method Detail

hasMore

public boolean hasMore()
Description copied from interface: EntrySet
Determines whether this EntrySet has any more available entries
Specified by:
hasMore in interface EntrySet
Returns:
true if more entries are available

getNext

public Entry getNext()
              throws DirectoryException
Description copied from interface: EntrySet
Retrieves the next available entry from the Entry Set
Specified by:
getNext in interface EntrySet
Returns:
the next available Entry
Throws:
DirectoryException

setSequence

public void setSequence(java.lang.Object sequence)
Specified by:
setSequence in interface EntrySet

getSequence

public java.lang.Object getSequence()
Specified by:
getSequence in interface EntrySet

cancelEntrySet

public void cancelEntrySet()
Specified by:
cancelEntrySet in interface EntrySet

retrieveNextPage

public void retrieveNextPage()
                      throws DirectoryException
retrieveNextPage() enables results from a service to be returned in pages. Each page returned by the service is processed into individual LDAP Entries and stored in the buffer entriesToReturn. When empty, this method will replenish the buffer until the service indicates no more results to return. Note: if the service does not support paging, simply use this method to retrieve all the results and set moreToSearch to false. The method should use the object searchRequest (defined in the constructor to locate information on what to search.
Throws:
DirectoryException

getPlugin

public TreePlugin getPlugin()

getChain

public Chain getChain()

getFilter

public Filter getFilter()

getBaseComps

public java.util.Vector getBaseComps()

getSearchRequest

public java.lang.Object getSearchRequest()

setPagingSearchRequest

public void setPagingSearchRequest(java.lang.Object request)

Skip navigation links

Oracle Virtual Directory Java API Reference
11g Release 1 (11.1.1)

E10688-01


Copyright © 2009 Oracle. All Rights Reserved.