com.basho.riak.client.raw.RiakClientFactory Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of riak-client Show documentation

HttpClient-based client for Riak

There is a newer version: 2.1.1

/*
 * This file is provided 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 com.basho.riak.client.raw;

import java.io.IOException;

import com.basho.riak.client.raw.config.Configuration;

/**
 * Top level interface for {@link RawClient} factories
 * 
 * @author russell
 */
public interface RiakClientFactory {

    /**
     * Is the concrete factory able to create {@link RawClient}s with
     * configClass {@link Configuration}s?
     * 
     * Call before newClient.
     * 
     * @param configClass
     *            the {@link Configuration} implementation
     * @return true if this factory can create a {@link RawClient} for the
     *         configClass false otherwise
     */
    public boolean accepts(Class configClass);

    /**
     * Create a new {@link RawClient} instance configured by config
     * 
     * @param config
     *            a specific implementation of {@link Configuration}
     * @return the configured RawClient
     */
    public RawClient newClient(Configuration config) throws IOException;
}