nesstar.api
Class Server

java.lang.Object
  extended by java.util.Observable
      extended by nesstar.rdf.RDFObject
          extended by nesstar.api.Server
All Implemented Interfaces:
Comparable, RDFObj
Direct Known Subclasses:
ServerEx

public class Server
extends RDFObject

A server used to publish data and metadata. Code automatically generated from ARGO/UML


Field Summary
static String CLASS_ID
           
 
Fields inherited from class nesstar.rdf.RDFObject
COLSEP, IS_GETTER, IS_PART, IS_PART_OF, WRITE_OP
 
Constructor Summary
Server(RDFDB db, URL id)
          Create an object with the indicated id in the indicated db
 
Method Summary
 void clear()
          Clear all properties of this object
 RDFRef get_catalogs()
           
 String get_debug()
           
 String get_port()
           
 String get_revision()
           
 RDFRef get_services()
           
 String get_version()
           
static Vector getAllInstances()
           
static Vector getAllInstances(RDFDB db)
           
 List getCatalogs()
           
 String getDebug()
          The level of debugging: off disable the generation of debugging information on send debugging information a log file
static FeatureDescriptor getDescriptor(String featureName)
          get the descriptor for a feature of the class, either method or attribute Note: the methods' feature are still not implemented
 Bookmark GetFile(String serverPath)
           Get a File from the server;
 MIMEObject GetFile(String serverPath, BasicExecutorLog log)
           Get a File from the server;
static Collection getGetterMethods()
           
static Server getInstance(RDFDB db, URL id)
          If an object of type Server with the indicated id exists in the db returns it otherwise create a new object in the db and returns it
static Server getInstance(String rdf)
           
static Collection getPartsDescriptor()
           
 Integer getPort()
          The TCP/IP port on which the server listens for connections from the users, should be 80 or 8080 (this might conflict with a Web Server running on the same machine).
 Bookmark GetReport()
           
 String GetReport(BasicExecutorLog log)
           
 String getRevision()
          The server software revision code.
 List getServices()
          Additional services hosted by the server.
 String getVersion()
          The server software version name.
 void initialised()
          Notify that the object has been created and its properties setup for the first time.
static void listenForNewObj(NewObjListener listener)
          Register to be notified when new objects are added.
 Bookmark Login(String userID, String userPassword)
           
 void Login(String userID, String userPassword, BasicExecutorLog log)
           
static Server newInstance(RDFDB db)
          Create a new object of this type with a locally unique id and returns it
 Bookmark Reboot()
           
 void Reboot(BasicExecutorLog log)
           
static Server retrieve(URL id)
          If an object of type Server with the indicated id has already being retrieved from the network returns it otherwise retrieve it together with its class information (methods, properties, etc.)
 Bookmark SaveFile(String serverPath, File file)
           Save a file in the server;
 void SaveFile(String serverPath, File file, BasicExecutorLog log)
           Save a file in the server;
 Bookmark SaveWebFile(String webPath, File file)
           Save a file in the web root of the server
 void SaveWebFile(String webPath, File file, BasicExecutorLog log)
           Save a file in the web root of the server
 void set_catalogs(RDFRef catalogs)
           
 void set_debug(String debug)
           
 void set_port(String port)
           
 void set_revision(String revision)
           
 void set_services(RDFRef services)
           
 void set_version(String version)
           
 void setCatalogs(List catalogs)
           
 void setDebug(String debug)
          The level of debugging: off disable the generation of debugging information on send debugging information a log file
 void setPort(Integer port)
          The TCP/IP port on which the server listens for connections from the users, should be 80 or 8080 (this might conflict with a Web Server running on the same machine).
 void setRevision(String revision)
          The server software revision code.
 void setServices(List services)
          Additional services hosted by the server.
 void setVersion(String version)
          The server software version name.
 Bookmark Shutdown()
           
 void Shutdown(BasicExecutorLog log)
           
 Bookmark Update(File zippedCode)
           
 void Update(File zippedCode, BasicExecutorLog log)
           
 
