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

arlut.csd.ganymede.ReturnVal	disableTask(java.lang.String name) Causes a registered task to be made ineligible for execution until enableTask() is called.
arlut.csd.ganymede.ReturnVal	dumpDB() dump the current state of the db to disk
arlut.csd.ganymede.SchemaEdit	editSchema() Lock the server to prevent client logins and edit the server schema.
arlut.csd.ganymede.ReturnVal	enableTask(java.lang.String name) Causes a task that was temporarily disabled by disableTask() to be available for execution again.
arlut.csd.ganymede.ReturnVal	forceBuild() This method is called by admin console code to force a complete rebuild of all external builds.
arlut.csd.ganymede.ReturnVal	kill(java.lang.String user) Kick a user off of the Ganymede server on behalf of this admin console
arlut.csd.ganymede.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.
arlut.csd.ganymede.ReturnVal	runEmbeddedSweep() Removes any embedded objects which do not have containers.
arlut.csd.ganymede.ReturnVal	runEmbeddedTest() run a verification on the integrity of embedded objects and their containers
arlut.csd.ganymede.ReturnVal	runInvidSweep() run a long-running verification and repair operation on the Ganymede server's invid database links
arlut.csd.ganymede.ReturnVal	runInvidTest() run a long-running verification suite on the Ganymede server database's invid links
arlut.csd.ganymede.ReturnVal	runTaskNow(java.lang.String name) Causes a pre-registered task in the Ganymede server to be executed as soon as possible.
arlut.csd.ganymede.ReturnVal	shutdown(boolean waitForUsers) shutdown the server cleanly, on behalf of this admin console.
arlut.csd.ganymede.ReturnVal	stopTask(java.lang.String name) Causes a running task to be interrupted as soon as possible.

Method Detail

logout

public void logout()
            throws java.rmi.RemoteException

Disconnect the remote admin console associated with this object

java.rmi.RemoteException

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.

java.rmi.RemoteException

forceBuild

public arlut.csd.ganymede.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.

java.rmi.RemoteException

kill

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

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

java.rmi.RemoteException

killAll

public arlut.csd.ganymede.ReturnVal killAll()
                                     throws java.rmi.RemoteException

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

java.rmi.RemoteException

shutdown

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

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

Parameters:

waitForUsers - if true, shutdown will be deferred until all users are logged out. No new users will be allowed to login.

java.rmi.RemoteException

dumpDB

public arlut.csd.ganymede.ReturnVal dumpDB()
                                    throws java.rmi.RemoteException

dump the current state of the db to disk

java.rmi.RemoteException

runInvidTest

public arlut.csd.ganymede.ReturnVal runInvidTest()
                                          throws java.rmi.RemoteException

run a long-running verification suite on the Ganymede server database's invid links

java.rmi.RemoteException

runInvidSweep

public arlut.csd.ganymede.ReturnVal runInvidSweep()
                                           throws java.rmi.RemoteException

run a long-running verification and repair operation on the Ganymede server's invid database links

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

java.rmi.RemoteException

runEmbeddedTest

public arlut.csd.ganymede.ReturnVal runEmbeddedTest()
                                             throws java.rmi.RemoteException

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

java.rmi.RemoteException

runEmbeddedSweep

public arlut.csd.ganymede.ReturnVal runEmbeddedSweep()
                                              throws java.rmi.RemoteException

Removes any embedded objects which do not have containers.

java.rmi.RemoteException

runTaskNow

public arlut.csd.ganymede.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.

Parameters:

name - The name of the task to run

java.rmi.RemoteException

stopTask

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

Causes a running task to be interrupted as soon as possible. Ganymede tasks need to be specifically written to be able to respond to interruption, so it is not guaranteed that the task named will always be able to safely or immediately respond to a stopTask() command.

Parameters:

name - The name of the task to interrupt

java.rmi.RemoteException

disableTask

public arlut.csd.ganymede.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.

Parameters:

name - The name of the task to disable

java.rmi.RemoteException

enableTask

public arlut.csd.ganymede.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.

Parameters:

name - The name of the task to enable

java.rmi.RemoteException

editSchema

public arlut.csd.ganymede.SchemaEdit editSchema()
                                         throws java.rmi.RemoteException

Lock the server to prevent client logins and edit the server schema. This method will return a SchemaEdit remote reference to the admin console, which will present a graphical schema editor using this remote reference. The server will remain locked until the admin console commits or cancels the schema editing session, either through affirmative action or through the death of the admin console or the network connection. The DBSchemaEdit class on the server coordinates everything.

java.rmi.RemoteException