org.mule.registry
Interface Assembly

All Superinterfaces:
Entry
All Known Implementing Classes:
AbstractAssembly

public interface Assembly
extends Entry

Author:
Guillaume Nodet

Field Summary
 
Fields inherited from interface org.mule.registry.Entry
INITIALIZED, RUNNING, SHUTDOWN, STOPPED, UNKNOWN
 
Method Summary
 String deploy()
           
 RegistryDescriptor getDescriptor()
          Return the descriptor for this component.
 Unit getUnit(String name)
          Return the Unit of the given name.
 Unit[] getUnits()
          Get all units of this Assembly
 boolean isTransient()
           
 void restoreState()
           
 void saveAndShutdown()
           
 void setDescriptor(RegistryDescriptor descriptor)
           
 void setTransient(boolean isTransient)
           
 String shutDown()
          Shut down the item.
 String start()
          Start the item.
 String stop()
          Stop the item.
 String undeploy()
           
 
Methods inherited from interface org.mule.registry.Entry
getCurrentState, getInstallRoot, getName, getStateAtShutdown, setCurrentState, setInstallRoot, setName, setStateAtShutdown
 

Method Detail

restoreState

public void restoreState()
                  throws RegistryException
Throws:
RegistryException

saveAndShutdown

public void saveAndShutdown()
                     throws RegistryException
Throws:
RegistryException

isTransient

public boolean isTransient()

setTransient

public void setTransient(boolean isTransient)

start

public String start()
             throws RegistryException
Start the item.

Throws:
RegistryException - if the item fails to start.

stop

public String stop()
            throws RegistryException
Stop the item. This suspends current messaging activities.

Throws:
RegistryException - if the item fails to stop.

shutDown

public String shutDown()
                throws RegistryException
Shut down the item. The releases resources, preparatory to uninstallation.

Throws:
RegistryException - if the item fails to shut down.

getUnit

public Unit getUnit(String name)
Return the Unit of the given name.

Parameters:
name - the name of the unit
Returns:
the Unit or null if not found

getUnits

public Unit[] getUnits()
Get all units of this Assembly

Returns:
the units of this Assembly

getDescriptor

public RegistryDescriptor getDescriptor()
                                 throws RegistryException
Return the descriptor for this component.

Returns:
Throws:
RegistryException

setDescriptor

public void setDescriptor(RegistryDescriptor descriptor)
                   throws RegistryException
Throws:
RegistryException

deploy

public String deploy()
              throws RegistryException
Throws:
RegistryException

undeploy

public String undeploy()
                throws RegistryException
Throws:
RegistryException


Copyright © 2003-2008 MuleSource, Inc.. All Rights Reserved.