org.wamblee.system.core

Class AbstractComponent<Type>

java.lang.Object

org.wamblee.system.core.AbstractComponent<Type>

All Implemented Interfaces:

Component<Type>

Direct Known Subclasses:

ClassAdapter, Container, DatasourceComponent, ObjectAdapter, PropertyComponent, SpringComponent

public abstract class AbstractComponent<Type>
extends Object
implements Component<Type>

Abstract subsystem class making it easy to implement new subsystems.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractComponent(String aName) Creates a new AbstractComponent object.
protected	AbstractComponent(String aName, List<ProvidedInterface> aProvided, List<RequiredInterface> aRequired) Constructs the subsystem.
protected	AbstractComponent(String aName, ProvidedInterface[] aProvided, RequiredInterface[] aRequired) Constructs the subsystem.

Method Summary

Modifier and Type	Method and Description
void	addContext(String aContext) Prepends the context with a super context.
protected void	addInterface(ProvidedInterface aDescriptor, Object aService, Scope aScope) Implementations must call this method to indicate that a new service has been started.
AbstractComponent<Type>	addProvidedInterface(ProvidedInterface aProvided)
AbstractComponent<Type>	addRequiredInterface(RequiredInterface aRequired)
protected abstract Type	doStart(Scope aScope) Must be implemented for initializing the subsystem.
protected abstract void	doStop(Type aRuntime)
ProvidedInterface	findProvidedInterface(String aName)
RequiredInterface	findRequiredInterface(String aName)
String	getContext() Getst the context.
String	getName() Gets the name of the subsystem.
List<ProvidedInterface>	getProvidedInterfaces() Gets a description of the provided interfaces.
String	getQualifiedName() Gets the fully qualified name of the component which includes the context of the component.
List<RequiredInterface>	getRequiredInterfaces() Gets a description of the required interfaces.
Type	start(Scope aScope) Initialises the subsystem by starting all the services that it described as provided.
void	stop(Type aRuntime) Stops a component.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractComponent

protected AbstractComponent(String aName,
                            List<ProvidedInterface> aProvided,
                            List<RequiredInterface> aRequired)

Constructs the subsystem.

Parameters:

aName - Name of the system.

aProvided - Provided services.

aRequired - Required services.

AbstractComponent

protected AbstractComponent(String aName,
                            ProvidedInterface[] aProvided,
                            RequiredInterface[] aRequired)

Constructs the subsystem.

Parameters:

aName - Name of the system.

aProvided - Provided services.

aRequired - Required services.

AbstractComponent

protected AbstractComponent(String aName)

Creates a new AbstractComponent object.

Method Detail

addProvidedInterface

public AbstractComponent<Type> addProvidedInterface(ProvidedInterface aProvided)

addRequiredInterface

public AbstractComponent<Type> addRequiredInterface(RequiredInterface aRequired)

getName

public final String getName()

Description copied from interface: Component

Gets the name of the subsystem.

Specified by:

getName in interface Component<Type>

Returns:

Subsystem name.

addContext

public void addContext(String aContext)

Description copied from interface: Component

Prepends the context with a super context.

Specified by:

addContext in interface Component<Type>

getContext

public String getContext()

Description copied from interface: Component

Getst the context.

Specified by:

getContext in interface Component<Type>

Returns:

Context or null if not set.

getQualifiedName

public String getQualifiedName()

Description copied from interface: Component

Gets the fully qualified name of the component which includes the context of the component. This method can only be used after the component has started.

Specified by:

getQualifiedName in interface Component<Type>

Returns:

Qualified name.

getProvidedInterfaces

public final List<ProvidedInterface> getProvidedInterfaces()

Description copied from interface: Component

Gets a description of the provided interfaces.

Specified by:

getProvidedInterfaces in interface Component<Type>

Returns:

Provided interfaces.

getRequiredInterfaces

public final List<RequiredInterface> getRequiredInterfaces()

Description copied from interface: Component

Gets a description of the required interfaces.

Specified by:

getRequiredInterfaces in interface Component<Type>

Returns:

Required interfaces.

start

public final Type start(Scope aScope)

Description copied from interface: Component

Initialises the subsystem by starting all the services that it described as provided.

Specified by:

start in interface Component<Type>

Parameters:

aScope - Scope with external interface implementations that are available. The component must publish its runtime and its provided interfaces in this scope.

Returns:

Gets an object representing the runtime of the component.

doStart

protected abstract Type doStart(Scope aScope)

Must be implemented for initializing the subsystem. The implementation must call addInterface(ProvidedInterface, Object, Scope) for each service that is started.

Returns:

Returns the runtime of the component.

addInterface

protected final void addInterface(ProvidedInterface aDescriptor,
                                  Object aService,
                                  Scope aScope)

Implementations must call this method to indicate that a new service has been started.

Parameters:

aDescriptor - Provided interface.

aService - Implementation of the interface.

aScope - scope in which to publish the implementation.

stop

public void stop(Type aRuntime)

Description copied from interface: Component

Stops a component.

Specified by:

stop in interface Component<Type>

Parameters:

aRuntime - THe runtime part of the component.

doStop

protected abstract void doStop(Type aRuntime)

toString

public String toString()

Overrides:

toString in class Object

findProvidedInterface

public ProvidedInterface findProvidedInterface(String aName)

findRequiredInterface

public RequiredInterface findRequiredInterface(String aName)