edu.sdsc.inca.protocol
Class Protocol

java.lang.Object
  extended by edu.sdsc.inca.protocol.Protocol

public class Protocol
extends java.lang.Object

This class declares constants and contains documentation pertaining to the Inca message protocol. At the basic level, an Inca Statement consists of a command word (by convention all uppercase) optionally followed by a space and payload data. The format of the payload is defined by the command. Statements end with a CRLF combination. Replies from Inca servers typically have one of two formats. If the command succeeds, the server responds with a statement that has "OK" as the command word and any requested data as the payload. If an error occurs, the server responds with a statement that has "ERROR" as the command word and an explanatory message as the payload.


Field Summary
static java.lang.String CATALOG_GET_COMMAND
          Command: GETCATALOG [SP url] CRLF Response: OK SP reporters CRLF.
static java.lang.String CHECK_PERIOD_MACRO
           
static java.lang.String CHECK_PERIOD_MACRO_DEFAULT
           
static java.lang.String COMPUTE_METHOD_MACRO
           
static java.lang.String COMPUTE_METHOD_MACRO_DEFAULT
           
static java.lang.String[] COMPUTE_METHODS
           
static java.lang.String COMPUTE_PORT_MACRO
           
static java.lang.String COMPUTE_SERVER_MACRO
           
static java.lang.String CONFIG_GET_COMMAND
          Command: GETCONFIG CRLF Response: OK SP xml CRLF.
static java.lang.String CONFIG_SET_COMMAND
          Command: SETCONFIG xml CRLF Response: OK CRLF.
static java.lang.String EMAIL_MACRO
           
static java.lang.String END_QUERY_RESULTS_COMMAND
           
static java.lang.String EQUIVALENT_MACRO
           
static java.lang.String FAILURE_COMMAND
          Command: ERROR message CRLF Response: none.
static java.lang.String FILE_PORT_MACRO
           
static java.lang.String FILE_PORT_MACRO_DEFAULT
           
static java.lang.String FILE_SERVER_MACRO
           
static java.lang.String GASS_PORT_MACRO
           
static java.lang.String GET_LOG_COMMAND
          Command: GETLOG CRLF Response: OK SP text CRLF.
static java.lang.String GLOBUS_SERVER_PORT_MACRO_DEFAULT
           
static java.lang.String GRAM_DN_MACRO
           
static java.lang.String GRAM_SERVICE_MACRO
           
static java.lang.String GRAM_SERVICE_MACRO_DEFAULT
           
static java.lang.String GRIDFTP_DN_MACRO
           
static java.lang.String GROUPNAME_MACRO
           
static java.lang.String IMMEDIATE_SUITE_NAME
          Suite name for run immediately requests.
static java.lang.String INSERT_COMMAND
          Command: REPORT SP resource SP context CRLF [STDERR SP text CRLF] STDOUT SP xml CRLF SYSUSAGE SP usage CRLF Response: OK SP uri.
static java.lang.String INSERT_STDERR_COMMAND
           
static java.lang.String INSERT_STDOUT_COMMAND
           
static java.lang.String INSERT_SYSUSAGE_COMMAND
           
static java.lang.String LOG_CONFIG_COMMAND
          Command: LOGCONFIG SP property=level ,appender [,appender etc] Response: OK CRLF.
static java.lang.String LOGIN_ID_MACRO
           
static java.lang.String MACRO_NAME_PATTERN
          Constants for matching resource macro names, Agent predefined macro names, and some default values.
static java.lang.String MYPROXY_DN_MACRO
           
static java.lang.String MYPROXY_HOST_MACRO
           
static java.lang.String MYPROXY_LIFETIME_MACRO
           
static java.lang.String MYPROXY_PASSWORD_MACRO
           
static java.lang.String MYPROXY_PORT_MACRO
           
static java.lang.String MYPROXY_USERNAME_MACRO
           
static java.lang.String PACKAGE_COMMAND
          Command: PACKAGE SP uri CRLF FILENAME SP name CRLF VERSION SP version CRLF INSTALLPATH SP path CRLF [PERMISSION SP oct CRLF] CONTENT SP packageContent CRLF Response: OK CRLF Send a reporter module or tar.gz package to the reporter manager.
static java.lang.String PACKAGE_CONTENT_COMMAND
           
static java.lang.String PACKAGE_DEPENDENCIES_COMMAND
           
static java.lang.String PACKAGE_FILENAME_COMMAND
           
static java.lang.String PACKAGE_INSTALLPATH_COMMAND
           
static java.lang.String PACKAGE_PERMISSIONS_COMMAND
           
