org.apache.camel.spi.PeriodTaskScheduler Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of camel-api Show documentation

The Camel API

There is a newer version: 4.9.0

/*
 * 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.camel.spi;

/**
 * A shared scheduler to run small period tasks, such as updating internal statistics, or for custom components to have
 * a background task.
 *
 * For example the AWS vault is using this to periodically check for secrets refreshed in AWS to trigger Camel to reload
 * to use the updated secrets.
 */
public interface PeriodTaskScheduler {

    /**
     * Schedules the period task.
     *
     * @param task   the period task (the task can extend {@link org.apache.camel.support.service.ServiceSupport} to
     *               have lifecycle)
     * @param period the interval (approximate) in millis, between running the task
     */
    void schedulePeriodTask(Runnable task, long period);

    /**
     * Gets an existing task by a given type, assuming there is only one task of the given type.
     *
     * @param  type the type of the task
     * @return      the task, or null if no tasks exists
     */
     T getTaskByType(Class type);

}