org.apache.jackrabbit.oak.api.jmx.CheckpointMBean Maven / Gradle / Ivy

Go to download

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

The Adobe Experience Manager SDK

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.apache.jackrabbit.oak.api.jmx;

import javax.management.openmbean.CompositeData;
import javax.management.openmbean.TabularData;

import org.osgi.annotation.versioning.ProviderType;

import java.util.Date;

/**
 * MBean for managing {@code org.apache.jackrabbit.oak.spi.state.NodeStore#checkpoint checkpoints}.
 */
@ProviderType
public interface CheckpointMBean {
    String TYPE = "CheckpointManager";

    /**
     * List the checkpoints that are currently present along with
     * its id, creation time and expiry time.
     * @return
     */
    TabularData listCheckpoints();

    /**
     * @return creation timestamp of oldest checkpoint.
     */
    long getOldestCheckpointCreationTimestamp();

    /**
     * @return creation date of oldest checkpoint.
     */
    Date getOldestCheckpointCreationDate();

    /**
     * Create a new checkpoint with the given {@code lifetime}.
     * See {@code org.apache.jackrabbit.oak.spi.state.NodeStore#checkpoint}
     * @param lifetime
     * @return the id of the newly created checkpoint
     */
    String createCheckpoint(long lifetime);

    /**
     * Release the checkpoint with the given {@code id}.
     * See {@code org.apache.jackrabbit.oak.spi.state.NodeStore#checkpoint}
     * @param id
     * @return  {@code true} on success, {@code false} otherwise.
     */
    boolean releaseCheckpoint(String id);
}