001/**
002 * Licensed to the Apache Software Foundation (ASF) under one
003 * or more contributor license agreements.  See the NOTICE file
004 * distributed with this work for additional information
005 * regarding copyright ownership.  The ASF licenses this file
006 * to you under the Apache License, Version 2.0 (the
007 * "License"); you may not use this file except in compliance
008 * with the License.  You may obtain a copy of the License at
009 *
010 *      http://www.apache.org/licenses/LICENSE-2.0
011 *
012 * Unless required by applicable law or agreed to in writing, software
013 * distributed under the License is distributed on an "AS IS" BASIS,
014 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
015 * See the License for the specific language governing permissions and
016 * limitations under the License.
017 */
018
019package org.apache.oozie.client.rest;
020
021/**
022 * Constansts used by Oozie REST WS API
023 */
024public interface RestConstants {
025
026    String VERSIONS = "versions";
027
028    String JOB = "job";
029
030    String JOBS = "jobs";
031
032    String ADMIN = "admin";
033
034    String JSON_CONTENT_TYPE = "application/json";
035
036    String XML_CONTENT_TYPE = "application/xml";
037
038    String FORM_CONTENT_TYPE = "application/x-www-form-urlencoded";
039
040    String TEXT_CONTENT_TYPE = "text/plain";
041
042    String PNG_IMAGE_CONTENT_TYPE = "image/png";
043
044    String ACTION_PARAM = "action";
045
046    String OFFSET_PARAM = "offset";
047
048    String LEN_PARAM = "len";
049
050    String ORDER_PARAM = "order";
051
052    String JOB_FILTER_PARAM = "filter";
053
054    String JOB_RESOURCE = "/job";
055
056    String JOB_ACTION_START = "start";
057
058    String JOB_ACTION_DRYRUN = "dryrun";
059
060    String JOB_ACTION_SHOWDIFF = "diff";
061
062    String JOB_ACTION_SUSPEND = "suspend";
063
064    String JOB_ACTION_RESUME = "resume";
065
066    String JOB_ACTION_KILL = "kill";
067
068    String JOB_ACTION_CHANGE = "change";
069
070    String JOB_CHANGE_VALUE = "value";
071
072    String JOB_ACTION_RERUN = "rerun";
073
074    String JOB_ACTION_IGNORE = "ignore";
075
076    String JOB_COORD_ACTION_RERUN = "coord-rerun";
077
078    String JOB_COORD_UPDATE = "update";
079
080    String JOB_BUNDLE_ACTION_RERUN = "bundle-rerun";
081
082    String JOB_SHOW_PARAM = "show";
083
084    String JOB_SHOW_CONFIG = "config";
085
086    String JOB_SHOW_INFO = "info";
087
088    String JOB_SHOW_LOG = "log";
089
090    String JOB_SHOW_ERROR_LOG = "errorlog";
091
092    String JOB_SHOW_AUDIT_LOG = "auditlog";
093
094    String JOB_SHOW_DEFINITION = "definition";
095
096    String JOB_SHOW_GRAPH = "graph";
097
098    String JOB_SHOW_KILL_PARAM = "show-kill";
099
100    String JOB_SHOW_STATUS = "status";
101
102    String JOB_BUNDLE_RERUN_COORD_SCOPE_PARAM = "coord-scope";
103
104    String JOB_BUNDLE_RERUN_DATE_SCOPE_PARAM = "date-scope";
105
106    String JOB_COORD_RANGE_TYPE_PARAM = "type";
107
108    String JOB_COORD_SCOPE_DATE = "date";
109
110    String JOB_COORD_SCOPE_ACTION = "action";
111
112    String JOB_COORD_SCOPE_PARAM = "scope";
113
114    String JOB_COORD_RERUN_REFRESH_PARAM = "refresh";
115
116    String JOB_COORD_RERUN_NOCLEANUP_PARAM = "nocleanup";
117
118    String JOB_LOG_ACTION = "action";
119
120    String JOB_LOG_DATE = "date";
121
122    String JOB_LOG_SCOPE_PARAM = "scope";
123
124    String JOB_LOG_TYPE_PARAM = "type";
125
126    String JOBS_FILTER_PARAM = "filter";
127
128    String JOBS_BULK_PARAM = "bulk";
129
130    String JOBS_EXTERNAL_ID_PARAM = "external-id";
131
132    String ADMIN_STATUS_RESOURCE = "status";
133
134    String ADMIN_SAFE_MODE_PARAM = "safemode";
135
136    String ADMIN_SYSTEM_MODE_PARAM = "systemmode";
137
138    String ADMIN_LOG_RESOURCE = "log";
139
140    String ADMIN_OS_ENV_RESOURCE = "os-env";
141
142    String ADMIN_JAVA_SYS_PROPS_RESOURCE = "java-sys-properties";
143
144    String ADMIN_CONFIG_RESOURCE = "configuration";
145
146    String ADMIN_INSTRUMENTATION_RESOURCE = "instrumentation";
147
148    String ADMIN_BUILD_VERSION_RESOURCE = "build-version";
149
150    String ADMIN_QUEUE_DUMP_RESOURCE = "queue-dump";
151
152    String ADMIN_METRICS_RESOURCE = "metrics";
153
154    String OOZIE_ERROR_CODE = "oozie-error-code";
155
156    String OOZIE_ERROR_MESSAGE = "oozie-error-message";
157
158    String JOBTYPE_PARAM = "jobtype";
159
160    String SLA_GT_SEQUENCE_ID = "gt-sequence-id";
161
162    String MAX_EVENTS = "max-events";
163
164    String SLA = "sla";
165
166    String DO_AS_PARAM = "doAs";
167
168    String TIME_ZONE_PARAM = "timezone";
169
170    String ADMIN_TIME_ZONES_RESOURCE = "available-timezones";
171
172    String ADMIN_JMS_INFO = "jmsinfo";
173
174    String JOB_SHOW_JMS_TOPIC = "jmstopic";
175
176    String ADMIN_AVAILABLE_OOZIE_SERVERS_RESOURCE = "available-oozie-servers";
177
178    String ADMIN_UPDATE_SHARELIB = "update_sharelib";
179
180    String ADMIN_LIST_SHARELIB = "list_sharelib";
181
182    String SHARE_LIB_REQUEST_KEY = "lib";
183
184    String ALL_SERVER_REQUEST = "allservers";
185
186    String ALL_WORKFLOWS_FOR_COORD_ACTION = "allruns";
187
188    String LOG_FILTER_OPTION = "logfilter";
189
190    String JOB_COORD_RERUN_FAILED_PARAM = "failed";
191
192    String SLA_DISABLE_ALERT = "sla-disable";
193
194    String SLA_ENABLE_ALERT = "sla-enable";
195
196    String SLA_CHANGE = "sla-change";
197
198    String SLA_ALERT_RANGE = "sla-alert-range";
199
200    String COORDINATORS_PARAM = "coordinators";
201
202    String SLA_NOMINAL_TIME = "sla-nominal-time";
203
204    String SLA_SHOULD_START = "sla-should-start";
205
206    String SLA_SHOULD_END = "sla-should-end";
207
208    String SLA_MAX_DURATION = "sla-max-duration";
209
210    String JOB_COORD_SCOPE_ACTION_LIST = "action-list";
211
212    String VALIDATE = "validate";
213
214    String FILE_PARAM = "file";
215
216    String USER_PARAM = "user";
217
218}