com.dasasian.chok.client.IIndexDeployFuture Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of chok-core Show documentation

There is a newer version: 1.7

/**
 * Copyright (C) 2014 Dasasian ([email protected])
 *
 * Licensed 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 com.dasasian.chok.client;

/**
 * Future for an index deployment.
 *
 * @see java.util.concurrent.Future for concept of a future
 */
public interface IIndexDeployFuture {

    /**
     * This method blocks until the index has been successfully deployed or the
     * deployment failed.
     * @return the index state
     * @throws java.lang.InterruptedException when interrupted
     */
    IndexState joinDeployment() throws InterruptedException;

    /**
     * This method blocks until the index has been successfully deployed or the
     * deployment failed or maxWaitMillis has exceeded.
     * @param maxWaitMillis maximum time to wait.
     * @return the index state
     * @throws java.lang.InterruptedException when interrupted
     */
    IndexState joinDeployment(long maxWaitMillis) throws InterruptedException;

    IndexState getState();

}