com.netflix.ndbench.api.plugin.NdBenchClient Maven / Gradle / Ivy

Go to download
/*
 *  Copyright 2016 Netflix, 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.netflix.ndbench.api.plugin;

/**
 * @author vchella
 */
 public interface NdBenchClient extends NdBenchAbstractClient {

	/**
	 * Initialize the client
	 * @throws Exception
	 */
	 void init(DataGenerator dataGenerator) throws Exception;
	
	/**
	 * Perform a single read operation
	 * @return
	 * @throws Exception
	 */
	 String readSingle(final String key) throws Exception;


	/**
	 * Perform a single write operation
	 * @return
	 * @throws Exception
	 */
	 String writeSingle(final String key) throws Exception;


    /**
     * shutdown the client
     */
     void shutdown() throws Exception;

    /**
     * Get connection info
     */
     String getConnectionInfo() throws Exception;

    /**
     * Run workflow for functional testing
     * @throws Exception
     */
     String runWorkFlow() throws Exception;

}