com.aspc.commander.sql

Class FileCommand

java.lang.Object

com.aspc.commander.Command

com.aspc.commander.sql.SQLCommand

com.aspc.commander.sql.FileCommand

All Implemented Interfaces:

CommandBuildResultsPlugin

public class FileCommand
extends SQLCommand

Basic file handling.
Syntax

  FILE
     [INFO     [[PATH path_name] | [KEY file_key]]
       [COLUMNS column_name[,...]] ] |
     [READ     [[PATH path_name] | [KEY file_key]] ] |
     [CHECKOUT [[PATH path_name] | [KEY file_key]] ] |
     [CHECKIN  [[PATH path_name] | [KEY file_key]] ] |
     [UPLOAD data] |
     [CLOSE] |
     [CREATE path_name [DESCRIPTION text] [LOCATION store_code]] |
     [SUBMIT file_key [GZIP] [CIPHER cipher_key [IVEC iv_key]]
      [CHECKSUM checksum_value] [RAW_CHECKSUM raw_checksum_value]
      [FILESIZE byte_size]
      [ASSOC_FILE assoc_gkey ASSOC_VERSION assoc_nr]
      [RAW_CREATE create_time] [RAW_MODIFY modify_time]
      LOCATION store_code MIME mime_type] |
     [FETCH file_key [VERSION version_nr] [LOCATION file_server]
      [LOCKFILE] ] |
     [UPDATE file_key [LOCATION store_code]] |
     [UNLOCK file_key] |
     [LIST directory [RECURSIVE] [COLUMNS column_name[,...]]
      [ARCHIVE archive_dt] ] |
     [CHECK [CLEAN]]
  

Usage

  /* Will return details of index.html */
  FILE INFO PATH /docs/index.html

  /* Will transfer the file without locking it */
  FILE READ /docs/index.html

  /* will LOCK the file and then transfer the file */
  FILE CHECKOUT /docs/index.html

  /* Will check the file lock and if OK open the file for upload */
  FILE CHECKIN /docs/index.html

  /*
   * Can be called as a series of requests and will be appended to
   * the current file opened by the CHECKIN command.
   */
  FILE UPLOAD encoded page of file

  /* completes the CHECKIN process */
  FILE CLOSE

  /* will create a DBFile and return key and locations to upload to */
  FILE CREATE /docs/index.html

  /* will update the DBFile record with the location sent to */
  FILE SUBMIT file_key LOCATION store_code MIME application/octet-stream

  /* will return list of locations to retrieve a file from */
  FILE FETCH file_key

  /* return list of locations to get file from and try to obtain a lock */
  FILE FETCH file_key LOCKFILE

  /* will return list of urls to submit to */
  FILE UPDATE file_key

  /* will return a list of files in the directory */
  FILE LIST /docs/web
  FILE LIST /docs/web ARCHIVE '01 Jan 2006 10:45:00'

  /* will return a list of bad files in the directory */
  FILE CHECK

  /* will delete the list of bad fies in the directory */
  FILE CHECK CLEAN
  

THREAD MODE: SINGLE THREADED command

Since:

3 December 2003

Author:

Nigel Leck

Field Summary

Fields

Modifier and Type	Field and Description
protected DBFile	resultDBFile Current file for CREATE and UPDATE

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

CURSOR_SIZE

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
protected java.lang.String	adjustMimeType(java.lang.String mime)
void	appendResult(org.w3c.dom.Element group, int seq) appends results to a group in the xml result.
protected void	execute(Parser p) execute the command.
protected java.lang.String	generateNewFilePath(DataSource ds, Parser p) Determines the path of the new file
protected DBClass	getBaseClass(DataSource ds) Specifies the DBClass to be created by the CREATE option
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	getCursorName() overrides getCursorName of super class SQLCommand.
protected java.lang.String[]	getDefaultInfoColumns(DataSource ds) Retrieves default list of columns for the info command
protected java.lang.String[]	getDefaultListColumns(DataSource ds) Retrieves default list of columns for the info command
static java.util.LinkedHashSet	getFilestores(MutableDataSource mds, java.lang.String storeCode) return a list of file stores with its alternate in sequence.
java.lang.String	getRecordID(int row) Implements getRecordID of interface CommandBuildResultsPlugin.
protected java.lang.String	getType() get the type of the command during file command run
java.lang.Object	getValue(int row, int col) Implements getValue method of interface CommandBuildResultsPlugin.
protected void	loadInfoColumns(DBClass cls, java.lang.String[] columns) load info columns
protected void	setType(java.lang.String type) set the Type of the file command.

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

appendResult, 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

Field Detail

resultDBFile

protected DBFile resultDBFile

Current file for CREATE and UPDATE

Constructor Detail

FileCommand

public FileCommand(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. note: the parser will take care of validating the syntax and checking that it is well formed.

Specified by:

execute in class Command

Parameters:

p - The parser

Throws:

java.lang.Exception - A serious problem

adjustMimeType

protected java.lang.String adjustMimeType(java.lang.String mime)

appendResult

public void appendResult(org.w3c.dom.Element group,
                         int seq)
                  throws java.lang.Exception

appends results to a group in the xml result.

Overrides:

appendResult in class SQLCommand

Parameters:

group - the group to append to

seq - the sequence of the append

Throws:

java.lang.Exception - a serious error

getCursorName

public java.lang.String getCursorName()
                               throws java.lang.Exception

overrides getCursorName of super class SQLCommand. if we are returning multiple results, the cursor name is the name for the result set, as determined by the resultSet variable. else just call super.getCursorName

Specified by:

getCursorName in interface CommandBuildResultsPlugin

Overrides:

getCursorName in class SQLCommand

Returns:

String the cursor name

Throws:

java.lang.Exception - a serious problem

generateNewFilePath

protected java.lang.String generateNewFilePath(DataSource ds,
                                               Parser p)
                                        throws java.lang.Exception

Determines the path of the new file

Parameters:

ds - Datasource

p - Parser

Returns:

The path of the new file

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

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

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

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

getDefaultInfoColumns

protected java.lang.String[] getDefaultInfoColumns(DataSource ds)

Retrieves default list of columns for the info command

Parameters:

ds - Current datasource

Returns:

Default list of columns for the info command

getDefaultListColumns

protected java.lang.String[] getDefaultListColumns(DataSource ds)

Retrieves default list of columns for the info command

Parameters:

ds - Current datasource

Returns:

Default list of columns for the list command

getBaseClass

protected DBClass getBaseClass(DataSource ds)
                        throws NotFoundException

Specifies the DBClass to be created by the CREATE option

Parameters:

ds - Current datasource

Returns:

DBClass to be created

Throws:

NotFoundException - A class could not be found in the system that is to be used

loadInfoColumns

protected void loadInfoColumns(DBClass cls,
                               java.lang.String[] columns)
                        throws java.lang.Exception

load info columns

Parameters:

cls - the class

columns - the columns

Throws:

java.lang.Exception - a serious problem.

getFilestores

public static java.util.LinkedHashSet getFilestores(MutableDataSource mds,
                                                    java.lang.String storeCode)
                                             throws java.lang.Exception

return a list of file stores with its alternate in sequence.

Parameters:

mds - mutable data source

storeCode - DBFileStore code

Returns:

a list of DBFileStores

Throws:

java.lang.Exception - a serious error

getType

protected java.lang.String getType()

get the type of the command during file command run

Returns:

Returns the type.

setType

protected void setType(java.lang.String type)

set the Type of the file command. Primarily used if you want to extend the file command and add additional commands

Parameters:

type - The type to set.