com.hpe.caf.services.job.api.JobsCancel Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of job-service Show documentation
The newest version!
/*
 * Copyright 2016-2024 Open Text.
 *
 * Licensed 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 com.hpe.caf.services.job.api;

import com.hpe.caf.services.configuration.AppConfig;
import com.hpe.caf.services.configuration.AppConfigProvider;
import com.hpe.caf.services.job.api.filter.RsqlToSqlUtils;
import com.hpe.caf.services.job.exceptions.BadRequestException;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import java.util.Arrays;
import java.util.List;

public final class JobsCancel {
    private static final Logger LOG = LoggerFactory.getLogger(JobsCancel.class);

    /**
     * Cancel the job specified by the jobId.
     *
     * @param   jobId       the id of the job to cancel
     * @throws  Exception   bad request or database exceptions thrown
     */
    public static void cancelJob(final String partitionId, String jobId) throws Exception {

        try {
            LOG.debug("cancel: Starting...");
            ApiServiceUtil.validatePartitionId(partitionId);

            //  Make sure the job id has been provided.
            if (!ApiServiceUtil.isNotNullOrEmpty(jobId)) {
                LOG.error("cancel: Error - '{}'", ApiServiceUtil.ERR_MSG_JOB_ID_NOT_SPECIFIED);
                throw new BadRequestException(ApiServiceUtil.ERR_MSG_JOB_ID_NOT_SPECIFIED);
            }

            //  Make sure the job id does not contain any invalid characters.
            if (ApiServiceUtil.containsInvalidCharacters(jobId)) {
                LOG.error("cancel: Error - '{}'", ApiServiceUtil.ERR_MSG_JOB_ID_CONTAINS_INVALID_CHARS);
                throw new BadRequestException(ApiServiceUtil.ERR_MSG_JOB_ID_CONTAINS_INVALID_CHARS);
            }

            //  Get app config settings.
            LOG.debug("cancel: Reading database connection properties...");
            AppConfig config = AppConfigProvider.getAppConfigProperties();

            //  Get database helper instance.
            DatabaseHelper databaseHelper =new DatabaseHelper(config);

            //  Cancel the specified job.
            LOG.debug("cancel: Cancelling the job...");
            databaseHelper.cancelJob(partitionId, jobId);

            LOG.debug("cancel: Done.");
        } catch (Exception e) {
            LOG.error("Error - '{}'", e.toString());
            throw e;
        }
    }

    /**
     * Cancels jobs which meet the filtering criteria
     *
     * @param partitionId       required partitionId of the job to cancel
     * @param jobIdStartsWith   optional jobIdStartsWith condition
     * @param labelExists       optional metadata to filter against
     * @param filter            optional filter to use when returning results
     * @throws Exception        bad request or database exceptions
     */
    public static long cancelJobs(final String partitionId, final String jobIdStartsWith, final String labelExists, final String filter)
            throws Exception {
        try {
            LOG.debug("cancelJobs: Starting...");
            ApiServiceUtil.validatePartitionId(partitionId);

            List labelValues = null;
            if(labelExists != null && !labelExists.isEmpty()) {
                final String[] split = labelExists.split(",");
                labelValues = Arrays.asList(split);
            }

            final String filterQuery = RsqlToSqlUtils.convertToSqlSyntax(filter);

            //  Get app config settings.
            LOG.debug("cancelJobs: Reading database connection properties...");
            final AppConfig config = AppConfigProvider.getAppConfigProperties();

            //  Get database helper instance.
            final DatabaseHelper databaseHelper = new DatabaseHelper(config);

            //  Cancel the specified jobs.
            LOG.debug("cancelJobs: Cancelling the jobs...");
            final int successfulCancellations = databaseHelper.cancelJobs(partitionId, jobIdStartsWith, labelValues, filterQuery);

            LOG.debug("cancelJobs: Done");
            return successfulCancellations;
        } catch (final Exception e) {
            LOG.error("Error - ", e);
            throw e;
        }
    }
}