|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object edu.sdsc.inca.protocol.Protocol
public class Protocol
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 |
---|
public static final java.lang.String FAILURE_COMMAND
public static final java.lang.String SUCCESS_COMMAND
public static final java.lang.String QUERY_RESULT
public static final java.lang.String GET_LOG_COMMAND
public static final java.lang.String LOG_CONFIG_COMMAND
public static final java.lang.String PING_COMMAND
public static final java.lang.String START_COMMAND
public static final java.lang.String CATALOG_GET_COMMAND
public static final java.lang.String CONFIG_GET_COMMAND
public static final java.lang.String PROXY_RENEW_INFO_GET_COMMAND
public static final java.lang.String CONFIG_SET_COMMAND
public static final java.lang.String REGISTER_COMMAND
public static final java.lang.String IMMEDIATE_SUITE_NAME
public static final java.lang.String MACRO_NAME_PATTERN
public static final java.lang.String PREDEFINED_MACRO_NAME_PATTERN
public static final java.lang.String CHECK_PERIOD_MACRO
public static final java.lang.String COMPUTE_METHOD_MACRO
public static final java.lang.String COMPUTE_PORT_MACRO
public static final java.lang.String COMPUTE_SERVER_MACRO
public static final java.lang.String EMAIL_MACRO
public static final java.lang.String FILE_PORT_MACRO
public static final java.lang.String FILE_SERVER_MACRO
public static final java.lang.String GRAM_DN_MACRO
public static final java.lang.String GRAM_SERVICE_MACRO
public static final java.lang.String GRIDFTP_DN_MACRO
public static final java.lang.String GROUPNAME_MACRO
public static final java.lang.String GASS_PORT_MACRO
public static final java.lang.String LOGIN_ID_MACRO
public static final java.lang.String MYPROXY_DN_MACRO
public static final java.lang.String MYPROXY_HOST_MACRO
public static final java.lang.String MYPROXY_PORT_MACRO
public static final java.lang.String MYPROXY_LIFETIME_MACRO
public static final java.lang.String MYPROXY_PASSWORD_MACRO
public static final java.lang.String MYPROXY_USERNAME_MACRO
public static final java.lang.String PATTERN_MACRO
public static final java.lang.String PROXY_RENEW_MACRO
public static final java.lang.String PROXY_MACRO
public static final java.lang.String EQUIVALENT_MACRO
public static final java.lang.String SSH_IDENTITY_MACRO
public static final java.lang.String SSH_PASSWORD_MACRO
public static final java.lang.String WORKING_DIR_MACRO
public static final java.lang.String CHECK_PERIOD_MACRO_DEFAULT
public static final java.lang.String[] COMPUTE_METHODS
public static final java.lang.String COMPUTE_METHOD_MACRO_DEFAULT
public static final java.lang.String GLOBUS_SERVER_PORT_MACRO_DEFAULT
public static final java.lang.String GRAM_SERVICE_MACRO_DEFAULT
public static final java.lang.String FILE_PORT_MACRO_DEFAULT
public static final java.lang.String WORKING_DIR_MACRO_DEFAULT
public static final java.lang.String PACKAGE_COMMAND
public static final java.lang.String INSERT_COMMAND
public static final java.lang.String QUERY_DB_COMMAND
public static final java.lang.String QUERY_GUIDS_COMMAND
public static final java.lang.String QUERY_HQL_COMMAND
public static final java.lang.String QUERY_INSTANCE_COMMAND
public static final java.lang.String QUERY_LATEST_COMMAND
public static final java.lang.String QUERY_SQL_COMMAND
public static final java.lang.String QUERY_STATUS_COMMAND
public static final java.lang.String SUITE_UPDATE_COMMAND
public static final java.lang.String SERIES_CONFIG_ADD
public static final java.lang.String SERIES_CONFIG_DELETE
public static final java.lang.String INSERT_STDERR_COMMAND
public static final java.lang.String INSERT_STDOUT_COMMAND
public static final java.lang.String INSERT_SYSUSAGE_COMMAND
public static final java.lang.String PACKAGE_FILENAME_COMMAND
public static final java.lang.String PACKAGE_VERSION_COMMAND
public static final java.lang.String PACKAGE_INSTALLPATH_COMMAND
public static final java.lang.String PACKAGE_PERMISSIONS_COMMAND
public static final java.lang.String PACKAGE_DEPENDENCIES_COMMAND
public static final java.lang.String PACKAGE_CONTENT_COMMAND
public static final java.lang.String PROXY_DN_COMMAND
public static final java.lang.String PROXY_HOSTNAME_COMMAND
public static final java.lang.String PROXY_LIFETIME_COMMAND
public static final java.lang.String PROXY_PASSWORD_COMMAND
public static final java.lang.String PROXY_PORT_COMMAND
public static final java.lang.String PROXY_USERNAME_COMMAND
public static final java.lang.String END_QUERY_RESULTS_COMMAND
Constructor Detail |
---|
public Protocol()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |