com.aspc.commander.sql

Class FileSyncCommand

java.lang.Object

com.aspc.commander.Command

com.aspc.commander.sql.SQLCommand

com.aspc.commander.sql.FileSyncCommand

All Implemented Interfaces:

CommandBuildResultsPlugin

public class FileSyncCommand
extends SQLCommand

The file sync command is a low permission command that allows us to request that a file should be moved from one file server to another. We don't need permissions to see a file for this command to work. As we don't return any details of this file, there is no security issues.
Syntax

  FILE_SYNC [file_key LOCATION file_server] | [PURGE [LOCATION file_server] [FROM modifyFrom] [TO modifyTo]]
  

Usage

  /* Sync file to another location */
  FILE_SYNC file_key location
  
  /* Purge the duplicated file in DEFAULT filestore in given date period */
  FILE_SYNC PURGE FROM '1 Jan 2006' TO '1 Jan 2007'
  
  /* Purge the duplicated file in NAM filestore */
  FILE_SYNC PURGE LOCATION 'NAM'
  

THREAD MODE: SINGLE THREADED command

Since:

6 July 2006

Author:

padma

Field Summary

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

CURSOR_SIZE

Constructor Summary

Constructors

Constructor and Description
FileSyncCommand(Connection connection, Pattern pattern) Creates a new FileCommand object.

Method Summary

Modifier and Type	Method and Description
protected void	execute(Parser p) execute the command.
java.lang.String	getColumnName(int col) implements getColumnName of interface CommandBuildResultsPlugin.
java.lang.String	getColumnType(int col) Implements getColumnType of interface CommandBuildResultsPlugin.
java.lang.String	getRecordID(int row) Implements getRecordID of interface CommandBuildResultsPlugin.
java.lang.Object	getValue(int row, int col) Implements getValue method of interface CommandBuildResultsPlugin.

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

FileSyncCommand

public FileSyncCommand(Connection connection,
                       Pattern pattern)

Creates a new FileCommand object.

Parameters:

connection - the connection the command was issued from

pattern - the command pattern

Method Detail

execute

protected void execute(Parser p)
                throws java.lang.Exception

execute the command.

Specified by:

execute in class Command

Parameters:

p - The parser

Throws:

java.lang.Exception - A serious problem

getValue

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

Implements getValue method of interface CommandBuildResultsPlugin. Gets the value for the given row and column indexes. Indexes start at 1.

Parameters:

row - the index of the row

col - the index of the column

Returns:

Object the value for the given row and column

Throws:

java.lang.Exception - a serious problem

getColumnType

public java.lang.String getColumnType(int col)
                               throws java.lang.Exception

Implements getColumnType of interface CommandBuildResultsPlugin. Gets a string representation of the column type for the given index. Column indexes start at 1.

Parameters:

col - the column number to get type of

Returns:

String the string for the column type

Throws:

java.lang.Exception - Serious Error

getColumnName

public java.lang.String getColumnName(int col)

implements getColumnName of interface CommandBuildResultsPlugin. Returns the name for the given column index. Column indexes start at 1

Parameters:

col - the column number to name

Returns:

String the name of the column

getRecordID

public java.lang.String getRecordID(int row)

Implements getRecordID of interface CommandBuildResultsPlugin. Gets the record id for the given row index. Row indexes start at 1.

Parameters:

row - the index of the row to identify

Returns:

String the record id