org.mule.registry.RegistryComponent Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of mule-module-registry Show documentation
Mule Registry for distributed configurations
The newest version!
/*
 * $Id: RegistryComponent.java 7976 2007-08-21 14:26:13Z dirk.olmes $
 * --------------------------------------------------------------------------------------
 * Copyright (c) MuleSource, Inc.  All rights reserved.  http://www.mulesource.com
 *
 * The software in this package is published under the terms of the CPAL v1.0
 * license, a copy of which has been included with this distribution in the
 * LICENSE.txt file.
 */

package org.mule.registry;

import java.util.List;

import javax.management.ObjectName;

/**
 * @author Guillaume Nodet
 */
public interface RegistryComponent extends Entry
{

    ComponentType getType();

    void restoreState() throws RegistryException;

    void saveAndShutdown() throws RegistryException;

    /**
     * Start the item.
     * 
     * @exception RegistryException if the item fails to start.
     */
    void start() throws RegistryException;

    /**
     * Stop the item. This suspends current messaging activities.
     * 
     * @exception RegistryException if the item fails to stop.
     */
    void stop() throws RegistryException;

    /**
     * Shut down the item. The releases resources, preparatory to uninstallation.
     * 
     * @exception RegistryException if the item fails to shut down.
     */
    void shutDown() throws RegistryException;

    /**
     * Retrieves the libraries that this component uses.
     * 
     * @return
     */
    Library[] getLibraries();

    /**
     * Units deployed to this component
     * 
     * @return
     */
    Unit[] getUnits();

    /**
     *
     */
    List getClassPathElements();

    void setClassPathElements(List elements);

    boolean isClassLoaderParentFirst();

    boolean isTransient();

    void setTransient(boolean isTransient);

    /**
     * Return the component implementation.
     * 
     * @return
     */
    Object getComponent();

    void setComponent(Object component);

    /**
     * Return the descriptor for this component.
     * 
     * @return
     */
    RegistryDescriptor getDescriptor() throws RegistryException;

    void setDescriptor(RegistryDescriptor descriptor) throws RegistryException;

    /**
     * Return the ObjectName under which the lifecycle mbean is registered.
     * 
     * @return
     */
    ObjectName getObjectName();

    /**
     * Return the private component workspace
     * 
     * @return
     */
    String getWorkspaceRoot();

    void setWorkspaceRoot(String workspaceRoot);

    /**
     * Install this component.
     * 
     * @throws RegistryException
     */
    void install() throws RegistryException;

    /**
     * Uninstall this component.
     * 
     * @throws RegistryException
     */
    void uninstall() throws RegistryException;

    Registry getRegistry();

    ObjectName initComponent() throws Exception;

    void addUnit(Unit unit);

    void removeUnit(Unit unit);
}