static java.lang.String PACKAGE_VERSION_COMMAND
           
static java.lang.String PATTERN_MACRO
           
static java.lang.String PING_COMMAND
          Command: PING SP text CRLF Response: OK SP text CRLF.
static java.lang.String PREDEFINED_MACRO_NAME_PATTERN
           
static java.lang.String PROXY_DN_COMMAND
           
static java.lang.String PROXY_HOSTNAME_COMMAND
           
static java.lang.String PROXY_LIFETIME_COMMAND
           
static java.lang.String PROXY_MACRO
           
static java.lang.String PROXY_PASSWORD_COMMAND
           
static java.lang.String PROXY_PORT_COMMAND
           
static java.lang.String PROXY_RENEW_INFO_GET_COMMAND
          Command: PROXY_RENEW_INFO hostname CRLF Response: HOSTNAME hostname CRLF [DN dn CRLF] PORT port CRLF PASSWORD password CRLF LIFETIME lifetime CRLF Response: OK CRLF
static java.lang.String PROXY_RENEW_MACRO
           
static java.lang.String PROXY_USERNAME_COMMAND
           
static java.lang.String QUERY_DB_COMMAND
          Command: QUERYDB Response: OK xml.
static java.lang.String QUERY_GUIDS_COMMAND
          Command: QUERYGUIDS CRLF Response: OK guids.
static java.lang.String QUERY_HQL_COMMAND
          Command: QUERYHQL SP hql CRLF Response: [QUERYRESULT SP xml CRLF etc] QUERYEND CRLF.
static java.lang.String QUERY_INSTANCE_COMMAND
          Command: QUERYINSTANCE SP instance SP config CRLF Response: QUERYRESULT SP xml CRLF QUERYEND CRLF.
static java.lang.String QUERY_LATEST_COMMAND
          Command: QUERYLATEST SP expr CRLF Response: QUERYRESULT SP xml CRLF QUERYEND CRLF.
static java.lang.String QUERY_RESULT
          Command: QUERYRESULT SP xml CRLF Reponse: none.
static java.lang.String QUERY_SQL_COMMAND
          Command: QUERYSQL SP sql CRLF Response: [QUERYRESULT SP xml CRLF etc] QUERYEND CRLF.
static java.lang.String QUERY_STATUS_COMMAND
          Command: QUERYSTATUS SP period SP begin SP end SP expr CRLF Response: QUERYRESULT SP xml CRLF QUERYEND CRLF.
static java.lang.String REGISTER_COMMAND
          Command: REGISTER SP hostname CRLF Response: OK CRLF.
static java.lang.String SERIES_CONFIG_ADD
          Actions for SeriesConfigs in SUITE_UPDATE_COMMAND.
static java.lang.String SERIES_CONFIG_DELETE
           
static java.lang.String SSH_IDENTITY_MACRO
           
static java.lang.String SSH_PASSWORD_MACRO
           
static java.lang.String START_COMMAND
          Command: START version Response: OK version Tests whether client and server are using the same protocol version.
static java.lang.String SUCCESS_COMMAND
          Command: OK [SP data] CRLF Response: none.
static java.lang.String SUITE_UPDATE_COMMAND
          Command: SUITE SP xml CRLF Response: OK SP version CRLF.
static java.lang.String WORKING_DIR_MACRO
           
static java.lang.String WORKING_DIR_MACRO_DEFAULT
           
 
Constructor Summary
Protocol()
           
 
Method Summary
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

FAILURE_COMMAND

public static final java.lang.String FAILURE_COMMAND
Command: ERROR message CRLF Response: none. Response on any server error, with a descriptive message.

See Also:
Constant Field Values

SUCCESS_COMMAND

public static final java.lang.String SUCCESS_COMMAND
Command: OK [SP data] CRLF Response: none. Response on server success. The presence and format of the data depends on the command.

See Also:
Constant Field Values

QUERY_RESULT

public static final java.lang.String QUERY_RESULT
Command: QUERYRESULT SP xml CRLF Reponse: none.

See Also:
Constant Field Values

GET_LOG_COMMAND

public static final java.lang.String GET_LOG_COMMAND
Command: GETLOG CRLF Response: OK SP text CRLF. For testing; returns the current contents of the component log file.

See Also:
Constant Field Values

LOG_CONFIG_COMMAND

public static final java.lang.String LOG_CONFIG_COMMAND
Command: LOGCONFIG SP property=level ,appender [,appender etc] Response: OK CRLF. For testing; changes the log4j settings.

See Also:
Constant Field Values

PING_COMMAND

public static final java.lang.String PING_COMMAND
Command: PING SP text CRLF Response: OK SP text CRLF. For testing; echos whatever data is sent in the command.

