org.kie.kogito.timer.TimerService Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of kogito-timer Show documentation

Timer API to schedule jobs

The newest version!

/*
 * 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.kie.kogito.timer;

import java.util.Collection;

import org.kie.kogito.timer.impl.TimerJobFactoryManager;
import org.kie.kogito.timer.impl.TimerJobInstance;

/**
 * An interface for all timer service implementations used in a drools session.
 */
public interface TimerService extends SchedulerService {

    /**
     * Returns the current time from the scheduler clock
     * 
     * @return the current timestamp
     */
    long getCurrentTime();

    /**
     * Reset this service
     */
    void reset();

    /**
     * Shuts the service down
     */
    void shutdown();

    /**
     * Returns the number of time units (usually ms) to
     * the next scheduled job
     * 
     * @return the number of time units until the next scheduled job or -1 if
     *         there is no job scheduled
     */
    long getTimeToNextJob();

    /**
     * This method may return null for some TimerService implementations that do not want the overhead of maintain this.
     * 
     * @return
     */
    Collection getTimerJobInstances(long id);

    void setTimerJobFactoryManager(TimerJobFactoryManager timerJobFactoryManager);

    TimerJobFactoryManager getTimerJobFactoryManager();
}