org.codehaus.plexus

Class DefaultPlexusContainer

public class DefaultPlexusContainer extends AbstractLogEnabled implements MutablePlexusContainer

  //TODO move lookup code to a separate component
  //TODO  register live components so they can be wired
  //keep track of the interfaces for components
  //todo allow setting of a live configuraton so applications that embed plexus can use
  whatever configuration mechanism they like. They just have to adapt it into something plexus can understand.
  //todo
  make a typesafe configuration model for the container
  //todo pico like registration
  //todo need loggers per execution in the maven embedder
  //todo a simple front-end to make containers of different flavours, a flavour encapsulating
  // a set of behaviours
  //todo the core components should probably have a small lifecycle to pass through

Author: Jason van Zyl Kenney Westerhof

Field Summary
protected Map	childContainers Map<String, PlexusContainer> where the key is the container name.
protected ClassWorld	classWorld
protected ComponentComposerManager	componentComposerManager
protected ComponentDiscovererManager	componentDiscovererManager
protected ComponentFactoryManager	componentFactoryManager
protected ComponentLookupManager	componentLookupManager
protected ComponentManagerManager	componentManagerManager
protected ComponentRepository	componentRepository
protected PlexusConfiguration	configuration
protected Reader	configurationReader
protected DefaultContext	containerContext
protected ClassRealm	containerRealm
protected Date	creationDate
protected static String	DEFAULT_CONTAINER_NAME
protected static String	DEFAULT_REALM_NAME
protected List	initializationPhases
boolean	initialized
protected LifecycleHandlerManager	lifecycleHandlerManager
protected LoggerManager	loggerManager
ThreadLocal	lookupRealm
protected String	name
protected PlexusContainer	parentContainer
protected boolean	reloadingEnabled
ClassRealm	staticLookupRealm Used for getLookupRealm for threads when the threadlocal doesn't contain a value.

Constructor Summary
	DefaultPlexusContainer()
	DefaultPlexusContainer(ContainerConfiguration c)

Method Summary
void	addComponent(Object component, String role)
void	addComponentDescriptor(ComponentDescriptor componentDescriptor)
void	addContextValue(Object key, Object value)
void	addJarRepository(File repository)
void	addJarResource(File jar)
void	construct(ContainerConfiguration c)
PlexusContainer	createChildContainer(String name, Set urls)
PlexusContainer	createChildContainer(String name, ClassRealm realm)
ClassRealm	createComponentRealm(String id, List jars)
List	discoverComponents(ClassRealm classRealm)
List	discoverComponents(ClassRealm classRealm, boolean override)
void	dispose()
protected void	disposeAllComponents()
PlexusContainer	getChildContainer(String name)
ClassWorld	getClassWorld()
ComponentComposerManager	getComponentComposerManager()
ComponentDescriptor	getComponentDescriptor(String role)
ComponentDescriptor	getComponentDescriptor(String role, ClassRealm realm)
ComponentDescriptor	getComponentDescriptor(String role, String hint)
ComponentDescriptor	getComponentDescriptor(String role, String hint, ClassRealm classRealm)
List	getComponentDescriptorList(String role)
List	getComponentDescriptorList(String role, ClassRealm realm)
Map	getComponentDescriptorMap(String role)
Map	getComponentDescriptorMap(String role, ClassRealm realm)
ComponentDiscovererManager	getComponentDiscovererManager()
ComponentFactoryManager	getComponentFactoryManager()
ComponentLookupManager	getComponentLookupManager()
ComponentManagerManager	getComponentManagerManager()
ClassRealm	getComponentRealm(String realmId)
ComponentRepository	getComponentRepository()
PlexusConfiguration	getConfiguration()
ClassRealm	getContainerRealm()
Context	getContext()
Date	getCreationDate()
protected Reader	getInterpolationConfigurationReader(Reader reader)
LifecycleHandlerManager	getLifecycleHandlerManager()
Logger	getLogger()
LoggerManager	getLoggerManager()
ClassRealm	getLookupRealm()
ClassRealm	getLookupRealm(Object component) Utility method to get a default lookup realm for a component.
String	getName()
PlexusContainer	getParentContainer()
boolean	hasChildContainer(String name)
boolean	hasComponent(String componentKey)
boolean	hasComponent(String componentKey, ClassRealm realm)
boolean	hasComponent(String role, String roleHint)
boolean	hasComponent(String role, String roleHint, ClassRealm realm)
protected void	initialize(ContainerConfiguration containerConfiguration)
protected void	initializeConfiguration(ContainerConfiguration c)
protected void	initializePhases(ContainerConfiguration containerConfiguration)
boolean	isReloadingEnabled()
Object	lookup(String componentKey)
Object	lookup(String componentKey, ClassRealm realm)
Object	lookup(String role, String roleHint)
Object	lookup(String role, String roleHint, ClassRealm realm)
Object	lookup(Class componentClass)
Object	lookup(Class componentClass, ClassRealm realm)
Object	lookup(Class role, String roleHint)
Object	lookup(Class role, String roleHint, ClassRealm realm)
List	lookupList(String role)
List	lookupList(String role, ClassRealm realm)
List	lookupList(String role, List hints)
List	lookupList(String role, List hints, ClassRealm realm)
List	lookupList(Class role)
List	lookupList(Class role, ClassRealm realm)
List	lookupList(Class role, List hints)
List	lookupList(Class role, List hints, ClassRealm realm)
Map	lookupMap(String role)
Map	lookupMap(String role, ClassRealm realm)
Map	lookupMap(String role, List hints)
Map	lookupMap(String role, List hints, ClassRealm realm)
Map	lookupMap(Class role)
Map	lookupMap(Class role, ClassRealm realm)
Map	lookupMap(Class role, List hints)
Map	lookupMap(Class role, List hints, ClassRealm realm)
void	processConfigurationsDirectory() Process any additional component configuration files that have been specified.
void	registerComponentDiscoveryListener(ComponentDiscoveryListener listener)
void	release(Object component)
void	releaseAll(Map components)
void	releaseAll(List components)
void	removeChildContainer(String name)
void	removeComponentDiscoveryListener(ComponentDiscoveryListener listener)
void	setClassWorld(ClassWorld classWorld)
void	setComponentComposerManager(ComponentComposerManager componentComposerManager)
void	setComponentDiscovererManager(ComponentDiscovererManager componentDiscovererManager)
void	setComponentFactoryManager(ComponentFactoryManager componentFactoryManager)
void	setComponentLookupManager(ComponentLookupManager componentLookupManager)
void	setComponentManagerManager(ComponentManagerManager componentManagerManager)
void	setComponentRepository(ComponentRepository componentRepository)
void	setConfiguration(PlexusConfiguration configuration)
void	setContainerRealm(ClassRealm containerRealm)
void	setLifecycleHandlerManager(LifecycleHandlerManager lifecycleHandlerManager)
void	setLoggerManager(LoggerManager loggerManager)
ClassRealm	setLookupRealm(ClassRealm realm)
void	setName(String name)
void	setParentPlexusContainer(PlexusContainer container)
void	setReloadingEnabled(boolean reloadingEnabled)
protected void	start()
InputStream	toStream(String resource)

