org.mbari.siam.distributed.portal
Interface PortalProxy

All Superinterfaces:
java.rmi.Remote
All Known Subinterfaces:
MooringPortalProxy
All Known Implementing Classes:
PortalTest

public interface PortalProxy
extends java.rmi.Remote

Proxy for PortalServer, which is a "gateway" between a low-bandwidth/intermittent node, and off-platform clients.

Author:
Tom O'Reilly

Field Summary
static long ASAP
          Indicates "send command as soon as possible".
static long WHENEVER
          Indicates "send command, no matter how late.
 
Method Summary
 boolean connected()
          Returns true if communication link is up.
 DevicePacketStream getDevicePacketStream(Authentication auth)
          Get DevicePacketStream for all sensors.
 DevicePacketStream getDevicePacketStream(long sensorID, Authentication auth)
          Get DevicePacketStream for specified sensor.
 long getId()
          Unique identifier of platform
 java.lang.String getName()
          Name of service
 java.lang.String getPortalHostName()
          Name of portal host
 Port[] getPortConfiguration()
          Return port information for node
 java.util.Vector getQueuedCommands()
          Return QueuedCommands which haven't been sent to platform yet.
 java.util.Vector getSentCommands()
          Return QueuedCommands which have already been sent to platform.
 int getStatus()
          Status of platform.
 long nextConnectTime()
          Returns true of next communication link.
 void nodeLinkConnected()
          Notify portal that link to remote node is "up".
 void nodeLinkDisconnecting(long nextConnectTime)
          Notify portal that link to remote node is about to be disconnected.
 

Field Detail

ASAP

static final long ASAP
Indicates "send command as soon as possible".

See Also:
Constant Field Values

WHENEVER

static final long WHENEVER
Indicates "send command, no matter how late.

See Also:
Constant Field Values
Method Detail

getName

java.lang.String getName()
                         throws java.rmi.RemoteException
Name of service

Throws:
java.rmi.RemoteException

getPortalHostName

java.lang.String getPortalHostName()
                                   throws java.rmi.RemoteException
Name of portal host

Throws:
java.rmi.RemoteException

getId

long getId()
           throws java.rmi.RemoteException
Unique identifier of platform

Throws:
java.rmi.RemoteException

connected

boolean connected()
                  throws java.rmi.RemoteException
Returns true if communication link is up.

Throws:
java.rmi.RemoteException

getStatus

int getStatus()
              throws java.rmi.RemoteException
Status of platform.

Throws:
java.rmi.RemoteException

nextConnectTime

long nextConnectTime()
                     throws java.rmi.RemoteException
Returns true of next communication link.

Throws:
java.rmi.RemoteException

getDevicePacketStream

DevicePacketStream getDevicePacketStream(Authentication auth)
                                         throws java.rmi.RemoteException,
                                                AuthenticationException
Get DevicePacketStream for all sensors.

Throws:
java.rmi.RemoteException
AuthenticationException

getDevicePacketStream

DevicePacketStream getDevicePacketStream(long sensorID,
                                         Authentication auth)
                                         throws java.rmi.RemoteException,
                                                DeviceNotFound,
                                                AuthenticationException
Get DevicePacketStream for specified sensor.

Throws:
java.rmi.RemoteException
DeviceNotFound
AuthenticationException

getPortConfiguration

Port[] getPortConfiguration()
                            throws java.rmi.RemoteException,
                                   UnknownConfiguration
Return port information for node

Throws:
java.rmi.RemoteException
UnknownConfiguration

getQueuedCommands

java.util.Vector getQueuedCommands()
                                   throws java.rmi.RemoteException
Return QueuedCommands which haven't been sent to platform yet.

Throws:
java.rmi.RemoteException

getSentCommands

java.util.Vector getSentCommands()
                                 throws java.rmi.RemoteException
Return QueuedCommands which have already been sent to platform.

Throws:
java.rmi.RemoteException

nodeLinkConnected

void nodeLinkConnected()
                       throws java.rmi.RemoteException
Notify portal that link to remote node is "up". This method will likely be replaced by Rendezvous mechanisms.

Throws:
java.rmi.RemoteException

nodeLinkDisconnecting

void nodeLinkDisconnecting(long nextConnectTime)
                           throws java.rmi.RemoteException
Notify portal that link to remote node is about to be disconnected.

Throws:
java.rmi.RemoteException


Copyright © 2003 MBARI.

The Monterey Bay Aquarium Research Institute (MBARI) provides this documentation and code "as is", with no warranty, express or implied, of its quality or consistency. It is provided without support and without obligation on the part of MBARI to assist in its use, correction, modification, or enhancement.