jbatch/src/main/java/org/apache/batchee/util/Batches.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.batchee.util;

import org.apache.batchee.container.impl.JobOperatorImpl;

import javax.batch.operations.JobOperator;
import javax.batch.runtime.BatchRuntime;
import javax.batch.runtime.BatchStatus;
import java.util.Arrays;
import java.util.Collection;

public class Batches {
    private static final Collection<BatchStatus> BATCH_END_STATUSES = Arrays.asList(BatchStatus.COMPLETED, BatchStatus.FAILED, BatchStatus.STOPPED, BatchStatus.ABANDONED);

    private Batches() {
        // no-op
    }

    public static void waitForEnd(final long id) {
        waitForEnd(BatchRuntime.getJobOperator(), id);
    }

    public static void waitForEnd(final JobOperator jobOperator, final long id) {
        waitFor(jobOperator, id);
    }

    /**
     * Waits until the end of the {@link javax.batch.runtime.JobExecution} with the given {@code id}
     * and returns the final {@link BatchStatus}.
     *
     * @param id of the {@link javax.batch.runtime.JobExecution} to wait for
     *
     * @return the final {@link BatchStatus} or in case of an {@link InterruptedException} the current {@link BatchStatus}
     *         will be returned.
     */
    public static BatchStatus waitFor(final long id) {
        return waitFor(BatchRuntime.getJobOperator(), id);
    }

    /**
     * Waits until the end of the {@link javax.batch.runtime.JobExecution} with the given {@code id}
     * and returns the final {@link BatchStatus}.
     *
     * @param jobOperator the {@link JobOperator to use}
     * @param id of the {@link javax.batch.runtime.JobExecution} to wait for
     *
     * @return the final {@link BatchStatus} or in case of an {@link InterruptedException} the current {@link BatchStatus}
     *         will be returned.
     */
    public static BatchStatus waitFor(JobOperator jobOperator, long id) {

        BatchStatus batchStatus;

        if (JobOperatorImpl.class.isInstance(jobOperator)) {
            JobOperatorImpl.class.cast(jobOperator).waitFor(id);
            batchStatus = getBatchStatus(jobOperator, id);
        } else {

            // else polling
            do {
                try {
                    Thread.sleep(100);
                    batchStatus = getBatchStatus(jobOperator, id);
                } catch (final InterruptedException e) {
                    return getBatchStatus(jobOperator, id);
                }
            }
            while (!isDone(batchStatus));
        }

        return batchStatus;
    }

    public static boolean isDone(final BatchStatus status) {
        return BATCH_END_STATUSES.contains(status);
    }

    public static boolean isDone(final JobOperator jobOperator, final long id) {
        return isDone(getBatchStatus(jobOperator, id));
    }


    private static BatchStatus getBatchStatus(JobOperator jobOperator, long id) {
        return jobOperator.getJobExecution(id).getBatchStatus();
    }
}