/**
 * Copyright 2016 LinkedIn Corp. All rights reserved.
 *
 * 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.
 */
package com.github.ambry.server;

import com.github.ambry.network.Request;
import java.io.IOException;


/**
 * This defines the server request API. The commands below are the requests that can be issued against the server
 */
public interface RequestAPI {
  /**
   * Puts a blob into the store. It accepts a blob property, user metadata and the blob
   * as a stream and stores them
   * @param request The request that contains the blob property, user metadata and blob as a stream
   * @throws IOException
   * @throws InterruptedException
   */
  void handlePutRequest(Request request) throws IOException, InterruptedException;

  /**
   * Gets blob property, user metadata or the blob from the specified partition
   * @param request The request that contains the partition and id of the blob whose blob property, user metadata or
   *                blob needs to be returned
   * @throws IOException
   * @throws InterruptedException
   */
  void handleGetRequest(Request request) throws IOException, InterruptedException;

  /**
   * Deletes the blob from the store
   * @param request The request that contains the partition and id of the blob that needs to be deleted
   * @throws IOException
   * @throws InterruptedException
   */
  void handleDeleteRequest(Request request) throws IOException, InterruptedException;

  /**
   * Gets the metadata required for replication
   * @param request The request that contains the partition for which the metadata is needed
   * @throws IOException
   * @throws InterruptedException
   */
  public void handleReplicaMetadataRequest(Request request) throws IOException, InterruptedException;
}