org.vrspace.server.object
Class WebGate

java.lang.Object
  extended byjava.util.Observable
      extended byorg.vrspace.server.VRObject
          extended byorg.vrspace.server.DBObject
              extended byorg.vrspace.server.PublicDBObject
                  extended byorg.vrspace.server.OwnedDBObject
                      extended byorg.vrspace.server.object.File
                          extended byorg.vrspace.server.object.VrmlFile
                              extended byorg.vrspace.server.object.WebGate
All Implemented Interfaces:
java.lang.Cloneable, HasTransform, java.util.Observer, Owned

public class WebGate
extends VrmlFile

WebGate to another host. This object uses a dynamic web page server to handle the act of transferring a VRSpace user to another space.


Nested Class Summary
 
Nested classes inherited from class org.vrspace.server.object.VrmlFile
VrmlFile.ParsedUploadFilter
 
Nested classes inherited from class org.vrspace.server.object.File
File.GZippedUploadFilter, File.UploadFilter
 
Field Summary
 java.lang.String author
          Author of the target space.
 boolean autoCommit
          Not implemented.
 java.lang.String description
          Description of the target space.
 java.lang.String dynamicPageURL
          Absolute URL for the dynamic web page implementing the WebGate.
 boolean online
          Whether server behind this Gate is online.
 java.lang.String port
          Port on which the target space's server is listening.

The distribution uses port 8500 by default.
 boolean remove
          Not implemented.
 java.lang.String screen
          URL of the image used to represent that the target space's server is online.
 java.lang.String vrmlFile
          The main vrml file of the target space.
 
Fields inherited from class org.vrspace.server.object.VrmlFile
transform
 
Fields inherited from class org.vrspace.server.object.File
_downloads, _lastUpdate, _uploads, name, ownerRole, publicRole, url
 
Fields inherited from class org.vrspace.server.DBObject
db
 
Fields inherited from class org.vrspace.server.VRObject
db_id, primitiveMap, primitives
 
Constructor Summary
WebGate()
           
 
Method Summary
 void set__enter(Request r, java.lang.String args)
          Handles a user's request to be transferred by the WebGate.
 
Methods inherited from class org.vrspace.server.object.VrmlFile
createTransform, getTransform, getTransformID, set__clone, set_download, set_upload, set_url, setTransform, update
 
Methods inherited from class org.vrspace.server.object.File
encodeAsURI, getClassAndId, grantAccess, processEvent, sendEvent, setValue
 
Methods inherited from class org.vrspace.server.OwnedDBObject
addOwner, isOwned, notifyOwners, ownershipRequired, removeOwner
 
Methods inherited from class org.vrspace.server.DBObject
delete, get, put, put
 
Methods inherited from class org.vrspace.server.VRObject
arrayToString, canRead, canWrite, clone, equals, fieldToText, fromString, fromText, getClassName, getField, getFields, getId, getID, getMemebers, hasField, hasMethod, isNew, newInstance, sendResponse, setField, setField, setField, setFields, setFields, stringToArray, toString, toText, toText, toText
 
Methods inherited from class java.util.Observable
addObserver, clearChanged, countObservers, deleteObserver, deleteObservers, hasChanged, notifyObservers, notifyObservers, setChanged
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

author

public java.lang.String author
Author of the target space.


description

public java.lang.String description
Description of the target space.


screen

public java.lang.String screen
URL of the image used to represent that the target space's server is online.


dynamicPageURL

public java.lang.String dynamicPageURL
Absolute URL for the dynamic web page implementing the WebGate. Given the standard distribution of VRSpace on www.foo.com, with a JSP Engine listening on port 8500, the url would be http://www.foo.com:8080/vrspace/vrspace.jsp.

For the purposes of testing the server, the default value for this variable is http://localhost:8080/vrspace/vrspace.jsp.


vrmlFile

public java.lang.String vrmlFile
The main vrml file of the target space. This URL is relative to the URL specified in dynamicPageURL.

The distribution comes with VRSpace.wrl as the main vrml file. If no value is set for this variable, VRSpace.wrl will be used.


port

public java.lang.String port
Port on which the target space's server is listening.

The distribution uses port 8500 by default. If no value is set for the variable, 8500 will be assumed.


online

public boolean online
Whether server behind this Gate is online. Set on last enter attemt, default: true


remove

public boolean remove
Not implemented. Whether ProxyDispatcher behind this Gate should remove cached objects from the local database. If true, objects are removed only if not observed. False means keep local copy of remote database persistent - refresh occurs whenever local Admin sees remote objects. Default: false

See Also:
ProxyDispatcher

autoCommit

public boolean autoCommit
Not implemented. Whether ProxyDispatcher should commit database after each Add/Remove. Default: true

See Also:
ProxyDispatcher, Remove, Add
Constructor Detail

WebGate

public WebGate()
Method Detail

set__enter

public void set__enter(Request r,
                       java.lang.String args)
                throws java.lang.Exception
Handles a user's request to be transferred by the WebGate. If any error occurs during transfer, the online variable for the gate is set to false and an exception is thrown. Otherwise, it is set to true.

Throws:
java.lang.Exception