ListBackupsCommand (Payara Project 6.2022.1.Alpha3 API)

java.lang.Object
- com.sun.enterprise.admin.cli.CLICommand
- - com.sun.enterprise.admin.servermgmt.cli.LocalServerCommand
  - - com.sun.enterprise.admin.servermgmt.cli.LocalDomainCommand
    - - com.sun.enterprise.admin.cli.optional.BackupCommands
      - com.sun.enterprise.admin.cli.optional.ListBackupsCommand

All Implemented Interfaces:

org.glassfish.hk2.api.PostConstruct
```
@Service(name="list-backups")
@PerLookup
public final class ListBackupsCommand
extends BackupCommands
```
This is a local command for listing backed up domains.

Field Summary
- Fields inherited from class com.sun.enterprise.admin.servermgmt.cli.LocalDomainCommand
  domainDirParam
- Fields inherited from class com.sun.enterprise.admin.servermgmt.cli.LocalServerCommand
  DEFAULT_MASTER_PASSWORD
- Fields inherited from class com.sun.enterprise.admin.cli.CLICommand
  argv, ASADMIN, commandModel, CONNECTION_ERROR, env, ERROR, INVALID_COMMAND_ERROR, lineReader, logger, metadataErrors, name, operands, options, passwords, programOpts, SUCCESS, terminal, WARNING

Constructor Summary

Constructors
Constructor Description

ListBackupsCommand()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`protected int`	`executeCommand()`	Execute the command using the options in options and the operands in operands.
`String`	`toString()`
`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.optional.BackupCommands
checkOptions, isWritableDirectory, prepareRequest, setBackupDir, setDescription, setRecycleLimit

Methods inherited from class com.sun.enterprise.admin.servermgmt.cli.LocalDomainCommand
getDomainName, getDomainRootDir, getDomainsDir, initDomain, isThisDAS, prepare, setDomainName

Methods inherited from class com.sun.enterprise.admin.servermgmt.cli.LocalServerCommand
checkAdditionalTrustAndKeyStores, checkForSpecialFiles, dataGridEncryptionEnabled, getAdminAddress, getAdminAddress, getDomainXml, getInstallRootPath, getMasterPassword, getMasterPasswordFile, getPrevPid, getServerDirs, getServerPid, getUptime, isLocal, isRemote, isRestartable, isRunning, isRunning, isThisServer, loadAndVerifyKeystore, readFromMasterPasswordFile, resetServerDirs, setLocalPassword, setServerDirs, unsetLocalPassword, verifyMasterPassword, waitForRestart, waitForRestart

Methods inherited from class com.sun.enterprise.admin.cli.CLICommand
buildLineReader, buildTerminal, checkHelp, closeTerminal, execute, execute, expandManPage, getBooleanOption, getBriefCommandUsage, getCommand, getCommand, getCommandScope, getCommandUsage, getManPage, getName, getOperandModel, getOption, getOptions, getPassword, getPassword, getProgramOptions, getSystemProperties, getSystemProperty, getUsage, initializeLogger, initializePasswords, inject, newLineReaderBuilder, ok, parse, postConstruct, prevalidate, printExceptionStackTrace, processProgramOptions, quote, readPassword, setCommandScope, usageOptions

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - ListBackupsCommand
```
public ListBackupsCommand()
```
- Method Detail
  - validate
```
protected void validate()
                 throws CommandException
```
    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 LocalDomainCommand
    
    Throws:
    
    CommandException - if execution of the command fails
    
    CommandValidationException - if there's something wrong with the options or arguments
  - executeCommand
```
protected int executeCommand()
                      throws CommandException
```
    Description copied from class: CLICommand
    
    Execute the command using the options in options and the operands in operands.
    
    Specified by:
    
    executeCommand in class CLICommand
    
    Returns:
    
    the exit code
    
    Throws:
    
    CommandException - if execution of the command fails
    
    CommandValidationException - if there's something wrong with the options or arguments
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class BackupCommands