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    package org.apache.oozie.client.rest;
019    
020    /**
021     * Constansts used by Oozie REST WS API
022     */
023    public interface RestConstants {
024    
025        public static final String VERSIONS = "versions";
026    
027        public static final String JOB = "job";
028    
029        public static final String JOBS = "jobs";
030    
031        public static final String ADMIN = "admin";
032    
033        public static final String JSON_CONTENT_TYPE = "application/json";
034    
035        public static final String XML_CONTENT_TYPE = "application/xml";
036    
037        public static final String FORM_CONTENT_TYPE = "application/x-www-form-urlencoded";
038    
039        public static final String TEXT_CONTENT_TYPE = "text/plain";
040    
041        public static final String PNG_IMAGE_CONTENT_TYPE = "image/png";
042    
043        public static final String ACTION_PARAM = "action";
044    
045        public static final String OFFSET_PARAM = "offset";
046    
047        public static final String LEN_PARAM = "len";
048    
049        public static final String JOB_FILTER_PARAM = "filter";
050    
051        public static final String JOB_RESOURCE = "/job";
052    
053        public static final String JOB_ACTION_START = "start";
054    
055        public static final String JOB_ACTION_DRYRUN = "dryrun";
056    
057        public static final String JOB_ACTION_SUSPEND = "suspend";
058    
059        public static final String JOB_ACTION_RESUME = "resume";
060    
061        public static final String JOB_ACTION_KILL = "kill";
062    
063        public static final String JOB_ACTION_CHANGE = "change";
064        public static final String JOB_CHANGE_VALUE = "value";
065    
066        public static final String JOB_ACTION_RERUN = "rerun";
067    
068        public static final String JOB_COORD_ACTION_RERUN = "coord-rerun";
069    
070        public static final String JOB_BUNDLE_ACTION_RERUN = "bundle-rerun";
071    
072        public static final String JOB_SHOW_PARAM = "show";
073    
074        public static final String JOB_SHOW_CONFIG = "config";
075    
076        public static final String JOB_SHOW_INFO = "info";
077    
078        public static final String JOB_SHOW_LOG = "log";
079    
080        public static final String JOB_SHOW_DEFINITION = "definition";
081    
082        public static final String JOB_SHOW_GRAPH = "graph";
083    
084        public static final String JOB_SHOW_KILL_PARAM = "show-kill";
085    
086        public static final String JOB_BUNDLE_RERUN_COORD_SCOPE_PARAM = "coord-scope";
087    
088        public static final String JOB_BUNDLE_RERUN_DATE_SCOPE_PARAM = "date-scope";
089    
090        public static final String JOB_COORD_RERUN_TYPE_PARAM = "type";
091    
092        public static final String JOB_COORD_RERUN_DATE = "date";
093    
094        public static final String JOB_COORD_RERUN_ACTION = "action";
095    
096        public static final String JOB_COORD_RERUN_SCOPE_PARAM = "scope";
097    
098        public static final String JOB_COORD_RERUN_REFRESH_PARAM = "refresh";
099    
100        public static final String JOB_COORD_RERUN_NOCLEANUP_PARAM = "nocleanup";
101    
102        public static final String JOB_LOG_ACTION = "action";
103    
104        public static final String JOB_LOG_DATE = "date";
105    
106        public static final String JOB_LOG_SCOPE_PARAM = "scope";
107    
108        public static final String JOB_LOG_TYPE_PARAM = "type";
109    
110        public static final String JOBS_FILTER_PARAM = "filter";
111    
112        public static final String JOBS_BULK_PARAM = "bulk";
113    
114        public static final String JOBS_EXTERNAL_ID_PARAM = "external-id";
115    
116        public static final String ADMIN_STATUS_RESOURCE = "status";
117    
118        public static final String ADMIN_SAFE_MODE_PARAM = "safemode";
119    
120        public static final String ADMIN_SYSTEM_MODE_PARAM = "systemmode";
121    
122        public static final String ADMIN_LOG_RESOURCE = "log";
123    
124        public static final String ADMIN_OS_ENV_RESOURCE = "os-env";
125    
126        public static final String ADMIN_JAVA_SYS_PROPS_RESOURCE = "java-sys-properties";
127    
128        public static final String ADMIN_CONFIG_RESOURCE = "configuration";
129    
130        public static final String ADMIN_INSTRUMENTATION_RESOURCE = "instrumentation";
131    
132        public static final String ADMIN_BUILD_VERSION_RESOURCE = "build-version";
133    
134        public static final String ADMIN_QUEUE_DUMP_RESOURCE = "queue-dump";
135    
136        public static final String OOZIE_ERROR_CODE = "oozie-error-code";
137    
138        public static final String OOZIE_ERROR_MESSAGE = "oozie-error-message";
139    
140        public static final String JOBTYPE_PARAM = "jobtype";
141    
142        public static final String SLA_GT_SEQUENCE_ID = "gt-sequence-id";
143    
144        public static final String MAX_EVENTS = "max-events";
145    
146        public static final String SLA = "sla";
147    
148        public static final String DO_AS_PARAM = "doAs";
149        
150        public static final String TIME_ZONE_PARAM = "timezone";
151        
152        public static final String ADMIN_TIME_ZONES_RESOURCE = "available-timezones";
153    }