/**
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * 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 org.apache.hadoop.io.retry;

import java.io.IOException;

import org.apache.hadoop.ipc.RemoteException;
import org.apache.hadoop.ipc.StandbyException;

public interface UnreliableInterface {
  
  public static class UnreliableException extends Exception {
    private static final long serialVersionUID = 1L;

    private String identifier;
    
    public UnreliableException() {
      // no body
    }
    
    public UnreliableException(String identifier) {
      this.identifier = identifier;
    }
    
    @Override
    public String getMessage() {
      return identifier;
    }
  }
  
  public static class FatalException extends UnreliableException {
    private static final long serialVersionUID = 1L;
    // no body
  }
  
  void alwaysSucceeds() throws UnreliableException;
  
  void alwaysFailsWithFatalException() throws FatalException;
  void alwaysFailsWithRemoteFatalException() throws RemoteException;

  void failsOnceWithIOException() throws IOException;
  void failsOnceWithRemoteException() throws RemoteException;

  void failsOnceThenSucceeds() throws UnreliableException;
  boolean failsOnceThenSucceedsWithReturnValue() throws UnreliableException;

  void failsTenTimesThenSucceeds() throws UnreliableException;
  
  public String succeedsOnceThenFailsReturningString()
      throws UnreliableException, StandbyException, IOException;
  @Idempotent
  public String succeedsOnceThenFailsReturningStringIdempotent()
      throws UnreliableException, StandbyException, IOException;
  public String succeedsTenTimesThenFailsReturningString()
      throws UnreliableException, StandbyException, IOException;
  
  @Idempotent
  public String failsIfIdentifierDoesntMatch(String identifier)
      throws UnreliableException, StandbyException, IOException;

  void nonIdempotentVoidFailsIfIdentifierDoesntMatch(String identifier)
      throws UnreliableException, StandbyException, IOException;
}