src/main/java/org/apache/sling/jcr/maintenance/internal/VersionCleanupMBean.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.sling.jcr.maintenance.internal;

import org.apache.jackrabbit.oak.api.jmx.Description;

/**
 * JMX MBean interface for the version cleanup tool to enable introspection into
 * the state of
 */

@Description("Cleanup versions")
public interface VersionCleanupMBean {

    @Description("Whether or not the service is running")
    boolean isRunning();

    @Description("Whether or not the service is failed")
    boolean isFailed();

    @Description("The last message")
    String getLastMessage();

    @Description("The count of the last cleaned versions")
    long getLastCleanedVersionsCount();

    @Description("Start running the job, will stop any running instances")
    void start();

    @Description("Stop the running instance or do nothing")
    void stop();

}