org.fabric3.spi.container.component.Component Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of fabric3-spi Show documentation

Fabric3

There is a newer version: 3.0.0

/*
 * Fabric3
 * Copyright (c) 2009-2015 Metaform Systems
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 * Portions originally based on Apache Tuscany 2007
 * licensed under the Apache 2.0 license.
 */
package org.fabric3.spi.container.component;

import java.net.URI;
import javax.xml.namespace.QName;

import org.fabric3.api.host.monitor.Monitorable;

/**
 * The runtime instantiation of an SCA component
 */
public interface Component extends Monitorable {

    /**
     * Returns the QName of the deployable composite this component was deployed with.
     *
     * @return the group containing this component
     */
    QName getDeployable();

    /**
     * Returns the component URI.
     *
     * @return the component URI
     */
    URI getUri();

    /**
     * Returns the classloader the component is associated with.
     *
     * @return the classloader the component is associated with.
     */
    URI getClassLoaderId();

    /**
     * Sets the classloader the component is associated with.
     *
     * @param classLoaderId the classloader the component is associated with.
     */
    void setClassLoaderId(URI classLoaderId);

    /**
     * Starts the component;
     *
     * @throws ComponentException if an error occurs starting the component
     */
    void start() throws ComponentException;

    /**
     * Stops the component.
     *
     * @throws ComponentException if an error occurs stopping the component
     */
    void stop() throws ComponentException;

    /**
     * Used to signal the start of a component configuration update.
     */
    void startUpdate();

    /**
     * Used to signal when a component configuration update is complete.
     */
    void endUpdate();

}