com.sun.enterprise.admin.cli
Class LocalDomainCommand

java.lang.Object
  com.sun.enterprise.admin.cli.CLICommand
      com.sun.enterprise.admin.cli.LocalServerCommand
          com.sun.enterprise.admin.cli.LocalDomainCommand

All Implemented Interfaces:

org.jvnet.hk2.component.PostConstruct

Direct Known Subclasses:

ChangeAdminPasswordCommand, StartDomainCommand, StopDomainCommand

public abstract class LocalDomainCommand
extends LocalServerCommand

A class that's supposed to capture all the behavior common to operation on a "local" domain. It's supposed to act as the abstract base class that provides more functionality to the commands that operate on a local domain.

Author:

केदार (km@dev.java.net), Byron Nevins (bnevins@dev.java.net)

Field Summary

private DomainDirs	dd
private static String	DOMAIN_ROOT_KEY
protected String	domainDirParam
private String	userArgDomainName

Fields inherited from class com.sun.enterprise.admin.cli.CLICommand

argv, commandModel, CONNECTION_ERROR, env, ERROR, INVALID_COMMAND_ERROR, logger, metadataErrors, name, operands, options, passwords, programOpts, SUCCESS, WARNING

Constructor Summary

LocalDomainCommand()

Method Summary

protected String	getDomainName()
protected File	getDomainRootDir()
protected File	getDomainsDir()
protected void	initDomain()
protected boolean	isThisDAS(File ourDir)
protected void	prepare() The prepare method must ensure that the commandModel field is set.
protected void	setDomainName(String name) We need this so that @Param values for domainname can be remembered later when the ServerDirs object is made.
protected void	validate() The validate method can be used by a subclass to validate that the type and quantity of parameters and operands matches the requirements for this command.

Methods inherited from class com.sun.enterprise.admin.cli.LocalServerCommand

checkForSpecialFiles, getAdminAddress, getAdminAddress, getDomainXml, getMasterPassword, getMasterPasswordFile, getPrevPid, getServerDirs, getUptime, isRestartable, isRunning, isRunning, isRunning, isThisServer, loadAndVerifyKeystore, readFromMasterPasswordFile, resetServerDirs, setLocalPassword, setServerDirs, unsetLocalPassword, verifyMasterPassword, waitForRestart

Methods inherited from class com.sun.enterprise.admin.cli.CLICommand

checkHelp, execute, executeCommand, getBooleanOption, getCommand, getManPage, getName, getOperandModel, getOption, getPassword, getProgramOptions, getSystemProperties, getSystemProperty, getUsage, initializeLogger, initializePasswords, inject, ok, parse, postConstruct, prevalidate, printExceptionStackTrace, processProgramOptions, quote, readPassword, toString, usageOptions

Methods inherited from class java.lang.Object

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

Field Detail

domainDirParam

protected String domainDirParam

userArgDomainName

private String userArgDomainName

DOMAIN_ROOT_KEY

private static final String DOMAIN_ROOT_KEY

See Also:

Constant Field Values

dd

private DomainDirs dd

Constructor Detail

LocalDomainCommand

public LocalDomainCommand()

Method Detail

prepare

protected void prepare()
                throws CommandException,
                       CommandValidationException

Description copied from class: CLICommand

The prepare method must ensure that the commandModel field is set.

Overrides:

prepare in class CLICommand

Throws:

CommandException

CommandValidationException

validate

protected void validate()
                 throws CommandException,
                        CommandValidationException

Description copied from class: CLICommand

The validate method can be used by a subclass to validate that the type and quantity of parameters and operands matches the requirements for this command.

Overrides:

validate in class CLICommand

Throws:

CommandException - if execution of the command fails

CommandValidationException - if there's something wrong with the options or arguments

getDomainsDir

protected final File getDomainsDir()

getDomainRootDir

protected final File getDomainRootDir()

getDomainName

protected final String getDomainName()

setDomainName

protected final void setDomainName(String name)

We need this so that @Param values for domainname can be remembered later when the ServerDirs object is made.

Parameters:

name - the user-specified domain name.

initDomain

protected void initDomain()
                   throws CommandException

Throws:

CommandException

isThisDAS

protected boolean isThisDAS(File ourDir)