RemoteStore.java

/* $HeadURL::                                                                            $
 * $Id$
 *
 * Copyright (c) 2009-2010 DuraSpace
 * http://duraspace.org
 *
 * In collaboration with Topaz Inc.
 * http://www.topazproject.org
 *
 * 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 org.akubraproject.rmi.remote;

import java.io.IOException;

import java.rmi.Remote;
import java.rmi.RemoteException;

import java.util.Map;

/**
 * Represents a remote blob store.
 *
 * @author Pradeep Krishnan
 */
public interface RemoteStore extends Remote {
  /**
   * Open a non transactional connection on the remote blob-store.
   *
   * @param hints A set of hints to allow the implementation to optimize the operation (can be
   *              null)
   * @return a remote-connection handle
   *
   * @throws RemoteException on an RMI communication failure
   * @throws IOException on an error in opening a connection on the remote
   * @throws IllegalStateException if the remote is not ready to open up connections
   */
  public RemoteConnection openConnection(Map<String, String> hints)
      throws RemoteException, IOException, IllegalStateException;

  /**
   * Starts a Transaction listener on remote. The listener will stop after
   * opening a connection to the BlobStore.
   *
   * @param hints A set of hints for <code>openConnection</code>
   * @return a newly allocated transaction listener
   *
   * @throws RemoteException on an RMI communication failure
   */
  public RemoteTransactionListener startTransactionListener(Map<String, String> hints)
      throws RemoteException;
}