arlut.csd.ganymede
Interface adminSession

All Superinterfaces:

java.rmi.Remote

All Known Implementing Classes:

GanymedeAdmin

public interface adminSession

extends java.rmi.Remote

adminSession is an RMI interface to the Ganymede server's GanymedeAdmin class. adminSession is the remote interface used by the admin console to send system commands to the Ganymede server.

Method Summary

ReturnVal	disableTask(java.lang.String name) Causes a registered task to be made ineligible for execution until enableTask() is called.
ReturnVal	dumpDB() dump the current state of the db to disk
SchemaEdit	editSchema() lock the server and edit the schema
ReturnVal	enableTask(java.lang.String name) Causes a task that was temporarily disabled by disableTask() to be available for execution again.
ReturnVal	forceBuild() This method is called by admin console code to force a complete rebuild of all external builds.
ReturnVal	kill(java.lang.String user) Kick a user off of the Ganymede server on behalf of this admin console
ReturnVal	killAll() Kick all users off of the Ganymede server on behalf of this admin console
void	logout() Disconnect the remote admin console associated with this object
void	refreshMe() This method lets the admin console explicitly request a refresh.
ReturnVal	runEmbeddedSweep() Removes any embedded objects which do not have containers.
ReturnVal	runEmbeddedTest() run a verification on the integrity of embedded objects and their containers
ReturnVal	runInvidSweep() Removes any invid pointers in the Ganymede database whose targets are not properly defined.
ReturnVal	runInvidTest() run a (possibly long-running) verification suite on the invid links
ReturnVal	runTaskNow(java.lang.String name) Causes a pre-registered task in the Ganymede server to be executed as soon as possible.
ReturnVal	shutdown(boolean waitForUsers) shutdown the server cleanly, on behalf of this admin console.
ReturnVal	stopTask(java.lang.String name) Causes a running task to be stopped as soon as possible.

Method Detail

logout

public void logout()
            throws java.rmi.RemoteException

Disconnect the remote admin console associated with this object

refreshMe

public void refreshMe()
               throws java.rmi.RemoteException

This method lets the admin console explicitly request a refresh. Upon being called, the server will call several methods on the admin console's Admin interface to pass current status information to the console.

forceBuild

public ReturnVal forceBuild()
                     throws java.rmi.RemoteException

This method is called by admin console code to force a complete rebuild of all external builds. This means that all databases will have their last modification timestamp cleared and all builder tasks will be scheduled for immediate execution.

kill

public ReturnVal kill(java.lang.String user)
               throws java.rmi.RemoteException

Kick a user off of the Ganymede server on behalf of this admin console

killAll

public ReturnVal killAll()
                  throws java.rmi.RemoteException

Kick all users off of the Ganymede server on behalf of this admin console

shutdown

public ReturnVal shutdown(boolean waitForUsers)
                   throws java.rmi.RemoteException

shutdown the server cleanly, on behalf of this admin console.

dumpDB

public ReturnVal dumpDB()
                 throws java.rmi.RemoteException

dump the current state of the db to disk

runInvidTest

public ReturnVal runInvidTest()
                       throws java.rmi.RemoteException

run a (possibly long-running) verification suite on the invid links

runInvidSweep

public ReturnVal runInvidSweep()
                        throws java.rmi.RemoteException

Removes any invid pointers in the Ganymede database whose targets are not properly defined. This should not happen unless there is a bug some place in the server.

runEmbeddedTest

public ReturnVal runEmbeddedTest()
                          throws java.rmi.RemoteException

run a verification on the integrity of embedded objects and their containers

runEmbeddedSweep

public ReturnVal runEmbeddedSweep()
                           throws java.rmi.RemoteException

Removes any embedded objects which do not have containers.

runTaskNow

public ReturnVal runTaskNow(java.lang.String name)
                     throws java.rmi.RemoteException

Causes a pre-registered task in the Ganymede server to be executed as soon as possible. This method call will have no effect if the task is currently running.

stopTask

public ReturnVal stopTask(java.lang.String name)
                   throws java.rmi.RemoteException

Causes a running task to be stopped as soon as possible. This is not always a safe operation, as the task is stopped abruptly, with possible consequences. Use with caution.

disableTask

public ReturnVal disableTask(java.lang.String name)
                      throws java.rmi.RemoteException

Causes a registered task to be made ineligible for execution until enableTask() is called. This method will not stop a task that is currently running.

enableTask

public ReturnVal enableTask(java.lang.String name)
                     throws java.rmi.RemoteException

Causes a task that was temporarily disabled by disableTask() to be available for execution again.

editSchema

public SchemaEdit editSchema()
                      throws java.rmi.RemoteException

lock the server and edit the schema