org.wamblee.system.container

Class Container

java.lang.Object

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

org.wamblee.system.container.Container

All Implemented Interfaces:

Component<Scope>

Direct Known Subclasses:

DefaultContainer

public class Container
extends AbstractComponent<Scope>

Container consisting of multiple components.

Author:

Erik Brakkee

Constructor Summary

Constructors

Constructor and Description
Container(String aName) Creates a new Container object.
Container(String aName, Component[] aComponents, List<ProvidedInterface> aProvided, List<RequiredInterface> aRequired) Constructs the container
Container(String aName, Component[] aComponents, ProvidedInterface[] aProvided, RequiredInterface[] aRequired) Constructs the container

Method Summary

Modifier and Type	Method and Description
Container	addComponent(Component aComponent)
void	addContext(String aContext) Prepends the context with a super context.
Container	addProvidedInterface(ProvidedInterface aProvided)
Container	addRequiredInterface(RequiredInterface aRequired)
void	connectExternalProvided(String aExternalProvided, String aComponent, String aProvidedInterface)
void	connectExternalRequired(String aComponent, String aRequiredInterface, String aExternalRequiredInterface) Explicitly connects a externally required interface to an internally required interface.
void	connectRequiredProvided(String aClientComponent, String aRequiredInterface, String aServerComponent, String aProvidedInterface) Explictly connects required and provided interfaces.
protected Scope	doStart(Scope aExternalScope) Must be implemented for initializing the subsystem.
protected void	doStop(Scope aScope)
Component	findComponent(String aName) Finds a component based on the non-qualified name of the component.
boolean	isSealed() Checks if the container is sealed.
void	seal() Seal the container, meaning that no further components or interfaces may be added.
Scope	start() Utility method to start with an empty external scope.
void	validate() Validates the components together to check that there are no required services not in the required list and no services in the provided list that cannot be provided.

Methods inherited from class org.wamblee.system.core.AbstractComponent

addInterface, findProvidedInterface, findRequiredInterface, getContext, getName, getProvidedInterfaces, getQualifiedName, getRequiredInterfaces, start, stop, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

Container

public Container(String aName,
                 Component[] aComponents,
                 List<ProvidedInterface> aProvided,
                 List<RequiredInterface> aRequired)

Constructs the container

Parameters:

aName - Name of the container

aComponents - Components.

aProvided - Provided services of the container

aRequired - Required services by the container.

Container

public Container(String aName,
                 Component[] aComponents,
                 ProvidedInterface[] aProvided,
                 RequiredInterface[] aRequired)

Constructs the container

Parameters:

aName - Name of the container

aComponents - Components.

aProvided - Provided services of the container

aRequired - Required services by the container.

Container

public Container(String aName)

Creates a new Container object.

Method Detail

addComponent

public Container addComponent(Component aComponent)

connectRequiredProvided

public void connectRequiredProvided(String aClientComponent,
                                    String aRequiredInterface,
                                    String aServerComponent,
                                    String aProvidedInterface)

Explictly connects required and provided interfaces.

Parameters:

aClientComponent - Client component, may not be null.

aRequiredInterface - Required interface. If null it means all required interfaces.

aServerComponent - Server component to connect to. If null, it means that no server components may be connected to and the provider of the required interface will be null.

aProvidedInterface - Provided interface. If null, it means that there is no restriction on the name of the provided interface and that it is automatically selected.

connectExternalRequired

public void connectExternalRequired(String aComponent,
                                    String aRequiredInterface,
                                    String aExternalRequiredInterface)

Explicitly connects a externally required interface to an internally required interface.

Parameters:

aComponent - Component requiring the interface (must be non-null).

aRequiredInterface - Required interface of the component (must be non-null).

aExternalRequiredInterface - Externally required interface (must be non-null).

connectExternalProvided

public void connectExternalProvided(String aExternalProvided,
                                    String aComponent,
                                    String aProvidedInterface)

addProvidedInterface

public Container addProvidedInterface(ProvidedInterface aProvided)

Overrides:

addProvidedInterface in class AbstractComponent<Scope>

addRequiredInterface

public Container addRequiredInterface(RequiredInterface aRequired)

Overrides:

addRequiredInterface in class AbstractComponent<Scope>

addContext

public void addContext(String aContext)

Description copied from interface: Component

Prepends the context with a super context.

Specified by:

addContext in interface Component<Scope>

Overrides:

addContext in class AbstractComponent<Scope>

validate

public void validate()

Validates the components together to check that there are no required services not in the required list and no services in the provided list that cannot be provided. Also logs a warning in case of superfluous requirements.

seal

public void seal()

Seal the container, meaning that no further components or interfaces may be added.

isSealed

public boolean isSealed()

Checks if the container is sealed.

Returns:

True iff the container is sealed.

start

public Scope start()

Utility method to start with an empty external scope. This is useful for top-level containers which are not part of another container.

Returns:

Scope.

doStart

protected Scope doStart(Scope aExternalScope)

Description copied from class: AbstractComponent

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

Specified by:

doStart in class AbstractComponent<Scope>

Returns:

Returns the runtime of the component.

doStop

protected void doStop(Scope aScope)

Specified by:

doStop in class AbstractComponent<Scope>

findComponent

public Component findComponent(String aName)

Finds a component based on the non-qualified name of the component.

Parameters:

aName - Component name.

Returns:

Component or null if not found.