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;
019    
020    import org.apache.oozie.util.XLog;
021    
022    public enum ErrorCode {
023        E0000(XLog.STD, "System property 'oozie.home.dir' not defined"),
024        E0001(XLog.OPS, "Could not create runtime directory, {0}"),
025        E0002(XLog.STD, "System is in safe mode"),
026        E0003(XLog.OPS, "Oozie home directory must be an absolute path [{0}]"),
027        E0004(XLog.OPS, "Oozie home directory does not exist [{0}]"),
028    
029        E0010(XLog.OPS, "Could not initialize log service, {0}"),
030        E0011(XLog.OPS, "Log4j file must be a file name [{0}]"),
031        E0012(XLog.OPS, "Log4j file must be a '.properties' file [{0}]"),
032        E0013(XLog.OPS, "Log4j file [{0}] not found in configuration dir [{1}] neither in classpath"),
033    
034        E0020(XLog.OPS, "Environment variable {0} not defined"),
035        E0022(XLog.OPS, "Configuration file must be a file name [{0}]"),
036        E0023(XLog.OPS, "Default configuration file [{0}] not found in classpath"),
037        E0024(XLog.OPS, "Oozie configuration directory does not exist [{0}]"),
038        E0025(XLog.OPS, "Configuration service internal error, it should never happen, {0}"),
039        E0026(XLog.OPS, "Missing required configuration property [{0}]"),
040    
041        E0100(XLog.OPS, "Could not initialize service [{0}], {1}"),
042        E0110(XLog.OPS, "Could not parse or validate EL definition [{0}], {1}"),
043        E0111(XLog.OPS, "class#method not found [{0}#{1}]"),
044        E0112(XLog.OPS, "class#method does not have PUBLIC or STATIC modifier [{0}#{1}]"),
045        E0113(XLog.OPS, "class not found [{0}]"),
046        E0114(XLog.OPS, "class#constant does not have PUBLIC or STATIC modifier [{0}#{1}]"),
047        E0115(XLog.OPS, "class#constant not found"),
048        E0116(XLog.OPS, "class#constant does not have PUBLIC or STATIC modifier [{0}#{1}]"),
049        E0120(XLog.OPS, "UUID, invalid generator type [{0}]"),
050        E0130(XLog.OPS, "Could not parse workflow schemas file/s, {0}"),
051        E0131(XLog.OPS, "Could not read workflow schemas file/s, {0}"),
052        E0140(XLog.OPS, "Could not access database, {0}"),
053        E0141(XLog.OPS, "Could not create DataSource connection pool, {0}"),
054        E0150(XLog.OPS, "Actionexecutor type already registered [{0}]"),
055        E0160(XLog.OPS, "Could not read admin users file [{0}], {1}"),
056    
057        E0300(XLog.STD, "Invalid content-type [{0}]"),
058        E0301(XLog.STD, "Invalid resource [{0}]"),
059        E0302(XLog.STD, "Invalid parameter [{0}]"),
060        E0303(XLog.STD, "Invalid parameter value, [{0}] = [{1}]"),
061        E0304(XLog.STD, "Invalid parameter type, parameter [{0}] expected type [{1}]"),
062        E0305(XLog.STD, "Missing parameter [{0}]"),
063        E0306(XLog.STD, "Invalid parameter"),
064        E0307(XLog.STD, "Runtime error [{0}]"),
065        E0308(XLog.STD, "Could not parse date range parameter [{0}]"),
066    
067    
068        E0400(XLog.STD, "User mismatch, request user [{0}] configuration user [{1}]"),
069        E0401(XLog.STD, "Missing configuration property [{0}]"),
070        E0402(XLog.STD, "Invalid callback ID [{0}]"),
071        E0403(XLog.STD, "Invalid callback data, {0}"),
072        E0404(XLog.STD, "Only one of the properties are allowed [{0}]"),
073    
074        E0420(XLog.STD, "Invalid jobs filter [{0}], {1}"),
075    
076        E0500(XLog.OPS, "Not authorized, {0}"),
077        E0501(XLog.OPS, "Could not perform authorization operation, {0}"),
078        E0502(XLog.OPS, "User [{0}] does not belong to group [{1}]"),
079        E0503(XLog.OPS, "User [{0}] does not have admin privileges"),
080        E0504(XLog.OPS, "App directory [{0}] does not exist"),
081        E0505(XLog.OPS, "App definition [{0}] does not exist"),
082        E0506(XLog.OPS, "App definition [{0}] is not a file"),
083        E0507(XLog.OPS, "Could not access to [{0}], {1}"),
084        E0508(XLog.OPS, "User [{0}] not authorized for WF job [{1}]"),
085        E0509(XLog.OPS, "User [{0}] not authorized for Coord job [{1}]"),
086        E0510(XLog.OPS, "Unable to get Credential [{0}]"),
087    
088        E0600(XLog.OPS, "Could not get connection, {0}"),
089        E0601(XLog.OPS, "Could not close connection, {0}"),
090        E0602(XLog.OPS, "Could not commit connection, {0}"),
091        E0603(XLog.OPS, "SQL error in operation [{0}], {1}"),
092        E0604(XLog.STD, "Job does not exist [{0}]"),
093        E0605(XLog.STD, "Action does not exist [{0}]"),
094        E0606(XLog.STD, "Could not get lock [{0}], timed out [{1}]ms"),
095        E0607(XLog.OPS, "Other error in operation [{0}], {1}"),
096        E0608(XLog.OPS, "JDBC setup error [{0}], {1}"),
097        E0609(XLog.OPS, "Missing [{0}] ORM file [{1}]"),
098        E0610(XLog.OPS, "Missing JPAService, StoreService cannot run without a JPAService"),
099    
100        E0700(XLog.STD, "XML error, {0}"),
101        E0701(XLog.STD, "XML schema error, {0}"),
102        E0702(XLog.STD, "IO error, {0}"),
103        E0703(XLog.STD, "Invalid workflow element [{0}]"),
104        E0704(XLog.STD, "Definition already complete, application [{0}]"),
105        E0705(XLog.STD, "Nnode already defined, node [{0}]"),
106        E0706(XLog.STD, "Node cannot transition to itself node [{0}]"),
107        E0707(XLog.STD, "Loop detected at parsing, node [{0}]"),
108        E0708(XLog.STD, "Invalid transition, node [{0}] transition [{1}]"),
109        E0709(XLog.STD, "Loop detected at runtime, node [{0}]"),
110        E0710(XLog.STD, "Could not read the workflow definition, {0}"),
111        E0711(XLog.STD, "Invalid application URI [{0}], {1}"),
112        E0712(XLog.STD, "Could not create lib paths list for application [{0}], {1}"),
113        E0713(XLog.OPS, "SQL error, {0}"),
114        E0714(XLog.OPS, "Workflow lib error, {0}"),
115        E0715(XLog.OPS, "Invalid signal value for the start node, signal [{0}]"),
116        E0716(XLog.OPS, "Workflow not running"),
117        E0717(XLog.OPS, "Workflow not suspended"),
118        E0718(XLog.OPS, "Workflow already completed"),
119        E0719(XLog.OPS, "Job already started"),
120        E0720(XLog.OPS, "Fork/join mismatch, node [{0}]"),
121        E0721(XLog.OPS, "Invalid signal/transition, decision node [{0}] signal [{1}]"),
122        E0722(XLog.OPS, "Action signals can only be OK or ERROR, action node [{0}]"),
123        E0723(XLog.STD, "Unsupported action type, node [{0}] type [{1}]"),
124        E0724(XLog.STD, "Invalid node name, {0}"),
125        E0725(XLog.STD, "Workflow instance can not be killed, {0}"),
126        E0726(XLog.STD, "Workflow action can not be killed, {0}"),
127        E0727(XLog.STD, "Workflow Job can not be suspended as its not in running state, {0}, Status: {1}"),
128        E0728(XLog.STD, "Coordinator Job can not be suspended as job finished or failed or killed, id : {0}, status : {1}"),
129        E0729(XLog.OPS, "Kill node message [{0}]"),
130    
131        E0800(XLog.STD, "Action it is not running its in [{1}] state, action [{0}]"),
132        E0801(XLog.STD, "Workflow already running, workflow [{0}]"),
133        E0802(XLog.STD, "Invalid action type [{0}]"),
134        E0803(XLog.STD, "IO error, {0}"),
135        E0804(XLog.STD, "Disallowed default property [{0}]"),
136        E0805(XLog.STD, "Workflow job not completed, status [{0}]"),
137        E0806(XLog.STD, "Action did not complete in previous run, action [{0}]"),
138        E0807(XLog.STD, "Some skip actions were not executed [{0}]"),
139        E0808(XLog.STD, "Disallowed user property [{0}]"),
140        E0809(XLog.STD, "Workflow action is not eligible to start [{0}]"),
141        E0810(XLog.STD, "Job state is not [{0}]. Skipping ActionStart Execution"),
142        E0811(XLog.STD, "Job state is not [{0}]. Skipping ActionEnd Execution"),
143        E0812(XLog.STD, "Action pending=[{0}], status=[{1}]. Skipping ActionEnd Execution"),
144        E0813(XLog.STD, "Workflow not RUNNING, current status [{0}]"),
145        E0814(XLog.STD, "SignalCommand for action id=[{0}] is already processed, status=[{1}], , pending=[{2}]"),
146        E0815(XLog.STD, "Action pending=[{0}], status=[{1}]. Skipping ActionCheck Execution"),
147        E0816(XLog.STD, "Action pending=[{0}], status=[{1}]. Skipping ActionStart Execution"),
148        E0817(XLog.STD, "The wf action [{0}] has been udated recently. Ignoring ActionCheck."),
149        E0818(XLog.STD, "Action [{0}] status is running but WF Job [{1}] status is [{2}]. Expected status is RUNNING."),
150        E0819(XLog.STD, "Unable to delete the temp dir of job WF Job [{0}]."),
151        E0820(XLog.STD, "Action user retry max [{0}] is over system defined max [{1}], re-assign to use system max."),
152    
153        E0900(XLog.OPS, "Jobtracker [{0}] not allowed, not in Oozie's whitelist"),
154        E0901(XLog.OPS, "Namenode [{0}] not allowed, not in Oozie's whitelist"),
155        E0902(XLog.OPS, "Exception occured: [{0}]"),
156    
157        E1001(XLog.STD, "Could not read the coordinator job definition, {0}"),
158        E1002(XLog.STD, "Invalid coordinator application URI [{0}], {1}"),
159        E1003(XLog.STD, "Invalid coordinator application attributes [{0}], {1}"),
160        E1004(XLog.STD, "Expression language evaluation error [{0}], {1}"),
161        E1005(XLog.STD, "Could not read the coordinator job configuration read from DB, {0}"),
162        E1006(XLog.STD, "Invalid coordinator application [{0}], {1}"),
163        E1007(XLog.STD, "Unable to add record to SLA table. [{0}], {1}"),
164        E1008(XLog.STD, "Not implemented. [{0}]"),
165        E1009(XLog.STD, "Unable to parse XML response. [{0}]"),
166        E1010(XLog.STD, "Invalid data in coordinator xml. [{0}]"),
167        E1011(XLog.STD, "Cannot update coordinator job [{0}], {1}"),
168        E1012(XLog.STD, "Coord Job Materialization Error: {0}"),
169        E1013(XLog.STD, "Coord Job Recovery Error: {0}"),
170        E1014(XLog.STD, "Coord job change command not supported"),
171        E1015(XLog.STD, "Invalid coordinator job change value {0}, {1}"),
172        E1016(XLog.STD, "Cannot change a killed coordinator job"),
173        E1017(XLog.STD, "Cannot change a workflow job"),
174        E1018(XLog.STD, "Coord Job Rerun Error: {0}"),
175        E1019(XLog.STD, "Could not submit coord job, [{0}]"),
176        E1020(XLog.STD, "Could not kill coord job, this job either finished successfully or does not exist , [{0}]"),
177        E1021(XLog.STD, "Coord Action Input Check Error: {0}"),
178    
179        E1100(XLog.STD, "Command precondition does not hold before execution, [{0}]"),
180    
181        E1101(XLog.STD, "SLA Nominal time is required."),
182        E1102(XLog.STD, "SLA should-start can't be empty."),
183    
184        E1201(XLog.STD, "State [{0}] is invalid for job [{1}]."),
185    
186        E1301(XLog.STD, "Could not read the bundle job definition, [{0}]"),
187        E1302(XLog.STD, "Invalid bundle application URI [{0}], {1}"),
188        E1303(XLog.STD, "Invalid bundle application attributes [{0}], {1}"),
189        E1304(XLog.STD, "Duplicate bundle application coordinator name [{0}]"),
190        E1305(XLog.STD, "Empty bundle application coordinator name."),
191        E1306(XLog.STD, "Could not read the bundle job configuration, [{0}]"),
192        E1307(XLog.STD, "Could not read the bundle coord job configuration, [{0}]"),
193        E1308(XLog.STD, "Bundle Action Status  [{0}] is not matching with coordinator previous status [{1}]."),
194        E1309(XLog.STD, "Bundle Action for bundle ID  [{0}] and Coordinator [{1}] could not be update by BundleStatusUpdateXCommand"),
195        E1310(XLog.STD, "Bundle Job submission Error: [{0}]"),
196        E1311(XLog.STD, "Bundle Action for bundle ID  [{0}] could not be get."),
197        E1312(XLog.STD, "Bundle Job can not be suspended as job finished or failed or killed, id : {0}, status : {1}"),
198        E1313(XLog.STD, "Bundle Job can not be changed as job finished, {0}, Status: {1}"),
199        E1314(XLog.STD, "Bundle Job can not be changed as job does not exist, {0}"),
200        E1315(XLog.STD, "Bundle job can not be paused, {0}"),
201        E1316(XLog.STD, "Bundle job can not be unpaused, {0}"),
202        E1317(XLog.STD, "Invalid bundle job change value {0}, {1}"),
203        E1318(XLog.STD, "No coord jobs for the bundle=[{0}], fail the bundle"),
204        E1319(XLog.STD, "Invalid bundle coord job namespace, [{0}]"),
205    
206        ETEST(XLog.STD, "THIS SHOULD HAPPEN ONLY IN TESTING, invalid job id [{0}]"),;
207    
208        private String template;
209        private int logMask;
210    
211        /**
212         * Create an error code.
213         *
214         * @param template template for the exception message.
215         * @param logMask log mask for the exception.
216         */
217        private ErrorCode(int logMask, String template) {
218            this.logMask = logMask;
219            this.template = template;
220        }
221    
222        /**
223         * Return the message (StringFormat) template for the error code.
224         *
225         * @return message template.
226         */
227        public String getTemplate() {
228            return template;
229        }
230    
231        /**
232         * Return the log mask (to which log the exception should be logged) of the error.
233         *
234         * @return error log mask.
235         */
236        public int getLogMask() {
237            return logMask;
238        }
239    
240        /**
241         * Return a templatized error message for the error code.
242         *
243         * @param args the parameters for the templatized message.
244         * @return error message.
245         */
246        public String format(Object... args) {
247            return XLog.format("{0}: {1}", toString(), XLog.format(getTemplate(), args));
248        }
249    
250    }