Package com.sun.identity.cli
Interface IDefinition
-
- All Known Implementing Classes:
AccessManager,CLIDefinitionBase,FederationManager
public interface IDefinitionThis interface defines methods for a CLI definition class.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description StringgetLogName()Returns log name.StringgetProductName()Returns product name.SubCommandgetSubCommand(String name)Returns sub command object.ListgetSubCommands()Returns a list of sub commands.voidinit(Locale locale)Initializes the definition class.booleanisAuthOption(String opt)Returnstrueif 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)
Returnstrueif the option is an authentication related option such as user ID and password.- Parameters:
opt- Name of option.- Returns:
trueif the option is an authentication related option such as user ID and password.
-
-