Methods inherited from class nesstar.rdf.RDFObject
AddProperty, AddStringProperty, chkFinal, compareTo, dbg, equals, err, err, get_comment, get_creationDate, get_label, get, getAccessCondition, getBinding, getBindings, getBookmarkLabel, getCollectionURL, getComment, getCreationDate, getDB, getDescriptor, getDomain, getID, getInitialisedProperties, getInternalID, getLabel, getLastClear, getPartsDescriptor, getPartsDescriptor, getPath, getProperties, GetProperties, GetProperty, GetPropertyStatement, GetPropertyStatements, getRange, getRangeType, getRef, getRef, getServer, getShortId, getShortID, getStatementHome, GetStringProperties, GetStringProperty, getTimeoutInSecs, getType, init, init, isComplete, isLocal, isMeta, isStale, loaded, neededCollectionReload, neededReload, neededReload, neededReload, neededReload, needsReload, reload, remove, set_comment, set_complete, set_creationDate, set_label, set, setComment, setComplete, setCreationDate, setDB, setHardOrSoft, setID, setLabel, setLastClear, SetProperty, setServer, SetStringProperty, setTimeoutInSecs, setTimestamp, setType, setTypeID, stale, toRDF, toRDFWrapped, toString, update
 
Methods inherited from class java.util.Observable
addObserver, countObservers, deleteObserver, deleteObservers, hasChanged, notifyObservers, notifyObservers
 
Methods inherited from class java.lang.Object
getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

CLASS_ID

public static String CLASS_ID
Constructor Detail

Server

public Server(RDFDB db,
              URL id)
       throws Exception
Create an object with the indicated id in the indicated db

Parameters:
db - the db where the object is to be created
id - the id of the object to create
Throws:
Exception
Method Detail

set_catalogs

public void set_catalogs(RDFRef catalogs)
Parameters:
catalogs -

setCatalogs

public void setCatalogs(List catalogs)
                 throws Exception
Parameters:
catalogs -
Throws:
Exception

setDebug

public void setDebug(String debug)
The level of debugging:
off
disable the generation of debugging information
on
send debugging information a log file

Parameters:
debug -

set_debug

public void set_debug(String debug)
Parameters:
debug -

setPort

public void setPort(Integer port)
The TCP/IP port on which the server listens for connections from the users, should be 80 or 8080 (this might conflict with a Web Server running on the same machine).

Parameters:
port -

set_port

public void set_port(String port)
Parameters:
port -

setRevision

public void setRevision(String revision)
The server software revision code.

This corresponds to the date the software was recompiled the last time.

Parameters:
revision -

set_revision

public void set_revision(String revision)
Parameters:
revision -

setVersion

public void setVersion(String version)
The server software version name.

Parameters:
version -

set_version

public void set_version(String version)
Parameters:
version -

setServices

public void setServices(List services)
                 throws Exception
Additional services hosted by the server.

Parameters:
services -
Throws:
Exception

set_services

public void set_services(RDFRef services)
Parameters:
services -

getAllInstances

public static Vector getAllInstances(RDFDB db)
                              throws Exception
Parameters:
db - the db where the instances are to be found
Returns:
all the instances of this class in the database
Throws:
Exception

getAllInstances

public static Vector getAllInstances()
                              throws Exception
Returns:
get all the instances of this class from the default database
Throws:
Exception

getInstance

public static Server getInstance(RDFDB db,
                                 URL id)
                          throws Exception
If an object of type Server with the indicated id exists in the db returns it otherwise create a new object in the db and returns it

Parameters:
db - the db where the object is to be found or created
id - the id of the object to retrieve or create
Returns:
an object of type Server with the indicated id and existing in the indicated db
Throws:
Exception

getInstance

public static Server getInstance(String rdf)
                          throws Exception
Parameters:
rdf - some rdf code that contains a description of an object of this kind
Returns:
the single instance of this class described in the passed RDF code
Throws:
Exception

get_catalogs

public RDFRef get_catalogs()
                    throws Exception
Throws:
Exception

getCatalogs

public List getCatalogs()
                 throws Exception
Returns:
Throws:
Exception

getDebug

public String getDebug()
The level of debugging:
off
disable the generation of debugging information
on
send debugging information a log file


get_debug

public String get_debug()
                 throws Exception
Throws:
Exception

getPort

public Integer getPort()
The TCP/IP port on which the server listens for connections from the users, should be 80 or 8080 (this might conflict with a Web Server running on the same machine).


get_port

public String get_port()
                throws Exception
Throws:
Exception

getRevision

public String getRevision()
The server software revision code.

This corresponds to the date the software was recompiled the last time.


get_revision

public String get_revision()
                    throws Exception
Throws:
Exception

getVersion

public String getVersion()
The server software version name.


get_version

public String get_version()
                   throws Exception
Throws:
Exception

getServices

public List getServices()
                 throws Exception
Additional services hosted by the server.

Throws:
Exception

get_services

public RDFRef get_services()
                    throws Exception
Throws:
Exception

GetReport

public Bookmark GetReport()
                   throws Exception
Throws:
Exception

GetReport