See Also:
Constant Field Values

START_COMMAND

public static final java.lang.String START_COMMAND
Command: START version Response: OK version Tests whether client and server are using the same protocol version.

See Also:
Constant Field Values

CATALOG_GET_COMMAND

public static final java.lang.String CATALOG_GET_COMMAND
Command: GETCATALOG [SP url] CRLF Response: OK SP reporters CRLF. Returns the catalog from a specific repository (if url is supplied) or a merged catalog from all repositories known to the agent. reporters is a blank-line separated set of reporters, each of which is a newline-separated set of attribute:value pairs that describe an individual reporter.

See Also:
Constant Field Values

CONFIG_GET_COMMAND

public static final java.lang.String CONFIG_GET_COMMAND
Command: GETCONFIG CRLF Response: OK SP xml CRLF. See the IncaDocument schema for the xml format.

See Also:
Constant Field Values

PROXY_RENEW_INFO_GET_COMMAND

public static final java.lang.String PROXY_RENEW_INFO_GET_COMMAND
Command: PROXY_RENEW_INFO hostname CRLF Response: HOSTNAME hostname CRLF [DN dn CRLF] PORT port CRLF PASSWORD password CRLF LIFETIME lifetime CRLF Response: OK CRLF

See Also:
Constant Field Values

CONFIG_SET_COMMAND

public static final java.lang.String CONFIG_SET_COMMAND
Command: SETCONFIG xml CRLF Response: OK CRLF. See the IncaDocument schema for the xml format.

See Also:
Constant Field Values

REGISTER_COMMAND

public static final java.lang.String REGISTER_COMMAND
Command: REGISTER SP hostname CRLF Response: OK CRLF. Registers a reporter manager with the agent. The payload is the fully-qualified DNS name of the host where the manager is running.

See Also:
Constant Field Values

IMMEDIATE_SUITE_NAME

public static final java.lang.String IMMEDIATE_SUITE_NAME
Suite name for run immediately requests.

See Also:
Constant Field Values

MACRO_NAME_PATTERN

public static final java.lang.String MACRO_NAME_PATTERN
Constants for matching resource macro names, Agent predefined macro names, and some default values.

See Also:
Constant Field Values

PREDEFINED_MACRO_NAME_PATTERN

public static final java.lang.String PREDEFINED_MACRO_NAME_PATTERN
See Also:
Constant Field Values

CHECK_PERIOD_MACRO

public static final java.lang.String CHECK_PERIOD_MACRO
See Also:
Constant Field Values

COMPUTE_METHOD_MACRO

public static final java.lang.String COMPUTE_METHOD_MACRO
See Also:
Constant Field Values

COMPUTE_PORT_MACRO

public static final java.lang.String COMPUTE_PORT_MACRO
See Also:
Constant Field Values

COMPUTE_SERVER_MACRO

public static final java.lang.String COMPUTE_SERVER_MACRO
See Also:
Constant Field Values

EMAIL_MACRO

public static final java.lang.String EMAIL_MACRO
See Also:
Constant Field Values

FILE_PORT_MACRO

public static final java.lang.String FILE_PORT_MACRO
See Also:
Constant Field Values

FILE_SERVER_MACRO

public static final java.lang.String FILE_SERVER_MACRO
See Also:
Constant Field Values

GRAM_DN_MACRO

public static final java.lang.String GRAM_DN_MACRO
See Also:
Constant Field Values

GRAM_SERVICE_MACRO

public static final java.lang.String GRAM_SERVICE_MACRO
See Also:
Constant Field Values

GRIDFTP_DN_MACRO

public static final java.lang.String GRIDFTP_DN_MACRO
See Also:
Constant Field Values

GROUPNAME_MACRO

public static final java.lang.String GROUPNAME_MACRO
See Also:
Constant Field Values

GASS_PORT_MACRO

public static final java.lang.String GASS_PORT_MACRO
See Also:
Constant Field Values

LOGIN_ID_MACRO

public static final java.lang.String LOGIN_ID_MACRO
See Also:
Constant Field Values

MYPROXY_DN_MACRO

public static final java.lang.String MYPROXY_DN_MACRO
See Also:
Constant Field Values

MYPROXY_HOST_MACRO

public static final java.lang.String MYPROXY_HOST_MACRO
See Also:
Constant Field Values

MYPROXY_PORT_MACRO

public static final java.lang.String MYPROXY_PORT_MACRO
See Also:
Constant Field Values

MYPROXY_LIFETIME_MACRO

public static final java.lang.String MYPROXY_LIFETIME_MACRO
See Also:
Constant Field Values

