org.fabric3.spi.container.component

Interface ScopeContainer

public interface ScopeContainer

Manages the lifecycle and visibility component implementations instances.

Method Summary

Modifier and Type	Method and Description
java.util.List<java.lang.Object>	getActiveInstances(ScopedComponent component) Returns a snapshot of the component instances that are active and currently managed by the scope container.
java.lang.Object	getInstance(ScopedComponent component) Returns an instance associated with the current scope context, creating one if necessary
org.fabric3.api.model.type.component.Scope	getScope() Returns the Scope that this container supports.
void	register(ScopedComponent component) Registers a component with the scope.
void	reinject() Reinjects all live instances with updated wires
void	releaseInstance(ScopedComponent component, java.lang.Object instance) Return am instance after use (for example, after invoking the instance).
void	startContext(java.net.URI contributionUri) Start a new, non-expiring context.
void	stopContext(java.net.URI contributionUri) Stop the context associated with the current work context.
void	unregister(ScopedComponent component) Unregisters a component with the scope.

Method Detail

getScope

org.fabric3.api.model.type.component.Scope getScope()

Returns the Scope that this container supports.

Returns:

the Scope that this container supports

register

void register(ScopedComponent component)

Registers a component with the scope.

Parameters:

component - the component to register

unregister

void unregister(ScopedComponent component)

Unregisters a component with the scope.

Parameters:

component - the component to unregister

startContext

void startContext(java.net.URI contributionUri)
           throws org.fabric3.api.host.Fabric3Exception

Start a new, non-expiring context. The context will remain active until explicitly stopped.

Parameters:

contributionUri - the URI of the contribution to start the context for

Throws:

org.fabric3.api.host.Fabric3Exception - if an exception starting the context was encountered

stopContext

void stopContext(java.net.URI contributionUri)
          throws org.fabric3.api.host.Fabric3Exception

Stop the context associated with the current work context.

Parameters:

contributionUri - he URI of the contribution to stop the context for

Throws:

org.fabric3.api.host.Fabric3Exception - if there is an error stopping the context

getInstance

java.lang.Object getInstance(ScopedComponent component)
                      throws org.fabric3.api.host.Fabric3Exception

Returns an instance associated with the current scope context, creating one if necessary

Parameters:

component - the component

Returns:

the instance

Throws:

org.fabric3.api.host.Fabric3Exception - if there was a problem instantiating the target instance

releaseInstance

void releaseInstance(ScopedComponent component,
                     java.lang.Object instance)
              throws org.fabric3.api.host.Fabric3Exception

Return am instance after use (for example, after invoking the instance).

Parameters:

component - the component

instance - the instance

Throws:

org.fabric3.api.host.Fabric3Exception - if there was a problem returning the target instance

getActiveInstances

java.util.List<java.lang.Object> getActiveInstances(ScopedComponent component)

Returns a snapshot of the component instances that are active and currently managed by the scope container.

Parameters:

component - the component

Returns:

the active instances

reinject

void reinject()
       throws org.fabric3.api.host.Fabric3Exception

Reinjects all live instances with updated wires

Throws:

org.fabric3.api.host.Fabric3Exception - if an error occurs during re-injection