org.bioquery.bqutils
Class BQProtocol

java.lang.Object
  |
  +--org.bioquery.bqutils.BQProtocol

public final class BQProtocol

extends java.lang.Object

This class defines the constants used by the bioquery application.

Author:

James Brundege

Field Summary

static java.lang.String	BEGIN_QUERYLINE_DATA Added to the server response to the client during a Query submission to indicate that the following lines contain a series of numbers, one per line, that indicate the result count for each QueryLine of the Query.
static java.lang.String	BEGIN_QUERYLINE_RESULTS Added to the server response to the client during a Query submission to indicate the end of the QueryLine Data, and the beginning of the resultset returned by the submission of the Query's submitLine to it's database.
static java.lang.String	BEGIN_RESULT_TEXT This String marks the end of the Header returned with Query Results.
static java.lang.String	COPY_FILE A request by the client for the the server to copy one of the user's files, sent to the BQFileManagerServlet in the URL as the second half of the querystring.
static java.lang.String	CREATE_DIRECTORY A request by the client for the server to create a new subdirectory within the user's directory, sent to the BQFileManagerServlet in the URL as the second half of the querystring.
static java.lang.String	CREATE_NEW_ACCOUNT A request by the client for the server create a new user account.
static java.lang.String	DELETE_FILE A request by the client for the the server to delete one of the user's files, sent to the BQFileManagerServlet in the URL as the second half of the querystring.
static java.lang.String	DELIMITER The delimiter character, provided as a String, to aid parsing information coming from the server.
static java.lang.String	ERROR_MESSAGE_HEADER Sent by the server to the client to indicate a server error while processing a request.
static java.lang.String	FAILURE Added to the server response to the client during a Query submission to indicate that the requested operation failed.
static java.lang.String	FILE_METHOD This represents the first half of the querystring sent to the BQFileManagerServlet in the URL, indicating that the second half of this querystring will designate which file operation the client is requesting.
static java.lang.String	FILE_PATH This represents the first half of the querystring sent to the BQFileManagerServlet in the URL, indicating that the second half of this querystring contains the pathname of a file.
static java.lang.String	GET_QUERY_DATA This is the 2nd half of the querystring indicating that the QuerySubmitter method to call is getQueryData to only retrieve counts, not the full results.
static java.lang.String	GET_QUERY_RESULTS This is the 2nd half of the querystring indicating that the QuerySubmitter method to call is getQueryResults to retrieve the full results of the Query.
static java.lang.String	INVALID_QUERY_OBJECT Sent by the server to the client to indicate the server was not able to read the Query object sent by the client.
static java.lang.String	LOGIN A request by the client for the Login procedure, sent to the BQFileManagerServlet in the URL as the second half of the querystring.
static java.lang.String	LOGOUT A request by the client for the server to log out this session.
static java.lang.String	MOVE_FILE A request by the client for the the server to move one of the user's files, sent to the BQFileManagerServlet in the URL as the second half of the querystring.
static java.lang.String	NEW_FILE This represents the first half of the querystring sent to the BQFileManagerServlet in the URL, indicating that the second half of this querystring contains a new path to move or copy a file to.
static java.lang.String	OPEN_FILE A request by the client for the server to send back one of the user's saved files, sent to the BQFileManagerServlet in the URL as the second half of the querystring.
static java.lang.String	QUERY_ERROR Added to the server response to the client during a Query submission to indicate an error occured by submitting the Query.
static java.lang.String	QUERY_METHOD This represents the first half of the querystring sent to the SubmitQueryServlet in the URL, indicating that the second half of this querystring will designate which query operation the client is requesting.
static java.lang.String	QUERY_RETURNED_NULL Sent by the server to the client to indicate that the Query was submitted, but no there were no items in the resultset.
static java.lang.String	QUERYPROTOCOL_ERROR Sent by the server to the client to indicate that the server did not understand the protocol request made by the client.
static java.lang.String	RENAME_FILE A request by the client for the the server to rename one of the user's files, sent to the BQFileManagerServlet in the URL as the second half of the querystring.
static java.lang.String	SAVE_FILE A request by the client for the server to save a file to the user's directory space on the bioquery server, sent to the BQFileManagerServlet in the URL as the second half of the querystring.
static java.lang.String	SEND_FEEDBACK A request by the client for the the server to receive a message and email back to bioquery support, sent to the BQFileManagerServlet in the URL as the second half of the querystring.
static java.lang.String	SUCCESS Added to the server response to the client during a Query submission to indicate that the requested operation succeeded.
static java.lang.String	UPDATE_FILE_LIST A request by the client for the RetrieveFileList procedure which returns a serialized object containing the user's Querys and file information for the client FileUtilites, sent to the BQFileManagerServlet in the URL as the second half of the querystring.
static java.lang.String	USER This parameter is used by the server as the key to store the BQUser object in the session object.

Constructor Summary

BQProtocol()

Methods inherited from class java.lang.Object

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

Field Detail

ERROR_MESSAGE_HEADER

public static java.lang.String ERROR_MESSAGE_HEADER

Sent by the server to the client to indicate a server error while processing a request.

INVALID_QUERY_OBJECT

public static java.lang.String INVALID_QUERY_OBJECT

Sent by the server to the client to indicate the server was not able to read the Query object sent by the client.

QUERY_RETURNED_NULL

public static java.lang.String QUERY_RETURNED_NULL

Sent by the server to the client to indicate that the Query was submitted, but no there were no items in the resultset.