public String GetReport(BasicExecutorLog log)
                 throws Exception
Parameters:
log - the Executor of this method;if null a default one is used
Throws:
Exception

GetFile

public Bookmark GetFile(String serverPath)
                 throws Exception

Get a File from the server;

A temporary file is created before to return the requested file

Parameters:
serverPath -
Throws:
Exception

GetFile

public MIMEObject GetFile(String serverPath,
                          BasicExecutorLog log)
                   throws Exception

Get a File from the server;

A temporary file is created before to return the requested file

Parameters:
serverPath -
log - the Executor of this method;if null a default one is used
Throws:
Exception

getDescriptor

public static FeatureDescriptor getDescriptor(String featureName)
get the descriptor for a feature of the class, either method or attribute Note: the methods' feature are still not implemented

Parameters:
featureName -

getPartsDescriptor

public static Collection getPartsDescriptor()
Returns:
the descriptor of the attribute that are part of the class

getGetterMethods

public static Collection getGetterMethods()
Returns:
the descriptor of the attribute that are part of the class

newInstance

public static Server newInstance(RDFDB db)
                          throws Exception
Create a new object of this type with a locally unique id and returns it

Parameters:
db - the db where the object is to be found or created
Returns:
an object of this type
Throws:
Exception

listenForNewObj

public static void listenForNewObj(NewObjListener listener)
Register to be notified when new objects are added.

Parameters:
listener - the listener

initialised

public void initialised()
Notify that the object has been created and its properties setup for the first time. This is NOT called when the object is simply reloaded.

Overrides:
initialised in class RDFObject

retrieve

public static Server retrieve(URL id)
                       throws Exception
If an object of type Server with the indicated id has already being retrieved from the network returns it otherwise retrieve it together with its class information (methods, properties, etc.)

Parameters:
id - the id of the object to retrieve
Returns:
an object of type Server with the indicated id
Throws:
Exception

clear

public void clear()
Description copied from class: RDFObject
Clear all properties of this object

Overrides:
clear in class RDFObject

Login

public Bookmark Login(String userID,
                      String userPassword)
               throws Exception
Parameters:
userID -
userPassword -
Throws:
Exception

Login

public void Login(String userID,
                  String userPassword,
                  BasicExecutorLog log)
           throws Exception
Parameters:
userID -
userPassword -
log - the Executor of this method;if null a default one is used
Throws:
Exception

Reboot

public Bookmark Reboot()
                throws Exception
Throws:
Exception

Reboot

public void Reboot(BasicExecutorLog log)
            throws Exception
Parameters:
log - the Executor of this method;if null a default one is used
Throws:
Exception

Shutdown

public Bookmark Shutdown()
                  throws Exception
Throws:
Exception

Shutdown

public void Shutdown(BasicExecutorLog log)
              throws Exception
Parameters:
log - the Executor of this method;if null a default one is used
Throws:
Exception

Update

public Bookmark Update(File zippedCode)
                throws Exception
Parameters:
zippedCode -
Throws:
Exception

Update

public void Update(File zippedCode,
                   BasicExecutorLog log)
            throws Exception
Parameters:
zippedCode -
log - the Executor of this method;if null a default one is used
Throws:
Exception

SaveFile

public Bookmark SaveFile(String serverPath,
                         File file)
                  throws Exception

Save a file in the server;

if the file already exists, a backup copy is created with name fileName.# with # = 1..n

Parameters:
serverPath -
file - the file to be saved
Throws:
Exception

SaveFile

public void SaveFile(String serverPath,
                     File file,
                     BasicExecutorLog log)
              throws Exception

Save a file in the server;

if the file already exists, a backup copy is created with name fileName.# with # = 1..n

Parameters:
serverPath -
file - the file to be saved
log - the Executor of this method;if null a default one is used
Throws:
Exception

SaveWebFile

public Bookmark SaveWebFile(String webPath,
                            File file)
                     throws Exception

Save a file in the web root of the server

if the file already exists, a backup copy is created with name fileName.# with # = 1..n

Parameters:
webPath - the path on the server relative to the web root
file - the file to be saved
Throws:
Exception

SaveWebFile

public void SaveWebFile(String webPath,
                        File file,
                        BasicExecutorLog log)
                 throws Exception

Save a file in the web root of the server

if the file already exists, a backup copy is created with name fileName.# with # = 1..n

Parameters:
webPath - the path on the server relative to the web root
file - the file to be saved
log - the Executor of this method;if null a default one is used
Throws:
Exception

Nesstar SDK

Copyright©2003 NSD - All Rights Reserved