/*
 * Created on Jul 31, 2006
 * 
 * (C) Copyright TANDBERG Television Ltd.
 */

package com.tandbergtv.workflow.webservice.filesubsystem.messagehandler;

/**
 * Class that contains the list of constants defining the Workflow Message parameter names for both
 * the input and output parameters..
 * 
 * @author Vijay Silva
 */
public final class MessageParameters
{
	// Cannot instantiate
	private MessageParameters()
	{
		super();
	}

	/**
	 * Input parameter used for the copy, move and rename file operations. Has the Source File path
	 * for the operation.
	 */
	public static final String SOURCE_PATH = "SourcePath";

	/**
	 * Input parameter used for tarring the files. Has either the comma-separated list of the files,
	 * or the source Folder path for the operation.
	 */
	public static final String SOURCE_FILES = "SourceFiles";

	/**
	 * Input parameter used for the copy and move file operations. Has the Destination File Path for
	 * the operation.
	 */
	public static final String DESTINATION_PATH = "DestinationPath";

	/**
	 * Input parameter used for the rename file operation. Has the 'renamed' file name used for the
	 * operation.
	 */
	public static final String DESTINATION_FILENAME = "DestinationName";

	/**
	 * Input parameter used for the remove, file size and file listing operations. Has the file path
	 * to the file required for the operation.
	 */
	public static final String PATH = "Path";

	/**
	 * Input parameter that contains the SAN Drive Id when fetching a Drive by Id.
	 */
	public static final String DRIVE_ID = "DriveId";

	/**
	 * Output parameter used in case there is an error performing the operation.
	 */
	public static final String ERROR_MESSAGE = "error-message";

	/**
	 * Output parameter used in case there is an error performing the operation.
	 */
	public static final String ERROR_STACK = "error-stack";

	/**
	 * Output parameter used to write the File Size.
	 */
	public static final String FILE_SIZE = "FileSize";

	/**
	 * Output parameter used to represent the result of the Folder Size operation.
	 */
	public static final String FOLDER_SIZE = "FolderSize";

	/**
	 * Output parameter used to represent the result of operations that return objects.
	 */
	public static final String RESULT = "Result";
	
	/**
	 * Key of the message parameter that contains the free space of a drive
	 */
	public static final String DRIVE_FREE_SPACE = "FreeSpace";
	
	public static final String HOST = "Host";
	
	public static final String USERNAME = "Username";
	
	public static final String PASSWORD = "Password";
	
	public static final String CHECKSUM = "checksum";
	
	public static final String DESTINATION_DIRECTORY = "DestinationDirectory";
}