core/src/main/java/org/apache/oozie/command/wf/JobXCommand.java

/**
 * 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.command.wf;

import org.apache.oozie.ErrorCode;
import org.apache.oozie.WorkflowJobBean;
import org.apache.oozie.command.CommandException;
import org.apache.oozie.command.PreconditionException;
import org.apache.oozie.executor.jpa.JPAExecutorException;
import org.apache.oozie.executor.jpa.WorkflowInfoWithActionsSubsetGetJPAExecutor;
import org.apache.oozie.service.ConfigurationService;
import org.apache.oozie.service.JPAService;
import org.apache.oozie.service.Services;
import org.apache.oozie.util.ParamChecker;

/**
 * This Xcommand is returning the workflow with action within the range.
 */
public class JobXCommand extends WorkflowXCommand<WorkflowJobBean> {
    private final String id;
    private int start = 1;
    private int len = Integer.MAX_VALUE;
    private WorkflowJobBean workflow;

    public static final String CONF_CONSOLE_URL = "oozie.JobCommand.job.console.url";

    public JobXCommand(String id) {
        this(id, 1, Integer.MAX_VALUE);
    }

    /**
     * Constructor used to retrieve WF Job
     * @param id wf jobId
     * @param start starting index in the list of actions belonging to the job
     * @param length number of actions to be returned
     */
    public JobXCommand(String id, int start, int length) {
        super("job.info", "job.info", 1, true);
        this.id = ParamChecker.notEmpty(id, "id");
        this.start = start;
        this.len = length;
    }

    @Override
    protected WorkflowJobBean execute() throws CommandException {
        try {
            JPAService jpaService = Services.get().get(JPAService.class);
            if (jpaService != null) {
                this.workflow = jpaService.execute(new WorkflowInfoWithActionsSubsetGetJPAExecutor(this.id, this.start,
                        this.len));
            }
            else {
                throw new CommandException(ErrorCode.E0610, this.id);
            }
            this.workflow.setConsoleUrl(getJobConsoleUrl(id));
        }
        catch (JPAExecutorException ex) {
            throw new CommandException(ex);
        }
        catch (Exception ex) {
            throw new CommandException(ErrorCode.E0603, ex.getMessage(), ex);
        }

        return this.workflow;
    }

    /**
     * @param jobId : Job ID to retrieve console URL
     * @return console URL
     */
    public static String getJobConsoleUrl(String jobId) {
        String consoleUrl = ConfigurationService.get(CONF_CONSOLE_URL);
        return (consoleUrl != null) ? consoleUrl + jobId : null;
    }

    @Override
    public String getEntityKey() {
        return this.id;
    }

    @Override
    protected boolean isLockRequired() {
        return false;
    }

    @Override
    protected void loadState() throws CommandException {
    }

    @Override
    protected void verifyPrecondition() throws CommandException, PreconditionException {
    }
}