MYPROXY_PASSWORD_MACRO

public static final java.lang.String MYPROXY_PASSWORD_MACRO
See Also:
Constant Field Values

MYPROXY_USERNAME_MACRO

public static final java.lang.String MYPROXY_USERNAME_MACRO
See Also:
Constant Field Values

PATTERN_MACRO

public static final java.lang.String PATTERN_MACRO
See Also:
Constant Field Values

PROXY_RENEW_MACRO

public static final java.lang.String PROXY_RENEW_MACRO
See Also:
Constant Field Values

PROXY_MACRO

public static final java.lang.String PROXY_MACRO
See Also:
Constant Field Values

EQUIVALENT_MACRO

public static final java.lang.String EQUIVALENT_MACRO
See Also:
Constant Field Values

SSH_IDENTITY_MACRO

public static final java.lang.String SSH_IDENTITY_MACRO
See Also:
Constant Field Values

SSH_PASSWORD_MACRO

public static final java.lang.String SSH_PASSWORD_MACRO
See Also:
Constant Field Values

WORKING_DIR_MACRO

public static final java.lang.String WORKING_DIR_MACRO
See Also:
Constant Field Values

CHECK_PERIOD_MACRO_DEFAULT

public static final java.lang.String CHECK_PERIOD_MACRO_DEFAULT
See Also:
Constant Field Values

COMPUTE_METHODS

public static final java.lang.String[] COMPUTE_METHODS

COMPUTE_METHOD_MACRO_DEFAULT

public static final java.lang.String COMPUTE_METHOD_MACRO_DEFAULT
See Also:
Constant Field Values

GLOBUS_SERVER_PORT_MACRO_DEFAULT

public static final java.lang.String GLOBUS_SERVER_PORT_MACRO_DEFAULT
See Also:
Constant Field Values

GRAM_SERVICE_MACRO_DEFAULT

public static final java.lang.String GRAM_SERVICE_MACRO_DEFAULT
See Also:
Constant Field Values

FILE_PORT_MACRO_DEFAULT

public static final java.lang.String FILE_PORT_MACRO_DEFAULT
See Also:
Constant Field Values

WORKING_DIR_MACRO_DEFAULT

public static final java.lang.String WORKING_DIR_MACRO_DEFAULT
See Also:
Constant Field Values

PACKAGE_COMMAND

public static final java.lang.String PACKAGE_COMMAND
Command: PACKAGE SP uri CRLF FILENAME SP name CRLF VERSION SP version CRLF INSTALLPATH SP path CRLF [PERMISSION SP oct CRLF] CONTENT SP packageContent CRLF Response: OK CRLF Send a reporter module or tar.gz package to the reporter manager.

See Also:
Constant Field Values

INSERT_COMMAND

public static final java.lang.String INSERT_COMMAND
Command: REPORT SP resource SP context CRLF [STDERR SP text CRLF] STDOUT SP xml CRLF SYSUSAGE SP usage CRLF Response: OK SP uri. A multi-part command that instructs the depot to insert a new report into the database. The resource and context designates the series, and the two texts are saved in the database without interpretation. See the Report schema for the xml format. usage is a newline-separated set of attribute=value pairs; the recognized attributes, in order, are cpu_secs, wall_secs, and memory_mb.

See Also:
Constant Field Values

QUERY_DB_COMMAND

public static final java.lang.String QUERY_DB_COMMAND
Command: QUERYDB Response: OK xml. Requests information about the structure of the Depot database.

See Also:
Constant Field Values

QUERY_GUIDS_COMMAND

public static final java.lang.String QUERY_GUIDS_COMMAND
Command: QUERYGUIDS CRLF Response: OK guids. Requests a database lookup for the set of suite guids in the DB. Returns a newline-delimited list of guids.

See Also:
Constant Field Values

QUERY_HQL_COMMAND

public static final java.lang.String QUERY_HQL_COMMAND
Command: QUERYHQL SP hql CRLF Response: [QUERYRESULT SP xml CRLF etc] QUERYEND CRLF. Requests a database lookup using the enclosed HQL SELECT statement. The format of any returned XML will depend on the tables queried. This command exists primarily as a Depot debugging aid, since its use depends on knowledge of the internal Depot DB schema.

See Also:
Constant Field Values

QUERY_INSTANCE_COMMAND

public static final java.lang.String QUERY_INSTANCE_COMMAND
Command: QUERYINSTANCE SP instance SP config CRLF Response: QUERYRESULT SP xml CRLF QUERYEND CRLF. Requests a database lookup of a specified (numeric) instance id for a specified (numeric) series config id. See the ReportDetails schema for the xml format.

