All Packages  Class Hierarchy  This Package  Previous  Next  Index

Interface edu.cmu.owl.ds.diagnostics.DiagnosticsServer

public interface interface DiagnosticsServer
This interface defines the DiagnosticsServer. This server will most probably only be called by the DianosticsBean.

Version:
1.0
See Also:
DiagnosticsBean

Variable Index

 o SERVER_NAME
This is the server name (as bound in the registry)

Method Index

 o addDiagnosticsListener(DiagnosticsListener)
This method adds a listener to the diagnostics events
 o addModuleListener(String, String, ModuleListener)
This method adds a listener for a specific event on a specific listener.
 o getModuleList()
This method returns the list of Modules (a vector of strings) registered with the diagnostics server.
 o getModuleUI(String)
This method returns the UI for the given module name.
 o removeDiagnosticsListener(DiagnosticsListener)
This method removes a listener to the diagnostics events
 o removeModuleListener(String, String, ModuleListener)
This method removes a listener for a specific event on a specific listener.

Variables

 o SERVER_NAME
 public static final String SERVER_NAME
This is the server name (as bound in the registry)

Methods

 o addDiagnosticsListener
 public abstract void addDiagnosticsListener(DiagnosticsListener listener) throws RemoteException
This method adds a listener to the diagnostics events

Parameters:
listener - the listener implementation
Throws: RemoteException
if anything fails in the communication
See Also:
DiagnosticsEvent, DiagnosticsListener
 o removeDiagnosticsListener
 public abstract void removeDiagnosticsListener(DiagnosticsListener listener) throws RemoteException
This method removes a listener to the diagnostics events

Parameters:
listener - the listener implementation
Throws: RemoteException
if anything fails in the communication
See Also:
DiagnosticsEvent, DiagnosticsListener
 o addModuleListener
 public abstract void addModuleListener(String module,
                                        String event,
                                        ModuleListener listener) throws RemoteException, NoSuchModuleException, NoSuchEventException, WrongListenerTypeException
This method adds a listener for a specific event on a specific listener. Essentially, this method forwards the call to the appropriate Module.

Parameters:
listener - the listener implementation
Throws: RemoteException
if anything fails in the communication
Throws: NoSuchModuleException
if there is no such module registered
Throws: NoSuchEventException
if there is no such event at that module
See Also:
DiagnosticModule, ModuleListener
 o removeModuleListener
 public abstract void removeModuleListener(String module,
                                           String event,
                                           ModuleListener listener) throws RemoteException, NoSuchModuleException, NoSuchEventException
This method removes a listener for a specific event on a specific listener. Essentially, this method forwards the call to the appropriate Module.

Parameters:
listener - the listener implementation
Throws: RemoteException
if anything fails in the communication
Throws: NoSuchModuleException
if there is no such module registered
Throws: NoSuchEventException
if there is no such event at that module
See Also:
DiagnosticModule, ModuleListener
 o getModuleList
 public abstract Vector getModuleList() throws RemoteException
This method returns the list of Modules (a vector of strings) registered with the diagnostics server.

Returns:
the list of modules registered with the DiagnosticsServer
Throws: RemoteException
if anything fails in the communication
 o getModuleUI
 public abstract DiagnosticModuleUI getModuleUI(String module) throws RemoteException, NoSuchModuleException
This method returns the UI for the given module name.

Parameters:
module - the module name
Returns:
the UI for that module
Throws: RemoteException
if anything fails in the communication
Throws: NoSuchModuleException
if there is no such module registered

All Packages  Class Hierarchy  This Package  Previous  Next  Index