Field Detail

childContainers

protected Map childContainers

Map<String, PlexusContainer> where the key is the container name.

componentComposerManager

protected ComponentComposerManager componentComposerManager

componentDiscovererManager

protected ComponentDiscovererManager componentDiscovererManager

componentFactoryManager

protected ComponentFactoryManager componentFactoryManager

componentLookupManager

protected ComponentLookupManager componentLookupManager

componentManagerManager

protected ComponentManagerManager componentManagerManager

componentRepository

protected ComponentRepository componentRepository

configuration

protected PlexusConfiguration configuration

containerContext

protected DefaultContext containerContext

DEFAULT_CONTAINER_NAME

protected static final String DEFAULT_CONTAINER_NAME

DEFAULT_REALM_NAME

protected static final String DEFAULT_REALM_NAME

lifecycleHandlerManager

protected LifecycleHandlerManager lifecycleHandlerManager

parentContainer

protected PlexusContainer parentContainer

staticLookupRealm

private ClassRealm staticLookupRealm

Used for getLookupRealm for threads when the threadlocal doesn't contain a value.

Constructor Detail

DefaultPlexusContainer

public DefaultPlexusContainer(ContainerConfiguration c)

Method Detail

addComponent

public void addComponent(Object component, String role)

addComponentDescriptor

public void addComponentDescriptor(ComponentDescriptor componentDescriptor)

addContextValue

public void addContextValue(Object key, Object value)

addJarRepository

public void addJarRepository(File repository)

construct

private void construct(ContainerConfiguration c)

createChildContainer

public PlexusContainer createChildContainer(String name, Set urls)

createChildContainer

public PlexusContainer createChildContainer(String name, ClassRealm realm)

createComponentRealm

public ClassRealm createComponentRealm(String id, List jars)

discoverComponents

public List discoverComponents(ClassRealm classRealm)

discoverComponents

public List discoverComponents(ClassRealm classRealm, boolean override)

getChildContainer

public PlexusContainer getChildContainer(String name)

getComponentComposerManager

public ComponentComposerManager getComponentComposerManager()

getComponentDescriptor

public ComponentDescriptor getComponentDescriptor(String role)

getComponentDescriptor

public ComponentDescriptor getComponentDescriptor(String role, ClassRealm realm)

getComponentDescriptor

public ComponentDescriptor getComponentDescriptor(String role, String hint)

getComponentDescriptor

public ComponentDescriptor getComponentDescriptor(String role, String hint, ClassRealm classRealm)

getComponentDescriptorList

public List getComponentDescriptorList(String role)

getComponentDescriptorList

public List getComponentDescriptorList(String role, ClassRealm realm)

getComponentDescriptorMap

