livespace.services.entities
Class ScreenConnection

java.lang.Object
  extended by dsto.dfc.databeans.AbstractDataObject
      extended by dsto.dfc.databeans.SimpleDataObject
          extended by dsto.dfc.databeans.FancyDataObject
              extended by livespace.services.Entity
                  extended by livespace.services.entities.ScreenConnection
All Implemented Interfaces:
IDataObject, IDataObjectChildListener, Cloneable

public class ScreenConnection
extends Entity

Entity to represent a screen sharing connection between a client and a server. The connection may be implemented by a variety of protocols, including VNC and Virtual Terminal.

Version:
$Revision$
Author:
WeberD

Field Summary
 String clientId
          The ID of the computer hosting the screen-sharing client.
 String clientIP
          The IP address of the computer hosting the screen-sharing client.
 IDataBean config
          A data structure of the configuration for this connection.
static String ENTITY_TYPE
           
 String initiator
          The ID of the computer hosting initiating screen-sharing connection.
 String initiatorIP
          The IP address of the computer hosting initiating screen-sharing connection.
 String serverId
          The ID of the computer hosting the screen-sharing server.
 String serverIP
          The IP address of the computer hosting the screen-sharing server.
 int windowID
          If non-zero, this value is the window ID of a specific window on the server to be shared rather than the server's entire screen.
 
Fields inherited from class livespace.services.Entity
container, id, lastTouched, name, unconfirmedUpdates
 
Fields inherited from class dsto.dfc.databeans.AbstractDataObject
listeners
 
Fields inherited from interface dsto.dfc.databeans.IDataObject
OVERRIDE, PERSISTENT, PERSISTENT_OVERRIDE, TRANSIENT, TRANSIENT_OVERRIDE
 
Constructor Summary
ScreenConnection()
           
ScreenConnection(String id)
           
ScreenConnection(String id, String name)
           
 
Method Summary
 String getType()
          The type of the object (eg "room", "light", "volume", etc).
 
Methods inherited from class livespace.services.Entity
create, createId, getElvin, getType, getTypeInfo, mutex, sameEntity, shallowClone, waitForProperty, waitForProperty, waitForProperty, waitForProperty
 
Methods inherited from class dsto.dfc.databeans.FancyDataObject
childPropertyChanged, getValue, isTransient, propertyIterator, setValue
 
Methods inherited from class dsto.dfc.databeans.SimpleDataObject
getFieldNames, setValue
 
Methods inherited from class dsto.dfc.databeans.AbstractDataObject
addFirstPropertyListener, addPropertyListener, firePropertyChangedEvent, firePropertyChangedEvent, firePropertyChangedEvent, firePropertyChangedEvent, firePropertyChangedEvent, firePropertyChangedEvent, getBeanValue, getBooleanValue, getBooleanValue, getCharValue, getCharValue, getDoubleValue, getDoubleValue, getFloatValue, getFloatValue, getIntValue, getIntValue, getLongValue, getLongValue, getObjectValue, getPropertyListeners, getShortValue, getStringValue, registerValue, removePropertyListener, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, toString, unregisterValue
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

ENTITY_TYPE

public static final String ENTITY_TYPE
See Also:
Constant Field Values

serverId

public String serverId
The ID of the computer hosting the screen-sharing server.


serverIP

public String serverIP
The IP address of the computer hosting the screen-sharing server.


windowID

public int windowID
If non-zero, this value is the window ID of a specific window on the server to be shared rather than the server's entire screen. Note that currently only the VT protocol supports window-level sharing (via the -t option on the VT server command line.)


clientId

public String clientId
The ID of the computer hosting the screen-sharing client.


clientIP

public String clientIP
The IP address of the computer hosting the screen-sharing client.


initiator

public String initiator
The ID of the computer hosting initiating screen-sharing connection.


initiatorIP

public String initiatorIP
The IP address of the computer hosting initiating screen-sharing connection.


config

public IDataBean config
A data structure of the configuration for this connection.

Constructor Detail

ScreenConnection

public ScreenConnection()

ScreenConnection

public ScreenConnection(String id)

ScreenConnection

public ScreenConnection(String id,
                        String name)
Method Detail

getType

public String getType()
Description copied from class: Entity
The type of the object (eg "room", "light", "volume", etc). This must be unique to the entity class.

NOTE: it is also a good practice to provide a static field that defines the entity type on the class: eg

 public static final String ENTITY_TYPE = "room";
 

Specified by:
getType in class Entity


Copyright © 2008 Commonwealth of Australia