See Also:
Constant Field Values

QUERY_LATEST_COMMAND

public static final java.lang.String QUERY_LATEST_COMMAND
Command: QUERYLATEST SP expr CRLF Response: QUERYRESULT SP xml CRLF QUERYEND CRLF. Requests a database lookup of the latest instances for a set of series specified by an HQL WHERE clause expression. See the ReportSummary schema for the xml format.

See Also:
Constant Field Values

QUERY_SQL_COMMAND

public static final java.lang.String QUERY_SQL_COMMAND
Command: QUERYSQL SP sql CRLF Response: [QUERYRESULT SP xml CRLF etc] QUERYEND CRLF. Requests a database lookup using the enclosed SQL SELECT statement. The format of any returned XML will depend on the tables queried. This command exists primarily as a Depot debugging aid, since its use depends on knowledge of the internal Depot DB schema.

See Also:
Constant Field Values

QUERY_STATUS_COMMAND

public static final java.lang.String QUERY_STATUS_COMMAND
Command: QUERYSTATUS SP period SP begin SP end SP expr CRLF Response: QUERYRESULT SP xml CRLF QUERYEND CRLF. Requests a database lookup of the success/failure history for a set of series specified by an HQL WHERE clause expression. The period is either a number of minutes to use for grouping in the response or one of the words "DAY", "WEEK", "MONTH", or "QUARTER". The begin and end values limit the returned information to instances collected in between the specified timestamp values. See the StatusHistory schema for the xml format.

See Also:
Constant Field Values

SUITE_UPDATE_COMMAND

public static final java.lang.String SUITE_UPDATE_COMMAND
Command: SUITE SP xml CRLF Response: OK SP version CRLF. Applies the specified series config add/delete actions. See the Suite schema for the xml format.

See Also:
Constant Field Values

SERIES_CONFIG_ADD

public static final java.lang.String SERIES_CONFIG_ADD
Actions for SeriesConfigs in SUITE_UPDATE_COMMAND.

See Also:
Constant Field Values

SERIES_CONFIG_DELETE

public static final java.lang.String SERIES_CONFIG_DELETE
See Also:
Constant Field Values

INSERT_STDERR_COMMAND

public static final java.lang.String INSERT_STDERR_COMMAND
See Also:
Constant Field Values

INSERT_STDOUT_COMMAND

public static final java.lang.String INSERT_STDOUT_COMMAND
See Also:
Constant Field Values

INSERT_SYSUSAGE_COMMAND

public static final java.lang.String INSERT_SYSUSAGE_COMMAND
See Also:
Constant Field Values

PACKAGE_FILENAME_COMMAND

public static final java.lang.String PACKAGE_FILENAME_COMMAND
See Also:
Constant Field Values

PACKAGE_VERSION_COMMAND

public static final java.lang.String PACKAGE_VERSION_COMMAND
See Also:
Constant Field Values

PACKAGE_INSTALLPATH_COMMAND

public static final java.lang.String PACKAGE_INSTALLPATH_COMMAND
See Also:
Constant Field Values

PACKAGE_PERMISSIONS_COMMAND

public static final java.lang.String PACKAGE_PERMISSIONS_COMMAND
See Also:
Constant Field Values

PACKAGE_DEPENDENCIES_COMMAND

public static final java.lang.String PACKAGE_DEPENDENCIES_COMMAND
See Also:
Constant Field Values

PACKAGE_CONTENT_COMMAND

public static final java.lang.String PACKAGE_CONTENT_COMMAND
See Also:
Constant Field Values

PROXY_DN_COMMAND

public static final java.lang.String PROXY_DN_COMMAND
See Also:
Constant Field Values

PROXY_HOSTNAME_COMMAND

public static final java.lang.String PROXY_HOSTNAME_COMMAND
See Also:
Constant Field Values

PROXY_LIFETIME_COMMAND

public static final java.lang.String PROXY_LIFETIME_COMMAND
See Also:
Constant Field Values

PROXY_PASSWORD_COMMAND

public static final java.lang.String PROXY_PASSWORD_COMMAND
See Also:
Constant Field Values

PROXY_PORT_COMMAND

public static final java.lang.String PROXY_PORT_COMMAND
See Also:
Constant Field Values

PROXY_USERNAME_COMMAND

public static final java.lang.String PROXY_USERNAME_COMMAND
See Also:
Constant Field Values

END_QUERY_RESULTS_COMMAND

public static final java.lang.String END_QUERY_RESULTS_COMMAND
See Also:
Constant Field Values
Constructor Detail

Protocol

public Protocol()