org.oddjob.framework.adapt

Class BaseWrapper

java.lang.Object

org.oddjob.framework.extend.BaseComponent

org.oddjob.framework.adapt.BaseWrapper

All Implemented Interfaces:

java.lang.Runnable, org.apache.commons.beanutils.DynaBean, ArooaContextAware, ArooaSessionAware, Describable, PropertyChangeNotifier, Iconic, LogEnabled, Resettable, Stateful, Stoppable

Direct Known Subclasses:

JobWrapper, ServiceWrapper

public abstract class BaseWrapper
extends BaseComponent
implements java.lang.Runnable, Stateful, Resettable, org.apache.commons.beanutils.DynaBean, Stoppable, LogEnabled, Describable

Base class for proxy creators.

Constructor Summary

Constructors

Constructor and Description
BaseWrapper()

Method Summary

Modifier and Type	Method and Description
protected void	configure() Called by sub classes to configure the component.
boolean	contains(java.lang.String name, java.lang.String key)
java.util.Map<java.lang.String,java.lang.String>	describe() Provides the properties.
boolean	equals(java.lang.Object other)
java.lang.Object	get(java.lang.String name)
java.lang.Object	get(java.lang.String name, int index)
java.lang.Object	get(java.lang.String name, java.lang.String key)
protected abstract org.apache.commons.beanutils.DynaBean	getDynaBean() Sub classes must provide a dyna bean for properties.
org.apache.commons.beanutils.DynaClass	getDynaClass()
protected abstract java.lang.Object	getProxy() Subclass must provide the proxy.
protected int	getResult(java.lang.Object callableResult) Get the result.
protected abstract java.lang.Object	getWrapped() Return the object that is being proxied.
static java.lang.Class<?>[]	interfacesFor(java.lang.Object object) Helper class to find interfaces implemented by an object.
protected org.slf4j.Logger	logger()
java.lang.String	loggerName() Provide the logger name.
void	onDestroy() Subclasses override this method to clear up resources.
protected void	onStop()
void	remove(java.lang.String name, java.lang.String key)
protected void	save() Implementations override this to save their state on state change.
void	set(java.lang.String name, int index, java.lang.Object value)
void	set(java.lang.String name, java.lang.Object value)
void	set(java.lang.String name, java.lang.String key, java.lang.Object value)
void	stop() Stop executing.
java.lang.String	toString()

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

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Runnable

run

Methods inherited from interface org.oddjob.Stateful

addStateListener, lastStateEvent, removeStateListener

Methods inherited from interface org.oddjob.Resettable

hardReset, softReset

Constructor Detail

BaseWrapper

public BaseWrapper()

Method Detail

getWrapped

protected abstract java.lang.Object getWrapped()

Return the object that is being proxied.

Returns:

The component being proxied.

getDynaBean

protected abstract org.apache.commons.beanutils.DynaBean getDynaBean()

Sub classes must provide a dyna bean for properties.

Returns:

getProxy

protected abstract java.lang.Object getProxy()

Subclass must provide the proxy.

Returns:

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.

configure

protected void configure()
                  throws ArooaConfigurationException

Called by sub classes to configure the component.

Throws:

ArooaConfigurationException

save

protected void save()
             throws ComponentPersistException

Description copied from class: BaseComponent

Implementations override this to save their state on state change.

Overrides:

save in class BaseComponent

Throws:

ComponentPersistException

equals

public boolean equals(java.lang.Object other)

Overrides:

equals in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

contains

public boolean contains(java.lang.String name,
                        java.lang.String key)

Specified by:

contains in interface org.apache.commons.beanutils.DynaBean

get

public java.lang.Object get(java.lang.String name)

Specified by:

get in interface org.apache.commons.beanutils.DynaBean

get

public java.lang.Object get(java.lang.String name,
                            int index)

Specified by:

get in interface org.apache.commons.beanutils.DynaBean

get

public java.lang.Object get(java.lang.String name,
                            java.lang.String key)

Specified by:

get in interface org.apache.commons.beanutils.DynaBean

getDynaClass

public org.apache.commons.beanutils.DynaClass getDynaClass()

Specified by:

getDynaClass in interface org.apache.commons.beanutils.DynaBean

remove

public void remove(java.lang.String name,
                   java.lang.String key)

Specified by:

remove in interface org.apache.commons.beanutils.DynaBean

set

public void set(java.lang.String name,
                int index,
                java.lang.Object value)

Specified by:

set in interface org.apache.commons.beanutils.DynaBean

set

public void set(java.lang.String name,
                java.lang.Object value)

Specified by:

set in interface org.apache.commons.beanutils.DynaBean

set

public void set(java.lang.String name,
                java.lang.String key,
                java.lang.Object value)

Specified by:

set in interface org.apache.commons.beanutils.DynaBean

stop

public final 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

Throws:

FailedToStopException

getResult

protected int getResult(java.lang.Object callableResult)
                 throws ArooaPropertyException,
                        ArooaConversionException

Get the result. Use either the return value from the Callable or the result property if there is one.

Returns:

The result.

Throws:

ArooaConversionException - If the result can't be converted to int.

ArooaPropertyException - If the result property can't be read.

describe

public java.util.Map<java.lang.String,java.lang.String> describe()

Description copied from interface: Describable

Provides the properties.

Specified by:

describe in interface Describable

Returns:

A map of property values. Must not be null.

onDestroy

public 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

interfacesFor

public static java.lang.Class<?>[] interfacesFor(java.lang.Object object)

Helper class to find interfaces implemented by an object.

Parameters:

object -

Returns:

An array of the interface classes.