TPTP 4.4.0 Monitoring Tools Project
Public API Specification

org.eclipse.hyades.logging.adapter.impl
Class Controller

java.lang.Object
  extended byorg.eclipse.hyades.logging.adapter.impl.Controller
All Implemented Interfaces:
java.lang.Runnable

Deprecated. This is really an internal class of the Generic Log Adapter run-time and should not be extended or called by external applications. Applications wanting to run adapters using Generic Log Adapter should use the org.eclipse.hyades.logging.adapter.Adapter class.

public class Controller
extends java.lang.Object
implements java.lang.Runnable

Controller manages a set of Context objects by setting the configurations and then starting each context.


Constructor Summary
Controller()
          Deprecated. Constructor for Controller.
 
Method Summary
 IContext[] getContexts()
          Deprecated. Get the set of Context objects
 IOutputter getLogOutputter()
          Deprecated. Get the custom Outputter that the internal logging context is using.
 Status[] getStatus()
          Deprecated. Get the status of the contexts
 void hardStop()
          Deprecated. This stop method will still cause the contexts to be stopped but will not call the context listener methods when flushing the components.
 boolean isRunning()
          Deprecated. Returns whether the Controller is running.
 void log(java.lang.String logRecord)
          Deprecated. Log the string message to standard error since the logging outputter(s) associated with the AdapterSensor logger will never be started.
 void prepareAdapter()
          Deprecated. Prepare the adapter for execution.
 void run()
          Deprecated. run provides the basic loop for a Controller thread.
 void setComponentConfigPath(java.lang.String config)
          Deprecated. Set the name of the file containing the configurations for the components of the contexts.
 void setContextConfigPath(java.lang.String config)
          Deprecated. Set the name of the file containing the configurations for the contexts.
 void setLogOutputter(IOutputter logOutputter)
          Deprecated. Sets the custom Outputter for the internal logging context to use.
 void start()
          Deprecated. Start running the controller which means starting up each of the contexts.
 void stop()
          Deprecated. Stop the controller which means stopping all of the contexts if they are still running.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Controller

public Controller()
Deprecated. 
Constructor for Controller.

Method Detail

isRunning

public boolean isRunning()
Deprecated. 
Returns whether the Controller is running.

Returns:
true if Controller is running, false otherwise

start

public void start()
Deprecated. 
Start running the controller which means starting up each of the contexts.


stop

public void stop()
Deprecated. 
Stop the controller which means stopping all of the contexts if they are still running.


hardStop

public void hardStop()
Deprecated. 
This stop method will still cause the contexts to be stopped but will not call the context listener methods when flushing the components.


getContexts

public IContext[] getContexts()
Deprecated. 
Get the set of Context objects

Returns:
the set of Context objects

setContextConfigPath

public void setContextConfigPath(java.lang.String config)
Deprecated. 
Set the name of the file containing the configurations for the contexts.

Parameters:
config - - name of the context configuation file

setComponentConfigPath

public void setComponentConfigPath(java.lang.String config)
Deprecated. 
Set the name of the file containing the configurations for the components of the contexts.

Parameters:
config - - name of the component configuation file

prepareAdapter

public void prepareAdapter()
                    throws AdapterException
Deprecated. 
Prepare the adapter for execution. This involves reading and validating the adapter configuration file(s), getting the context listeners from eclipse, starting the internal logging context, and initializing the contexts.

Throws:
AdapterException

run

public void run()
Deprecated. 
run provides the basic loop for a Controller thread. It starts the Controller thread and then monitors it.

Specified by:
run in interface java.lang.Runnable

log

public void log(java.lang.String logRecord)
Deprecated. 
Log the string message to standard error since the logging outputter(s) associated with the AdapterSensor logger will never be started.

Parameters:
logRecord - The string message to be logged to standard error.

getStatus

public Status[] getStatus()
Deprecated. 
Get the status of the contexts

Returns:
the array of Status objects representing the status of the contexts

getLogOutputter

public IOutputter getLogOutputter()
Deprecated. 
Get the custom Outputter that the internal logging context is using.

Returns:
Returns the custom Outputter that the internal logging context is using.

setLogOutputter

public void setLogOutputter(IOutputter logOutputter)
Deprecated. 
Sets the custom Outputter for the internal logging context to use.

Parameters:
logOutputter - The custom Outputter for the internal logging context.

TPTP 4.4.0 Monitoring Tools Project
Public API Specification