Package edu.vt.middleware.ldap.auth

Class AuthenticatorCli

java.lang.Object

edu.vt.middleware.ldap.AbstractCli

edu.vt.middleware.ldap.auth.AuthenticatorCli

public class AuthenticatorCli
extends AbstractCli

Command line interface for authenticator operations.

Version:

$Revision: 1330 $

Author:

Middleware Services

Field Summary

Fields inherited from class edu.vt.middleware.ldap.AbstractCli

logger, OPT_DSMLV1, OPT_DSMLV2, OPT_HELP, OPT_TRACE, OPT_USE_PROPERTIES, options, opts, outputDsmlv1, outputDsmlv2

Constructor Summary

Constructors

Constructor	Description
AuthenticatorCli()

Method Summary

Modifier and Type	Method	Description
protected void	authenticate(AuthenticatorConfig config, java.lang.String[] attrs)	Executes the authenticate operation.
protected void	dispatch(org.apache.commons.cli.CommandLine line)	Dispatch command line data to the handler that can perform the operation requested on the command line.
protected java.lang.String	getCommandName()	Gets the name of the command for which this class provides a CLI interface.
protected AuthenticatorConfig	initAuthenticatorConfig(org.apache.commons.cli.CommandLine line)	Initialize an AuthenticatorConfig 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 edu.vt.middleware.ldap.AbstractCli

getArgs, initLdapProperties, initOptions, performAction, printExamples, printHelp

Methods inherited from class java.lang.Object

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

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()

Initialize CLI options.

Specified by:

initOptions in class AbstractCli

initAuthenticatorConfig

protected AuthenticatorConfig initAuthenticatorConfig(org.apache.commons.cli.CommandLine line)
                                               throws java.lang.Exception

Initialize an AuthenticatorConfig with command line options.

Parameters:

line - Parsed command line arguments container.

Returns:

AuthenticatorConfig that has been initialized

Throws:

java.lang.Exception - On errors thrown by handler.

dispatch

protected void dispatch(org.apache.commons.cli.CommandLine line)
                 throws java.lang.Exception

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

Specified by:

dispatch in class AbstractCli

Parameters:

line - Parsed command line arguments container.

Throws:

java.lang.Exception - On errors thrown by handler.

authenticate

protected void authenticate(AuthenticatorConfig config,
                            java.lang.String[] attrs)
                     throws java.lang.Exception

Executes the authenticate operation.

Parameters:

config - Authenticator configuration.

attrs - Ldap attributes to return

Throws:

java.lang.Exception - On errors.

getCommandName

protected java.lang.String getCommandName()

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

Specified by:

getCommandName in class AbstractCli

Returns:

Name of CLI command.