com.aspc.commander.sql

Class ShutdownCommand

java.lang.Object

com.aspc.commander.Command

com.aspc.commander.sql.SQLCommand

com.aspc.commander.sql.ShutdownCommand

All Implemented Interfaces:

CommandBuildResultsPlugin

public class ShutdownCommand
extends SQLCommand

Shuts down the system instantly and writes msg to the log file. Will not shut down unless system property "AREA" is defined Will not shut down if system property AREA has a value beginning with "prod"
Syntax

  SHUTDOWN [MESSAGE msg]
  

Usage

  SHUTDOWN MESSAGE "Your system is being shut down remotely by Fred Blogs"
  

THREAD MODE: SINGLE THREADED command

Since:

July 31st 2008

Author:

Paul Smout

Field Summary

Fields inherited from class com.aspc.commander.sql.SQLCommand

CURSOR_SIZE

Constructor Summary

Constructors

Constructor and Description
ShutdownCommand(Connection connection, Pattern pattern) Creates a new SchedulerPreferencesCommand

Method Summary

Modifier and Type	Method and Description
void	execute(Parser parser) Shuts down the system if the AREA property exists and is not set to PROD
java.lang.String	getColumnName(int col) Gets the col name
java.lang.String	getColumnType(int col) Gets the col type
java.lang.String	getRecordID(int row) Gets the record id
java.lang.Object	getValue(int row, int col) Gets a cell value
protected void	log(java.lang.String msg) Log a message.
protected void	shutdown() Shutdown the system now.

Methods inherited from class com.aspc.commander.sql.SQLCommand

appendResult, appendResult, getCursorName, getRecordKey, isExecuteOnly

Methods inherited from class com.aspc.commander.Command

execute, extMakeThreadName, getConnection, getPattern, getRawTitle, getTitle, makeThreadName, recordCall, setTitle

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.aspc.commander.sql.results.CommandBuildResultsPlugin

getRawTitle

Constructor Detail

ShutdownCommand

public ShutdownCommand(Connection connection,
                       Pattern pattern)

Creates a new SchedulerPreferencesCommand

Parameters:

connection - the command connection

pattern - the command pattern

Method Detail

execute

public void execute(Parser parser)
             throws java.lang.Exception

Shuts down the system if the AREA property exists and is not set to PROD

Specified by:

execute in class Command

Parameters:

parser - the command parser

Throws:

java.lang.Exception - a problem executing the command

shutdown

protected void shutdown()

Shutdown the system now. Protected so that it can be overridden in tests.

log

protected void log(java.lang.String msg)

Log a message. Protected so that it can be overridden in tests.

Parameters:

msg - the message.

getValue

public java.lang.Object getValue(int row,
                                 int col)

Gets a cell value

Parameters:

row - the cell row

col - the cell col

Returns:

Object the cell value

getColumnType

public java.lang.String getColumnType(int col)

Gets the col type

Parameters:

col - the col to type

Returns:

String the col type

getColumnName

public java.lang.String getColumnName(int col)

Gets the col name

Parameters:

col - the col to name

Returns:

String the col name

getRecordID

public java.lang.String getRecordID(int row)

Gets the record id

Parameters:

row - the row to id

Returns:

String the record id