Remote System Explorer DataStore
Release 3.4

org.eclipse.dstore.core.server
Class ConnectionEstablisher

java.lang.Object
  extended by org.eclipse.dstore.core.server.ConnectionEstablisher

public class ConnectionEstablisher
extends Object

ConnectionEstablisher is responsible for managing the server DataStore and facilitating the communication between client and server DataStores.

Since:
3.0 moved from non-API to API

Constructor Summary
ConnectionEstablisher()
          Creates the default ConnectionEstablisher.
ConnectionEstablisher(String port)
          Creates a ConnectionEstablisher.
ConnectionEstablisher(String port, int backlog, InetAddress bindAddr, String timeout, String ticket)
          Creates a ConnectionEstablisher.
ConnectionEstablisher(String port, String timeout)
          Creates a ConnectionEstablisher.
ConnectionEstablisher(String port, String timeout, String ticket)
          Creates a ConnectionEstablisher.
 
Method Summary
 void finished(ServerReceiver receiver)
          Tells the connection establisher to clean up and shutdown
 DataStore getDataStore()
          Returns the DataStore.
 int getServerPort()
          Return the Server port opened for this client
 String getStatus()
          Return the connection status for this client * @return the connection status for this client
 void start()
          Starts the run loop for the ConnectionEstablisher.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ConnectionEstablisher

public ConnectionEstablisher()
Creates the default ConnectionEstablisher. Communication occurs on a default port, there is no timeout and no ticket is required for a client to work with the DataStore.


ConnectionEstablisher

public ConnectionEstablisher(String port)
Creates a ConnectionEstablisher. Communication occurs on the specified port, there is no timeout and no ticket is required for a client to work with the DataStore.

Parameters:
port - the number of the socket port

ConnectionEstablisher

public ConnectionEstablisher(String port,
                             String timeout)
Creates a ConnectionEstablisher. Communication occurs on the specified port, a timeout value indicates the idle wait time before shutting down, and no ticket is required for a client to work with the DataStore.

Parameters:
port - the number of the socket port
timeout - the idle duration to wait before shutting down

ConnectionEstablisher

public ConnectionEstablisher(String port,
                             String timeout,
                             String ticket)
Creates a ConnectionEstablisher. Communication occurs on the specified port, a timeout value indicates the idle wait time before shutting down, and ticket specified the required ticket for a client to present in order to work with the DataStore.

Parameters:
port - the number of the socket port
timeout - the idle duration to wait before shutting down
ticket - validation id required by the client to access the DataStore

ConnectionEstablisher

public ConnectionEstablisher(String port,
                             int backlog,
                             InetAddress bindAddr,
                             String timeout,
                             String ticket)
Creates a ConnectionEstablisher. Communication occurs on the specified port and the specified IP address, a timeout value indicates the idle wait time before shutting down, and ticket specified the required ticket for a client to present in order to work with the DataStore.

Parameters:
port - the number of the socket port
backlog - listen backlog
bindAddr - the local IP address to bind to
timeout - the idle duration to wait before shutting down
ticket - validation id required by the client to access the DataStore
Since:
3.2
Method Detail

start

public void start()
Starts the run loop for the ConnectionEstablisher.


getDataStore

public DataStore getDataStore()
Returns the DataStore.

Returns:
the DataStore

getServerPort

public int getServerPort()
Return the Server port opened for this client

Returns:
the Server port opened for this client

getStatus

public String getStatus()
Return the connection status for this client * @return the connection status for this client


finished

public void finished(ServerReceiver receiver)
Tells the connection establisher to clean up and shutdown


Remote System Explorer DataStore
Release 3.4

Copyright (c) IBM Corporation and others 2000, 2012. All Rights Reserved.