org.kie.api.executor.Executor Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of kogito-api
The Kogito public API which is backwards compatible between releases.
There is a newer version: 10.0.0
/*
 * Copyright 2013 Red Hat, Inc. and/or its affiliates.
 *
 * 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 org.kie.api.executor;

import java.util.Date;
import java.util.Map;
import java.util.concurrent.TimeUnit;

/**
 * Core logic of executor is encapsulated by this interface.
 * It allows to operate on request instances of the execution.
 *
 */
public interface Executor {

    /**
     * Schedules execution of given command as soon as possible.
     * @param commandName - FQCN of the command
     * @param ctx - contextual data given by executor service
     * @return unique identifier of the request
     */
    Long scheduleRequest(String commandName, CommandContext ctx);

    /**
     * Schedules execution of given command on defined time.
     * @param commandName  - FQCN of the command
     * @param date - date at which given command shall be executed
     * @param ctx - contextual data given by executor service
     * @return unique identifier of the request
     */
    Long scheduleRequest(String commandName, Date date, CommandContext ctx);

    /**
     * Cancels active (queued, running or retrying) request
     * @param requestId - id of the request to cancel
     */
    void cancelRequest(Long requestId);

    /**
     * @return configured interval at which executor threads are running
     */
    int getInterval();

    /**
     * Sets interval at which executor threads are running.
     * Should not be used after init method has been called.
     * @param waitTime
     */
    void setInterval(int waitTime);

    /**
     * @return configured default number of retries that shall be attempted in case of an error
     */
    int getRetries();

    /**
     * Sets default number of retries that shall be attempted in case of an error.
     * Should not be used after init method has been called.
     * @param defaultNroOfRetries
     */
    void setRetries(int defaultNroOfRetries);

    /**
     * @return configured executor thread pool size
     */
    int getThreadPoolSize();

    /**
     * Sets default executor thread pool size. Should not be used after init method has been called.
     * @param nroOfThreads
     */
    void setThreadPoolSize(int nroOfThreads);

    /**
     * @return time unit configured for executor intervals
     */
    TimeUnit getTimeunit();

    /**
     * Sets time unit for executor intervals
     * @param timeunit
     */
    void setTimeunit(TimeUnit timeunit);

    /**
     * Initialized executor
     */
    void init();

    /**
     * Destroys executor
     */
    void destroy();
    
    /**
     * Updates request data by merging existing (if any) with given. Only allowed for not completed requests (including those in error state).
     * @param requestId unique id of the request to be updated
     * @param data data to be set on the job
     */
    void updateRequestData(Long requestId, Map data);
}