org.apache.ldap.clients
Class SearchOpts

java.lang.Object
  org.apache.ldap.clients.Opts
      org.apache.ldap.clients.BindOpts
          org.apache.ldap.clients.SearchOpts

public class SearchOpts
extends BindOpts

Delete operation command line options bean.

Field Summary

Fields inherited from class org.apache.ldap.clients.BindOpts

bindDn, DEFAULT_HOST, DEFAULT_MAX_ENTRIES, DEFAULT_MAX_TIME, DEFAULT_PORT, host, isDryRun, isVerbose, isVersion3, options, password, port

Fields inherited from class org.apache.ldap.clients.Opts

BASEDN_OPT, baseDnOption, BINDDN_OPT, bindDnOption, FILE_OPT, fileOption, HOST_OPT, hostOption, MAX_ENTRIES_OPT, MAX_TIME_OPT, maxEntriesOption, maxTimeOption, NOTHING_OPT, nothingOption, PASSWORD_OPT, passwordOption, PORT_OPT, portOption, PROTOCOL_OPT, protocolOption, QUIET_OPT, quietOption, SCOPE_OPT, scopeOption, TYPES_OPT, typesOption, VERBOSE_OPT, verboseOption

Constructor Summary

SearchOpts()

Method Summary

java.lang.String	getBase() Get the base DN to start the search from
java.lang.String	getFilter() Get the search filter in a string format
int	getMaxEntries()
int	getMaxTime()
ScopeEnum	getScope() Get the Scope for the search
boolean	isQuietMode()
boolean	isTypesMode()
void	process(java.lang.String[] argv) Overrides BindOpts.process to be able to get the deleted entry's Dn.
void	setBase(java.lang.String base) Set the base DN to start the search from
void	setFilter(java.lang.String filter) Set the search filter
void	setMaxEntries(int maxEntries) Set the maximum of entries to retrieve
void	setMaxTime(int maxTime) Set the maximum of entries to retrieve
void	setQuietMode(boolean quietMode)
void	setScope(ScopeEnum scope) Set the Scope for the search
void	setTypesMode(boolean typesMode)

Methods inherited from class org.apache.ldap.clients.BindOpts

getBindDn, getHost, getOptions, getPassword, getPort, isDryRun, isVerbose, isVersion3, setBindDn, setHost, setIsDryRun, setIsVerbose, setIsVersion3, setPassword, setPort

Methods inherited from class org.apache.ldap.clients.Opts

getParser, isProcessed, setProcessed

Methods inherited from class java.lang.Object

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

Constructor Detail

SearchOpts

public SearchOpts()

Method Detail

getBase

public java.lang.String getBase()

Get the base DN to start the search from

Returns:

DN to start the search from

getFilter

public java.lang.String getFilter()

Get the search filter in a string format

Returns:

Search filter

getMaxTime

public int getMaxTime()

Returns:

isQuietMode

public boolean isQuietMode()

Returns:

isTypesMode

public boolean isTypesMode()

Returns:

getScope

public ScopeEnum getScope()

Get the Scope for the search

Returns:

Search Scope: BASEOBJECT - only the base DN SINGLELEVEL - only the current subtree level WHOLESUBTREE - the entire tree

getMaxEntries

public int getMaxEntries()

Returns:

setBase

public void setBase(java.lang.String base)

Set the base DN to start the search from

Parameters:

base - DN to start the search from

setFilter

public void setFilter(java.lang.String filter)

Set the search filter

Parameters:

filter - Search Filter

setQuietMode

public void setQuietMode(boolean quietMode)

Parameters:

a_b -

setTypesMode

public void setTypesMode(boolean typesMode)

Parameters:

-

setScope

public void setScope(ScopeEnum scope)

Set the Scope for the search

Parameters:

scope - Search Scope: BASEOBJECT - only the base DN SINGLELEVEL - only the current subtree level WHOLESUBTREE - the entire tree

setMaxEntries

public void setMaxEntries(int maxEntries)

Set the maximum of entries to retrieve

Parameters:

maxEntries -

setMaxTime

public void setMaxTime(int maxTime)

Set the maximum of entries to retrieve

Parameters:

maxTime -

process

public void process(java.lang.String[] argv)
             throws ParseException

Overrides BindOpts.process to be able to get the deleted entry's Dn.

Overrides:

process in class BindOpts

Parameters:

argv - the variable argument list from the command line.

Throws:

ParseException - if any of the command line option is incorrect