public Map getComponentDescriptorMap(String role)

getComponentDescriptorMap

public Map getComponentDescriptorMap(String role, ClassRealm realm)

getComponentDiscovererManager

public ComponentDiscovererManager getComponentDiscovererManager()

getComponentFactoryManager

public ComponentFactoryManager getComponentFactoryManager()

getComponentLookupManager

public ComponentLookupManager getComponentLookupManager()

getComponentManagerManager

public ComponentManagerManager getComponentManagerManager()

getComponentRealm

public ClassRealm getComponentRealm(String realmId)

getComponentRepository

public ComponentRepository getComponentRepository()

getConfiguration

public PlexusConfiguration getConfiguration()

getInterpolationConfigurationReader

protected Reader getInterpolationConfigurationReader(Reader reader)

getLifecycleHandlerManager

public LifecycleHandlerManager getLifecycleHandlerManager()

getLookupRealm

public ClassRealm getLookupRealm(Object component)

Utility method to get a default lookup realm for a component.

getParentContainer

public PlexusContainer getParentContainer()

hasChildContainer

public boolean hasChildContainer(String name)

hasComponent

public boolean hasComponent(String componentKey)

hasComponent

public boolean hasComponent(String componentKey, ClassRealm realm)

hasComponent

public boolean hasComponent(String role, String roleHint)

hasComponent

public boolean hasComponent(String role, String roleHint, ClassRealm realm)

initialize

protected void initialize(ContainerConfiguration containerConfiguration)

initializeConfiguration

protected void initializeConfiguration(ContainerConfiguration c)

initializePhases

protected void initializePhases(ContainerConfiguration containerConfiguration)

lookup

public Object lookup(String componentKey)

lookup

public Object lookup(String componentKey, ClassRealm realm)

lookup

public Object lookup(String role, String roleHint)

lookup

public Object lookup(String role, String roleHint, ClassRealm realm)

lookup

public Object lookup(Class componentClass)

lookup

public Object lookup(Class componentClass, ClassRealm realm)

lookup

public Object lookup(Class role, String roleHint)

lookup

public Object lookup(Class role, String roleHint, ClassRealm realm)

lookupList

public List lookupList(String role, ClassRealm realm)

lookupList

public List lookupList(String role, List hints)

lookupList

public List lookupList(String role, List hints, ClassRealm realm)

lookupList

public List lookupList(Class role, ClassRealm realm)

lookupList

public List lookupList(Class role, List hints)

lookupList

public List lookupList(Class role, List hints, ClassRealm realm)

lookupMap

public Map lookupMap(String role, ClassRealm realm)

lookupMap

public Map lookupMap(String role, List hints)

lookupMap

public Map lookupMap(String role, List hints, ClassRealm realm)

lookupMap

public Map lookupMap(Class role, ClassRealm realm)

lookupMap

public Map lookupMap(Class role, List hints)

lookupMap

public Map lookupMap(Class role, List hints, ClassRealm realm)

processConfigurationsDirectory

private void processConfigurationsDirectory()

Process any additional component configuration files that have been specified. The specified directory is scanned recursively so configurations can be within nested directories to help with component organization.

registerComponentDiscoveryListener

public void registerComponentDiscoveryListener(ComponentDiscoveryListener listener)

release

public void release(Object component)

releaseAll

public void releaseAll(Map components)

releaseAll

public void releaseAll(List components)

removeChildContainer

public void removeChildContainer(String name)

removeComponentDiscoveryListener

public void removeComponentDiscoveryListener(ComponentDiscoveryListener listener)

setClassWorld

public void setClassWorld(ClassWorld classWorld)

setComponentComposerManager

public void setComponentComposerManager(ComponentComposerManager componentComposerManager)

setComponentDiscovererManager

public void setComponentDiscovererManager(ComponentDiscovererManager componentDiscovererManager)

setComponentFactoryManager

public void setComponentFactoryManager(ComponentFactoryManager componentFactoryManager)

setComponentLookupManager

public void setComponentLookupManager(ComponentLookupManager componentLookupManager)

setComponentManagerManager

public void setComponentManagerManager(ComponentManagerManager componentManagerManager)

setComponentRepository

public void setComponentRepository(ComponentRepository componentRepository)

setConfiguration

public void setConfiguration(PlexusConfiguration configuration)

setContainerRealm

public void setContainerRealm(ClassRealm containerRealm)

setLifecycleHandlerManager

public void setLifecycleHandlerManager(LifecycleHandlerManager lifecycleHandlerManager)

setLoggerManager

public void setLoggerManager(LoggerManager loggerManager)

setLookupRealm

public ClassRealm setLookupRealm(ClassRealm realm)

setName

public void setName(String name)

setParentPlexusContainer

public void setParentPlexusContainer(PlexusContainer container)

setReloadingEnabled

public void setReloadingEnabled(boolean reloadingEnabled)

start

protected void start()

toStream

private InputStream toStream(String resource)