org.mule.umo.manager
Interface UMOContainerContext

All Superinterfaces:
Disposable, Initialisable
All Known Implementing Classes:
AbstractContainerContext, MultiContainerContext

public interface UMOContainerContext
extends Initialisable, Disposable

UMOContainerContext defines the contract between Mule and an underlying container such as String or Pico.

Version:
$Revision: 1.3 $
Author:
Ross Mason

Method Summary
 void configure(java.io.Reader configuration, java.lang.String doctype, java.lang.String encoding)
          This method will be called if there is a configuration fragement for the container to use to configure itself.
 java.lang.Object getComponent(java.lang.Object key)
          Queries a component from the underlying container
 java.lang.String getName()
          Gets the identifying name of the container
 void setName(java.lang.String name)
          The identifying name of the container.
 
Methods inherited from interface org.mule.umo.lifecycle.Initialisable
initialise
 
Methods inherited from interface org.mule.umo.lifecycle.Disposable
dispose
 

Method Detail

setName

public void setName(java.lang.String name)
The identifying name of the container. Note that implementations should provide a default name that users can choose to override The name can be used to reference a container when more than one is registered

Parameters:
name - the identifying name of the container

getName

public java.lang.String getName()
Gets the identifying name of the container

Returns:
the identifying name of the container

getComponent

public java.lang.Object getComponent(java.lang.Object key)
                              throws ObjectNotFoundException
Queries a component from the underlying container

Parameters:
key - the key fo find the component with. Its up to the individual implementation to check the type of this key and look up objects accordingly
Returns:
The component found in the container
Throws:
ObjectNotFoundException - if the component is not found

configure

public void configure(java.io.Reader configuration,
                      java.lang.String doctype,
                      java.lang.String encoding)
               throws ContainerException
This method will be called if there is a configuration fragement for the container to use to configure itself. In Mule Xml the fragment is Xml that is embedded in the <configuration> element of the <container-context$gt; element.

Parameters:
configuration -
doctype - the doctype declaration to use for the configuration fragment. can be null if no validation is to be performed or the fragment is not Xml
encoding - the encoding to use in the Xml declaration. Default is UTF-8
Throws:
ContainerException


Copyright © 2003-2005 SymphonySoft Limited. All Rights Reserved.