com.couchbase.client.java.cluster.api.ClusterApiClient Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of java-client
The official Couchbase Java SDK
There is a newer version: 3.7.7
/*
 * Copyright (c) 2016 Couchbase, Inc.
 *
 * 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.couchbase.client.java.cluster.api;

import java.util.concurrent.TimeUnit;

import com.couchbase.client.core.ClusterFacade;
import com.couchbase.client.core.annotations.InterfaceAudience;
import com.couchbase.client.core.annotations.InterfaceStability;
import com.couchbase.client.deps.io.netty.handler.codec.http.HttpMethod;

/**
 * An utility class to execute generic HTTP calls synchronously on a cluster's REST API.
 *
 * @author Simon Baslé
 * @since 2.3.2
 */
@InterfaceAudience.Public
@InterfaceStability.Experimental
public class ClusterApiClient extends AbstractClusterApiClient {


    private final long defaultTimeout;
    private final TimeUnit defaultTimeUnit;

    /**
     * Build a new {@link ClusterApiClient} to work with a given {@link ClusterFacade}.
     *
     * @param username the login to use for REST api calls (eg. administrative username).
     * @param password the password associated with the username.
     * @param core     the {@link ClusterFacade} through which to send requests.
     * @param defaultTimeout the default timeout duration to use when executing requests.
     * @param defaultTimeUnit the time unit for the timeout.
     */
    public ClusterApiClient(String username, String password, ClusterFacade core,
            long defaultTimeout, TimeUnit defaultTimeUnit) {
        super(username, password, core);
        this.defaultTimeout = defaultTimeout;
        this.defaultTimeUnit = defaultTimeUnit;
    }

    @Override
    protected RestBuilder createBuilder(HttpMethod method, String fullPath) {
        return new RestBuilder(new AsyncRestBuilder(this.username, this.password, this.core, method, fullPath),
                this.defaultTimeout, this.defaultTimeUnit);
    }

    /**
     * @return the default timeout duration used when executing requests that don't specify a timeout.
     */
    public long defaultTimeout() {
        return this.defaultTimeout;
    }

    /**
     * @return the default time unit used when executing requests that don't specify a timeout.
     */
    public TimeUnit defaultTimeUnit() {
        return this.defaultTimeUnit;
    }
}