org.oddjob.framework.extend

Class SimpleService

java.lang.Object

org.oddjob.framework.extend.BaseComponent

org.oddjob.framework.extend.SimpleService

All Implemented Interfaces:

java.lang.Runnable, ArooaContextAware, ArooaSessionAware, PropertyChangeNotifier, Iconic, LogEnabled, Resetable, Stateful, Stoppable

Direct Known Subclasses:

ClientBase, OddjobPanel, TaskExecutionService, WebClientJob

public abstract class SimpleService
extends BaseComponent
implements java.lang.Runnable, Stateful, Resetable, Stoppable, LogEnabled

Base class for providing a common Service implementation.

Note that this class is only required when special interaction with Oddjob is required such as different state handling. Most simple service can be provided a classes to be proxied.

Author:

rob

Constructor Summary

Constructors

Constructor and Description
SimpleService() Constructor.

Method Summary

Modifier and Type	Method and Description
protected void	fireDestroyedState() Internal method to fire state.
java.lang.String	getName() Get the name.
protected ServiceStateChanger	getStateChanger()
boolean	hardReset() Perform a hard reset on the job.
protected IconHelper	iconHelper() Subclasses must provide a IconHelper.
protected org.slf4j.Logger	logger()
java.lang.String	loggerName() Provide the logger name.
protected void	onDestroy() Subclasses override this method to clear up resources.
protected abstract void	onStart()
protected void	onStop() Allow sub classes to do something on stop.
void	run()
void	setName(java.lang.String name) Set the name
boolean	softReset() Perform a soft reset on the job.
protected ServiceStateHandler	stateHandler() Subclasses must provide a StateHandler.
void	stop() Stop executing.
java.lang.String	toString()

Methods inherited from class org.oddjob.framework.extend.BaseComponent

addIconListener, addPropertyChangeListener, addStateListener, configure, destroy, firePropertyChange, getArooaSession, iconForId, initialise, lastStateEvent, onConfigured, onInitialised, removeIconListener, removePropertyChangeListener, removeStateListener, save, save, setArooaContext, setArooaSession

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.oddjob.Stateful

addStateListener, lastStateEvent, removeStateListener

Constructor Detail

SimpleService

public SimpleService()

Constructor.

Method Detail

logger

protected org.slf4j.Logger logger()

Specified by:

logger in class BaseComponent

loggerName

public java.lang.String loggerName()

Description copied from interface: LogEnabled

Provide the logger name. The name should be unique for each component that is LogEnabled.

Specified by:

loggerName in interface LogEnabled

Returns:

A logger name. Never Null.

stateHandler

protected ServiceStateHandler stateHandler()

Description copied from class: BaseComponent

Subclasses must provide a StateHandler.

Specified by:

stateHandler in class BaseComponent

Returns:

A State Handler. Never null.

iconHelper

protected IconHelper iconHelper()

Description copied from class: BaseComponent

Subclasses must provide a IconHelper.

Specified by:

iconHelper in class BaseComponent

Returns:

An Icon Helper. Never null.

getStateChanger

protected ServiceStateChanger getStateChanger()

run

public void run()

Specified by:

run in interface java.lang.Runnable

onStart

protected abstract void onStart()
                         throws java.lang.Throwable

Throws:

java.lang.Exception

java.lang.Throwable

stop

public void stop()
          throws FailedToStopException

Description copied from interface: Stoppable

Stop executing. This method should not return until the Stoppable has actually stopped.

Specified by:

stop in interface Stoppable

Throws:

FailedToStopException

onStop

protected void onStop()
               throws FailedToStopException

Allow sub classes to do something on stop.

Throws:

FailedToStopException

softReset

public boolean softReset()

Perform a soft reset on the job.

Specified by:

softReset in interface Resetable

Returns:

true if successful.

hardReset

public boolean hardReset()

Perform a hard reset on the job.

Specified by:

hardReset in interface Resetable

Returns:

true if successful.

getName

public java.lang.String getName()

Get the name.

Returns:

The name.

setName

public void setName(java.lang.String name)

Set the name

Parameters:

name - The name.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

onDestroy

protected void onDestroy()

Description copied from class: BaseComponent

Subclasses override this method to clear up resources. This is called by the framework before child elements have been destroyed.

Overrides:

onDestroy in class BaseComponent

fireDestroyedState

protected void fireDestroyedState()

Internal method to fire state.

Specified by:

fireDestroyedState in class BaseComponent