/*******************************************************************************
 * Copyright (c) 2004, 2007 Boeing.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *     Boeing - initial API and implementation
 *******************************************************************************/
package org.eclipse.osee.connection.service;

import java.io.File;
import java.io.Serializable;
import java.net.URI;
import java.net.UnknownHostException;
import java.rmi.server.ExportException;
import org.eclipse.osee.framework.jdk.core.util.EnhancedProperties;

/**
 * Provides a communication pipe to a service.
 * 
 * @author Ken J. Aguilar
 */
public interface IServiceConnector {

   String getConnectorType();

   /**
    * gets the service provided by this connector
    */
   Object getService();

   void setProperty(String key, Serializable value);

   Serializable getProperty(String property, Serializable defaultValue);

   void stop() throws Exception;

   /**
    * makes the callback accessible by this connector's service
    */
   Object export(Object callback) throws ExportException;

   void init(Object service) throws UnknownHostException, ExportException;

   /**
    * finds the matching exported representation of supplied object
    */
   Object findExport(Object callback);

   void unexport(Object callback) throws Exception;

   void addPropertyChangeListener(IServicePropertyChangeListener listener);

   void removePropertyChangeListener(IServicePropertyChangeListener listener);

   /**
    * uploads a file to a service and creates an {@link URI} that the service can access.
    */
   URI upload(File file) throws Exception;

   boolean ping();

   EnhancedProperties getProperties();

   public String getUniqueServerId();

   void setConnected(boolean b);
   boolean isConnected();
}