org.codehaus.plexus

Interface PlexusContainer

Known Implementing Classes:
DefaultPlexusContainer

public interface PlexusContainer

Field Summary

static String
ROLE

Method Summary

void
addComponentDescriptor(ComponentDescriptor componentDescriptor)
void
addContextValue(Object key, Object value)
void
addJarRepository(File repository)
void
addJarResource(File resource)
void
composeComponent(Object component, ComponentDescriptor componentDescriptor)
PlexusContainer
createChildContainer(String name, List classpathJars, Map context)
PlexusContainer
createChildContainer(String name, List classpathJars, Map context, List discoveryListeners)
Object
createComponentInstance(ComponentDescriptor componentDescriptor)
void
dispose()
PlexusContainer
getChildContainer(String name)
ComponentDescriptor
getComponentDescriptor(String componentKey)
List
getComponentDescriptorList(String role)
Map
getComponentDescriptorMap(String role)
ClassRealm
getComponentRealm(String componentKey)
Deprecated. Use getContainerRealm() instead.
ClassRealm
getContainerRealm()
Context
getContext()
Date
getCreationDate()
Logger
getLogger()
LoggerManager
getLoggerManager()
boolean
hasChildContainer(String name)
boolean
hasComponent(String componentKey)
boolean
hasComponent(String role, String roleHint)
void
initialize()
boolean
isInitialized()
boolean
isStarted()
Object
lookup(String componentKey)
Object
lookup(String role, String roleHint)
List
lookupList(String role)
Map
lookupMap(String role)
void
registerComponentDiscoveryListener(ComponentDiscoveryListener listener)
void
release(Object component)
void
releaseAll(List components)
void
releaseAll(Map components)
void
removeChildContainer(String name)
void
removeComponentDiscoveryListener(ComponentDiscoveryListener listener)
void
resume(Object component)
void
setConfigurationResource(Reader configuration)
void
setLoggerManager(LoggerManager loggerManager)
void
setParentPlexusContainer(PlexusContainer parentContainer)
void
start()
void
suspend(Object component)

Field Details

ROLE

public static final String ROLE

Method Details

addComponentDescriptor

public void addComponentDescriptor(ComponentDescriptor componentDescriptor)
            throws ComponentRepositoryException

addContextValue

public void addContextValue(Object key,
                            Object value)

addJarRepository

public void addJarRepository(File repository)

addJarResource

public void addJarResource(File resource)
            throws PlexusContainerException

composeComponent

public void composeComponent(Object component,
                             ComponentDescriptor componentDescriptor)
            throws CompositionException,
                   UndefinedComponentComposerException

createChildContainer

public PlexusContainer createChildContainer(String name,
                                            List classpathJars,
                                            Map context)
            throws PlexusContainerException

createChildContainer

public PlexusContainer createChildContainer(String name,
                                            List classpathJars,
                                            Map context,
                                            List discoveryListeners)
            throws PlexusContainerException

createComponentInstance

public Object createComponentInstance(ComponentDescriptor componentDescriptor)
            throws ComponentInstantiationException,
                   ComponentLifecycleException

dispose

public void dispose()

getChildContainer

public PlexusContainer getChildContainer(String name)

getComponentDescriptor

public ComponentDescriptor getComponentDescriptor(String componentKey)

getComponentDescriptorList

public List getComponentDescriptorList(String role)

getComponentDescriptorMap

public Map getComponentDescriptorMap(String role)

getComponentRealm

public ClassRealm getComponentRealm(String componentKey)

Deprecated. Use getContainerRealm() instead.


getContainerRealm

public ClassRealm getContainerRealm()

getContext

public Context getContext()

getCreationDate

public Date getCreationDate()

getLogger

public Logger getLogger()

getLoggerManager

public LoggerManager getLoggerManager()

hasChildContainer

public boolean hasChildContainer(String name)

hasComponent

public boolean hasComponent(String componentKey)

hasComponent

public boolean hasComponent(String role,
                            String roleHint)

initialize

public void initialize()
            throws PlexusContainerException

isInitialized

public boolean isInitialized()

isStarted

public boolean isStarted()

lookup

public Object lookup(String componentKey)
            throws ComponentLookupException

lookup

public Object lookup(String role,
                     String roleHint)
            throws ComponentLookupException

lookupList

public List lookupList(String role)
            throws ComponentLookupException

lookupMap

public Map lookupMap(String role)
            throws ComponentLookupException

registerComponentDiscoveryListener

public void registerComponentDiscoveryListener(ComponentDiscoveryListener listener)

release

public void release(Object component)
            throws ComponentLifecycleException

releaseAll

public void releaseAll(List components)
            throws ComponentLifecycleException

releaseAll

public void releaseAll(Map components)
            throws ComponentLifecycleException

removeChildContainer

public void removeChildContainer(String name)

removeComponentDiscoveryListener

public void removeComponentDiscoveryListener(ComponentDiscoveryListener listener)

resume

public void resume(Object component)
            throws ComponentLifecycleException

setConfigurationResource

public void setConfigurationResource(Reader configuration)
            throws PlexusConfigurationResourceException

setLoggerManager

public void setLoggerManager(LoggerManager loggerManager)

setParentPlexusContainer

public void setParentPlexusContainer(PlexusContainer parentContainer)

start

public void start()
            throws PlexusContainerException

suspend

public void suspend(Object component)
            throws ComponentLifecycleException