org.mule.registry
Interface RegistryComponent

All Superinterfaces:
Entry
All Known Implementing Classes:
AbstractRegistryComponent

public interface RegistryComponent
extends Entry

Author:
Guillaume Nodet

Field Summary
 
Fields inherited from interface org.mule.registry.Entry
INITIALIZED, RUNNING, SHUTDOWN, STOPPED, UNKNOWN
 
Method Summary
 void addUnit(Unit unit)
           
 List getClassPathElements()
           
 Object getComponent()
          Return the component implementation.
 RegistryDescriptor getDescriptor()
          Return the descriptor for this component.
 Library[] getLibraries()
          Retrieves the libraries that this component uses.
 javax.management.ObjectName getObjectName()
          Return the ObjectName under which the lifecycle mbean is registered.
 Registry getRegistry()
           
 ComponentType getType()
           
 Unit[] getUnits()
          Units deployed to this component
 String getWorkspaceRoot()
          Return the private component workspace
 javax.management.ObjectName initComponent()
           
 void install()
          Install this component.
 boolean isClassLoaderParentFirst()
           
 boolean isTransient()
           
 void removeUnit(Unit unit)
           
 void restoreState()
           
 void saveAndShutdown()
           
 void setClassPathElements(List elements)
           
 void setComponent(Object component)
           
 void setDescriptor(RegistryDescriptor descriptor)
           
 void setTransient(boolean isTransient)
           
 void setWorkspaceRoot(String workspaceRoot)
           
 void shutDown()
          Shut down the item.
 void start()
          Start the item.
 void stop()
          Stop the item.
 void uninstall()
          Uninstall this component.
 
Methods inherited from interface org.mule.registry.Entry
getCurrentState, getInstallRoot, getName, getStateAtShutdown, setCurrentState, setInstallRoot, setName, setStateAtShutdown
 

Method Detail

getType

public ComponentType getType()

restoreState

public void restoreState()
                  throws RegistryException
Throws:
RegistryException

saveAndShutdown

public void saveAndShutdown()
                     throws RegistryException
Throws:
RegistryException

start

public void start()
           throws RegistryException
Start the item.

Throws:
RegistryException - if the item fails to start.

stop

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

Throws:
RegistryException - if the item fails to stop.

shutDown

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

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

getLibraries

public Library[] getLibraries()
Retrieves the libraries that this component uses.

Returns:

getUnits

public Unit[] getUnits()
Units deployed to this component

Returns:

getClassPathElements

public List getClassPathElements()

setClassPathElements

public void setClassPathElements(List elements)

isClassLoaderParentFirst

public boolean isClassLoaderParentFirst()

isTransient

public boolean isTransient()

setTransient

public void setTransient(boolean isTransient)

getComponent

public Object getComponent()
Return the component implementation.

Returns:

setComponent

public void setComponent(Object component)

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

getObjectName

public javax.management.ObjectName getObjectName()
Return the ObjectName under which the lifecycle mbean is registered.

Returns:

getWorkspaceRoot

public String getWorkspaceRoot()
Return the private component workspace

Returns:

setWorkspaceRoot

public void setWorkspaceRoot(String workspaceRoot)

install

public void install()
             throws RegistryException
Install this component.

Throws:
RegistryException

uninstall

public void uninstall()
               throws RegistryException
Uninstall this component.

Throws:
RegistryException

getRegistry

public Registry getRegistry()

initComponent

public javax.management.ObjectName initComponent()
                                          throws Exception
Throws:
Exception

addUnit

public void addUnit(Unit unit)

removeUnit

public void removeUnit(Unit unit)


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