org.ldaptive.cli

Class CompareOperationCli

java.lang.Object

org.ldaptive.cli.AbstractCli

org.ldaptive.cli.CompareOperationCli

public class CompareOperationCli
extends AbstractCli

Command line interface for CompareOperation.

Field Summary

Fields

Modifier and Type	Field and Description
private static String	COMMAND_NAME name of operation provided by this class.
private static String	OPT_ATTR option for LDAP attribute name/value pair.
private static String	OPT_DN option for LDAP DN.

Fields inherited from class org.ldaptive.cli.AbstractCli

OPT_HELP, OPT_PROVIDER_PROPERTIES, options, outputDsmlv1

Constructor Summary

Constructors

Constructor and Description
CompareOperationCli()

Method Summary

Modifier and Type	Method and Description
protected int	compare(ConnectionFactory cf, String dn, LdapAttribute attr) Executes the ldap compare operation.
protected int	dispatch(org.apache.commons.cli.CommandLine line) Dispatch command line data to the active that can perform the operation requested on the command line.
protected String	getCommandName() Returns the name of the command for which this class provides a CLI interface.
protected void	initOptions() Initialize CLI options.
static void	main(String[] args) CLI entry point method.

Methods inherited from class org.ldaptive.cli.AbstractCli

getArgDesc, getPropertiesFromOptions, initConnectionFactory, performAction, printExamples, printHelp

Methods inherited from class java.lang.Object

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

Field Detail

OPT_DN

private static final String OPT_DN

option for LDAP DN.

See Also:

Constant Field Values

OPT_ATTR

private static final String OPT_ATTR

option for LDAP attribute name/value pair.

See Also:

Constant Field Values

COMMAND_NAME

private static final String COMMAND_NAME

name of operation provided by this class.

See Also:

Constant Field Values

Constructor Detail

CompareOperationCli

public CompareOperationCli()

Method Detail

main

public static void main(String[] args)

CLI entry point method.

Parameters:

args - command line arguments.

initOptions

protected void initOptions()

Description copied from class: AbstractCli

Initialize CLI options.

Overrides:

initOptions in class AbstractCli

dispatch

protected int dispatch(org.apache.commons.cli.CommandLine line)
                throws Exception

Description copied from class: AbstractCli

Dispatch command line data to the active that can perform the operation requested on the command line.

Specified by:

dispatch in class AbstractCli

Parameters:

line - parsed command line arguments

Returns:

status code

Throws:

Exception - on errors thrown by action

compare

protected int compare(ConnectionFactory cf,
                      String dn,
                      LdapAttribute attr)
               throws Exception

Executes the ldap compare operation.

Parameters:

cf - connection factory

dn - to compare attribute on

attr - attribute to compare

Returns:

status code

Throws:

Exception - on any LDAP search error

getCommandName

protected String getCommandName()

Description copied from class: AbstractCli

Returns the name of the command for which this class provides a CLI interface.

Specified by:

getCommandName in class AbstractCli

Returns:

name of CLI command