| /** |
| * Licensed to the Apache Software Foundation (ASF) under one |
| * or more contributor license agreements. See the NOTICE file |
| * distributed with this work for additional information |
| * regarding copyright ownership. The ASF licenses this file |
| * to you under the Apache License, Version 2.0 (the |
| * "License"); you may not use this file except in compliance |
| * with the License. You may obtain a copy of the License at |
| * |
| * http://www.apache.org/licenses/LICENSE-2.0 |
| * |
| * Unless required by applicable law or agreed to in writing, software |
| * distributed under the License is distributed on an "AS IS" BASIS, |
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| * See the License for the specific language governing permissions and |
| * limitations under the License. |
| */ |
| package org.apache.oozie; |
| |
| import java.io.IOException; |
| import java.io.Writer; |
| import java.util.ArrayList; |
| import java.util.HashMap; |
| import java.util.HashSet; |
| import java.util.List; |
| import java.util.Map; |
| import java.util.Properties; |
| import java.util.Set; |
| import java.util.StringTokenizer; |
| |
| import org.apache.hadoop.conf.Configuration; |
| import org.apache.oozie.client.CoordinatorJob; |
| import org.apache.oozie.client.OozieClient; |
| import org.apache.oozie.client.WorkflowJob; |
| import org.apache.oozie.command.CommandException; |
| import org.apache.oozie.command.wf.CompletedActionCommand; |
| import org.apache.oozie.command.wf.DefinitionCommand; |
| import org.apache.oozie.command.wf.ExternalIdCommand; |
| import org.apache.oozie.command.wf.JobCommand; |
| import org.apache.oozie.command.wf.JobsCommand; |
| import org.apache.oozie.command.wf.KillCommand; |
| import org.apache.oozie.command.wf.ReRunCommand; |
| import org.apache.oozie.command.wf.ResumeCommand; |
| import org.apache.oozie.command.wf.StartCommand; |
| import org.apache.oozie.command.wf.SubmitCommand; |
| import org.apache.oozie.command.wf.SuspendCommand; |
| import org.apache.oozie.service.DagXLogInfoService; |
| import org.apache.oozie.service.Service; |
| import org.apache.oozie.service.Services; |
| import org.apache.oozie.service.XLogService; |
| import org.apache.oozie.util.ParamChecker; |
| import org.apache.oozie.util.XLog; |
| import org.apache.oozie.util.XLogStreamer; |
| |
| public abstract class BaseEngine { |
| public static final String USE_XCOMMAND = "oozie.useXCommand"; |
| |
| protected String user; |
| protected String authToken; |
| |
| /** |
| * Return the user name. |
| * |
| * @return the user name. |
| */ |
| public String getUser() { |
| return user; |
| } |
| |
| /** |
| * Return the authentication token. |
| * |
| * @return the authentication token. |
| */ |
| protected String getAuthToken() { |
| return authToken; |
| } |
| |
| /** |
| * Submit a job. |
| * <p/> |
| * It validates configuration properties. |
| * |
| * @param conf job configuration. |
| * @param startJob indicates if the job should be started or not. |
| * @return the job Id. |
| * @throws BaseEngineException thrown if the job could not be created. |
| */ |
| public abstract String submitJob(Configuration conf, boolean startJob) throws BaseEngineException; |
| |
| /** |
| * Start a job. |
| * |
| * @param jobId job Id. |
| * @throws BaseEngineException thrown if the job could not be started. |
| */ |
| public abstract void start(String jobId) throws BaseEngineException; |
| |
| /** |
| * Resume a job. |
| * |
| * @param jobId job Id. |
| * @throws BaseEngineException thrown if the job could not be resumed. |
| */ |
| public abstract void resume(String jobId) throws BaseEngineException; |
| |
| /** |
| * Suspend a job. |
| * |
| * @param jobId job Id. |
| * @throws BaseEngineException thrown if the job could not be suspended. |
| */ |
| public abstract void suspend(String jobId) throws BaseEngineException; |
| |
| /** |
| * Kill a job. |
| * |
| * @param jobId job Id. |
| * @throws BaseEngineException thrown if the job could not be killed. |
| */ |
| public abstract void kill(String jobId) throws BaseEngineException; |
| |
| /** |
| * Change a coordinator job. |
| * |
| * @param jobId job Id. |
| * @param changeValue change value. |
| * @throws BaseEngineException thrown if the job could not be changed. |
| */ |
| public abstract void change(String jobId, String changeValue) throws BaseEngineException; |
| |
| /** |
| * Rerun a job. |
| * |
| * @param jobId job Id to rerun. |
| * @param conf configuration information for the rerun. |
| * @throws BaseEngineException thrown if the job could not be rerun. |
| */ |
| public abstract void reRun(String jobId, Configuration conf) throws BaseEngineException; |
| |
| /** |
| * Return the info about a wf job. |
| * |
| * @param jobId job Id. |
| * @return the workflow job info. |
| * @throws DagEngineException thrown if the job info could not be obtained. |
| */ |
| public abstract WorkflowJob getJob(String jobId) throws BaseEngineException; |
| |
| /** |
| * Return the info about a wf job with actions subset. |
| * |
| * @param jobId job Id |
| * @param start starting from this index in the list of actions belonging to the job |
| * @param length number of actions to be returned |
| * @return the workflow job info. |
| * @throws DagEngineException thrown if the job info could not be obtained. |
| */ |
| public abstract WorkflowJob getJob(String jobId, int start, int length) throws BaseEngineException; |
| |
| /** |
| * Return the info about a coord job. |
| * |
| * @param jobId job Id. |
| * @return the coord job info. |
| * @throws BaseEngineException thrown if the job info could not be obtained. |
| */ |
| public abstract CoordinatorJob getCoordJob(String jobId) throws BaseEngineException; |
| |
| /** |
| * Return the info about a coord job with actions subset. |
| * |
| * @param jobId job Id. |
| * @param start starting from this index in the list of actions belonging to the job |
| * @param length number of actions to be returned |
| * @return the coord job info. |
| * @throws BaseEngineException thrown if the job info could not be obtained. |
| */ |
| public abstract CoordinatorJob getCoordJob(String jobId, int start, int length) throws BaseEngineException; |
| |
| /** |
| * Return the a job definition. |
| * |
| * @param jobId job Id. |
| * @return the job definition. |
| * @throws BaseEngineException thrown if the job definition could no be obtained. |
| */ |
| public abstract String getDefinition(String jobId) throws BaseEngineException; |
| |
| /** |
| * Stream the log of a job. |
| * |
| * @param jobId job Id. |
| * @param writer writer to stream the log to. |
| * @throws IOException thrown if the log cannot be streamed. |
| * @throws BaseEngineException thrown if there is error in getting the Workflow/Coordinator Job Information for |
| * jobId. |
| */ |
| public abstract void streamLog(String jobId, Writer writer) throws IOException, BaseEngineException; |
| |
| /** |
| * Return the workflow Job ID for an external ID. |
| * <p/> |
| * This is reverse lookup for recovery purposes. |
| * |
| * @param externalId external ID provided at job submission time. |
| * @return the associated workflow job ID if any, <code>null</code> if none. |
| * @throws BaseEngineException thrown if the lookup could not be done. |
| */ |
| public abstract String getJobIdForExternalId(String externalId) throws BaseEngineException; |
| |
| public abstract String dryrunSubmit(Configuration conf, boolean startJob) throws BaseEngineException; |
| |
| } |