trunk/oak-api/src/main/java/org/apache/jackrabbit/oak/api/jmx/IndexerMBean.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.jackrabbit.oak.api.jmx;


import java.io.IOException;

import org.osgi.annotation.versioning.ProviderType;
import org.apache.jackrabbit.oak.api.CommitFailedException;

@ProviderType
public interface IndexerMBean {
    String TYPE = "Indexer";

    boolean importIndex(
            @Name("indexDirPath")
            @Description("Path on server file system where index content generated by oak-run is present")
                    String indexDirPath) throws IOException, CommitFailedException;

    boolean importIndex(
            @Name("indexDirPath")
            @Description("Path on server file system where index content generated by oak-run is present")
                    String indexDirPath,
            @Name("ignoreLocalLock")
            @Description("Useful for importing generated content during startup when IndexMBean instances" +
                    " might not be available")
                    boolean ignoreLocalLock
            ) throws IOException, CommitFailedException;
}