api/src/main/java/org/apache/karaf/decanter/api/Scheduler.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.karaf.decanter.api;

/**
 * Control the Decanter scheduler.
 */
public interface Scheduler {

    /**
     * Start the Decanter scheduler.
     *
     * @throws Exception in case of startup failure.
     */
    public void start() throws Exception;

    /**
     * Stop the Decanter scheduler.
     *
     * @throws Exception in case of stopping failure.
     */
    public void stop() throws Exception;

    /**
     * Return true if the scheduler is started, false else.
     *
     * @return true if the schedule is started, false else.
     * @throws Exception
     */
    public boolean isStarted() throws Exception;

    /**
     * Get the current status of the scheduler.
     *
     * @return the current scheduler status.
     * @throws Exception in case of state retrieval failure.
     */
    public String state() throws Exception;

}