QUERYPROTOCOL_ERROR

public static java.lang.String QUERYPROTOCOL_ERROR

Sent by the server to the client to indicate that the server did not understand the protocol request made by the client.

BEGIN_QUERYLINE_DATA

public static final java.lang.String BEGIN_QUERYLINE_DATA

Added to the server response to the client during a Query submission to indicate that the following lines contain a series of numbers, one per line, that indicate the result count for each QueryLine of the Query. The series of QueryLine data numbers are terminated by either the end of the file, or the BEGIN_QUERYLINE_RESULTS or QUERY_ERROR protocols.

BEGIN_QUERYLINE_RESULTS

public static final java.lang.String BEGIN_QUERYLINE_RESULTS

Added to the server response to the client during a Query submission to indicate the end of the QueryLine Data, and the beginning of the resultset returned by the submission of the Query's submitLine to it's database.

BEGIN_RESULT_TEXT

public static final java.lang.String BEGIN_RESULT_TEXT

This String marks the end of the Header returned with Query Results. It is different from BEGIN_QUERYLINE_RESULTS because it can be seen by the end user, and may be used by 3rd party scripts to strip the header off Query Results.

QUERY_ERROR

public static final java.lang.String QUERY_ERROR

Added to the server response to the client during a Query submission to indicate an error occured by submitting the Query.

DELIMITER

public static final java.lang.String DELIMITER

The delimiter character, provided as a String, to aid parsing information coming from the server.

FILE_METHOD

public static final java.lang.String FILE_METHOD

This represents the first half of the querystring sent to the BQFileManagerServlet in the URL, indicating that the second half of this querystring will designate which file operation the client is requesting.

LOGIN

public static final java.lang.String LOGIN

A request by the client for the Login procedure, sent to the BQFileManagerServlet in the URL as the second half of the querystring.

LOGOUT

public static final java.lang.String LOGOUT

A request by the client for the server to log out this session.

CREATE_NEW_ACCOUNT

public static final java.lang.String CREATE_NEW_ACCOUNT

A request by the client for the server create a new user account.

UPDATE_FILE_LIST

public static final java.lang.String UPDATE_FILE_LIST

A request by the client for the RetrieveFileList procedure which returns a serialized object containing the user's Querys and file information for the client FileUtilites, sent to the BQFileManagerServlet in the URL as the second half of the querystring.

OPEN_FILE

public static final java.lang.String OPEN_FILE

A request by the client for the server to send back one of the user's saved files, sent to the BQFileManagerServlet in the URL as the second half of the querystring.

CREATE_DIRECTORY

public static final java.lang.String CREATE_DIRECTORY

A request by the client for the server to create a new subdirectory within the user's directory, sent to the BQFileManagerServlet in the URL as the second half of the querystring.

SAVE_FILE

public static final java.lang.String SAVE_FILE

A request by the client for the server to save a file to the user's directory space on the bioquery server, sent to the BQFileManagerServlet in the URL as the second half of the querystring.

DELETE_FILE

public static final java.lang.String DELETE_FILE

A request by the client for the the server to delete one of the user's files, sent to the BQFileManagerServlet in the URL as the second half of the querystring.

MOVE_FILE

public static final java.lang.String MOVE_FILE

A request by the client for the the server to move one of the user's files, sent to the BQFileManagerServlet in the URL as the second half of the querystring.

COPY_FILE

public static final java.lang.String COPY_FILE

A request by the client for the the server to copy one of the user's files, sent to the BQFileManagerServlet in the URL as the second half of the querystring.

RENAME_FILE

public static final java.lang.String RENAME_FILE

A request by the client for the the server to rename one of the user's files, sent to the BQFileManagerServlet in the URL as the second half of the querystring.

SEND_FEEDBACK

public static final java.lang.String SEND_FEEDBACK

A request by the client for the the server to receive a message and email back to bioquery support, sent to the BQFileManagerServlet in the URL as the second half of the querystring.

FILE_PATH

public static final java.lang.String FILE_PATH

This represents the first half of the querystring sent to the BQFileManagerServlet in the URL, indicating that the second half of this querystring contains the pathname of a file.

NEW_FILE

public static final java.lang.String NEW_FILE

This represents the first half of the querystring sent to the BQFileManagerServlet in the URL, indicating that the second half of this querystring contains a new path to move or copy a file to.

USER

public static final java.lang.String USER

This parameter is used by the server as the key to store the BQUser object in the session object.

SUCCESS

public static final java.lang.String SUCCESS

Added to the server response to the client during a Query submission to indicate that the requested operation succeeded. This basically functions as a boolean return type over HTTP calls.

FAILURE

public static final java.lang.String FAILURE

Added to the server response to the client during a Query submission to indicate that the requested operation failed. This basically functions as a boolean return type over HTTP calls.

QUERY_METHOD

public static final java.lang.String QUERY_METHOD

This represents the first half of the querystring sent to the SubmitQueryServlet in the URL, indicating that the second half of this querystring will designate which query operation the client is requesting.

GET_QUERY_DATA

public static final java.lang.String GET_QUERY_DATA

This is the 2nd half of the querystring indicating that the QuerySubmitter method to call is getQueryData to only retrieve counts, not the full results.

GET_QUERY_RESULTS

public static final java.lang.String GET_QUERY_RESULTS

This is the 2nd half of the querystring indicating that the QuerySubmitter method to call is getQueryResults to retrieve the full results of the Query.

Constructor Detail

BQProtocol

public BQProtocol()