org.ldaptive.cli

Class AuthenticatorCli

java.lang.Object

org.ldaptive.cli.AbstractCli

org.ldaptive.cli.AuthenticatorCli

public class AuthenticatorCli
extends AbstractCli

Command line interface for Authenticator.

Field Summary

Fields

Modifier and Type	Field and Description
private static java.lang.String	COMMAND_NAME name of operation provided by this class.
private static java.lang.String	OPT_DSMLV1 option for dsmlv1 output.

Fields inherited from class org.ldaptive.cli.AbstractCli

OPT_HELP, OPT_PROVIDER_PROPERTIES, options, outputDsmlv1

Constructor Summary

Constructors

Constructor and Description
AuthenticatorCli()

Method Summary

Modifier and Type	Method and Description
protected int	authenticate(Authenticator auth, AuthenticationRequest request) Executes the authentication 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 java.lang.String	getCommandName() Returns the name of the command for which this class provides a CLI interface.
protected AuthenticationRequest	initAuthenticationRequest(org.apache.commons.cli.CommandLine line) Initialize an authentication request with command line options.
protected Authenticator	initAuthenticator(org.apache.commons.cli.CommandLine line) Initialize an Authenticator with command line options.
protected void	initOptions() Initialize CLI options.
static void	main(java.lang.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_DSMLV1

private static final java.lang.String OPT_DSMLV1

option for dsmlv1 output.

See Also:

Constant Field Values

COMMAND_NAME

private static final java.lang.String COMMAND_NAME

name of operation provided by this class.

See Also:

Constant Field Values

Constructor Detail

AuthenticatorCli

public AuthenticatorCli()

Method Detail

main

public static void main(java.lang.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

initAuthenticator

protected Authenticator initAuthenticator(org.apache.commons.cli.CommandLine line)

Initialize an Authenticator with command line options.

Parameters:

line - parsed command line arguments

Returns:

authenticator that has been initialized

initAuthenticationRequest

protected AuthenticationRequest initAuthenticationRequest(org.apache.commons.cli.CommandLine line)

Initialize an authentication request with command line options.

Parameters:

line - parsed command line arguments

Returns:

authentication request that has been initialized

dispatch

protected int dispatch(org.apache.commons.cli.CommandLine line)
                throws java.lang.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:

java.lang.Exception - on errors thrown by action

authenticate

protected int authenticate(Authenticator auth,
                           AuthenticationRequest request)
                    throws java.lang.Exception

Executes the authentication operation.

Parameters:

auth - authenticator

request - authentication request

Returns:

status code

Throws:

java.lang.Exception - on any LDAP error

getCommandName

protected java.lang.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