com.sun.identity.cli

Interface IDefinition

All Known Implementing Classes:

AccessManager, CLIDefinitionBase, FederationManager

public interface IDefinition

This interface defines methods for a CLI definition class.

Method Summary

Modifier and Type	Method and Description
String	getLogName() Returns log name.
String	getProductName() Returns product name.
SubCommand	getSubCommand(String name) Returns sub command object.
List	getSubCommands() Returns a list of sub commands.
void	init(Locale locale) Initializes the definition class.
boolean	isAuthOption(String opt) Returns true if the option is an authentication related option such as user ID and password.

Method Detail

init

void init(Locale locale)
   throws CLIException

Initializes the definition class.

Parameters:

locale - Locale of the request.

Throws:

CLIException - if command definition cannot initialized.

getProductName

String getProductName()

Returns product name.

Returns:

product name.

getLogName

String getLogName()

Returns log name.

Returns:

log name.

getSubCommands

List getSubCommands()

Returns a list of sub commands.

Returns:

a list of sub commands.

getSubCommand

SubCommand getSubCommand(String name)

Returns sub command object.

Parameters:

name - Name of sub command.

Returns:

sub command object.

isAuthOption

boolean isAuthOption(String opt)

Returns true if the option is an authentication related option such as user ID and password.

Parameters:

opt - Name of option.

Returns:

true if the option is an authentication related option such as user ID and password.