Skip navigation links

com.octetstring.vde.chain
Class ChainEntrySet

java.lang.Object
com.octetstring.vde.chain.ChainEntrySet

All Implemented Interfaces:

EntrySet

public class ChainEntrySet

extends java.lang.Object

implements EntrySet

Adapters have different ways of managing a set of entries returned in a search. This interface is implemented by classes that know how to retrieve the next entry in a result.

Constructor Summary

ChainEntrySet(EntrySet entrySet, int start)

Method Summary

void	cancelEntrySet()
Adapter	getBackend()
DirectoryString	getBase()
EntrySet	getBaseES()
Credentials	getCreds()
Filter	getFilter()
Entry	getNext() Retrieves the next available entry from the Entry Set
java.util.HashMap<java.lang.Object,java.lang.Object>	getRequest()
java.util.Vector<DirectoryString>	getReturnAttribs()
Int8	getScope()
java.lang.Object	getSequence()
int	getStartPoint()
boolean	hasMore() Determines whether this ChainEntrySet has any more available entries
boolean	isRunACLs()
boolean	isRunGlobal()
void	runGlobal(boolean runGlobal)
boolean	runPostSearch()
void	setBackend(Adapter backend)
void	setBase(DirectoryString base)
void	setCredentials(Credentials creds)
void	setCreds(Credentials credentials)
void	setFilter(Filter filter)
void	setRequest(java.util.HashMap<java.lang.Object,java.lang.Object> request)
void	setReturnAttribs(java.util.Vector<DirectoryString> attribs)
void	setRunACLs(boolean b)
void	setRunGlobal(boolean b)
void	setRunPostSearch(boolean b)
void	setScope(Int8 scope)
void	setSequence(java.lang.Object sequence)
void	setStartPoint(int start)

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ChainEntrySet

public ChainEntrySet(EntrySet entrySet,
                     int start)

Method Detail

getBaseES

public EntrySet getBaseES()

getNext

public Entry getNext()
              throws DirectoryException

Retrieves the next available entry from the Entry Set

Specified by:

getNext in interface EntrySet

Returns:

the next available Entry

Throws:

DirectoryException

hasMore

public boolean hasMore()

Determines whether this ChainEntrySet has any more available entries

Specified by:

hasMore in interface EntrySet

Returns:

true if more entries are available

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

getBackend

public Adapter getBackend()

setRequest

public void setRequest(java.util.HashMap<java.lang.Object,java.lang.Object> request)

setCredentials

public void setCredentials(Credentials creds)

runGlobal

public void runGlobal(boolean runGlobal)

getBase

public DirectoryString getBase()

Returns:

DirectoryString containing the original search base

getCreds

public Credentials getCreds()

Returns:

Credentials object containing the current user context

getFilter

public Filter getFilter()

Returns:

Filter object containing the original search filter

getRequest

public java.util.HashMap<java.lang.Object,java.lang.Object> getRequest()

Returns:

HashMap containing additional operation parameters

getReturnAttribs

public java.util.Vector<DirectoryString> getReturnAttribs()

Returns:

Vector of DirectoryStrings representing the originally requested attributes

isRunGlobal

public boolean isRunGlobal()

Returns:

boolean indicating if this chain is a global context chain

getScope

public Int8 getScope()

Returns:

Int8 value representing the original search scope

setBase

public void setBase(DirectoryString base)

Parameters:

base - a DirectoryString value representing the search base

setCreds

public void setCreds(Credentials credentials)

Parameters:

credentials - Credentials object representing the user context

setFilter

public void setFilter(Filter filter)

Parameters:

filter - a Filter object representing the search filter

setReturnAttribs

public void setReturnAttribs(java.util.Vector<DirectoryString> attribs)

Parameters:

attribs - Vector of DirectoryStrings representing the requested attributes

setRunGlobal

public void setRunGlobal(boolean b)

Parameters:

b - boolean indicating that this is a globa chain (INTERNAL USE ONLY)

setScope

public void setScope(Int8 scope)

Parameters:

scope - an Int8 value representing the search scope

isRunACLs

public boolean isRunACLs()

Returns:

a boolean flag indicating whether acls are run on this chain

setRunACLs

public void setRunACLs(boolean b)

Parameters:

b - boolean flag indicating whether acls are to be run.

runPostSearch

public boolean runPostSearch()

Returns:

a boolean flag indicating whether post search operations to be performed (i.e. entry processing).

setRunPostSearch

public void setRunPostSearch(boolean b)

Parameters:

b - a boolean flag indicating whether entry level processing should be performed.

setBackend

public void setBackend(Adapter backend)

Parameters:

backend - an Adapter object representing the adapter associated with this chain.

setStartPoint

public void setStartPoint(int start)

Parameters:

start - an integer (starting at 0) representing the position within the chain to start execution.

getStartPoint

public int getStartPoint()

Returns:

an integer indicating the starting position in the chain to begin execution.

cancelEntrySet

public void cancelEntrySet()

Specified by:

cancelEntrySet in interface EntrySet

Skip navigation links