/* * $Id: Service.java 12833 2008-10-01 22:54:08Z dfeist $ * -------------------------------------------------------------------------------------- * 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.api.service;import org.mule.api.MuleContext;import org.mule.api.MuleEvent;import org.mule.api.MuleException;import org.mule.api.MuleMessage;import org.mule.api.NamedObject;import org.mule.api.component.Component;import org.mule.api.context.MuleContextAware;import org.mule.api.lifecycle.Lifecycle;import org.mule.api.model.Model;import org.mule.api.routing.InboundRouterCollection;import org.mule.api.routing.OutboundRouterCollection;import org.mule.api.routing.ResponseRouterCollection;import org.mule.management.stats.ServiceStatistics;import java.beans.ExceptionListener;import java.io.Serializable;/** * <code>Service</code> is the internal representation of a Mule Managed service. It * is responsible for managing the interaction of events to and from the service as * well as managing pooled resources. */public interface Service extends Serializable, Lifecycle, MuleContextAware, NamedObject{    /**     * Makes an asynchronous event call to the service.     *      * @param event the event to consume     * @throws MuleException if the event fails to be processed     */    void dispatchEvent(MuleEvent event) throws MuleException;    /**     * Makes a synchronous event call to the service. This event will be consumed by     * the service and a result returned.     *      * @param event the event to consume     * @return a MuleMessage containing the resulting message and properties     * @throws MuleException if the event fails to be processed     */    MuleMessage sendEvent(MuleEvent event) throws MuleException;    /**     * Determines whether this service has been started     *      * @return true is the service is started and ready to receive events     */    boolean isStarted();    /**     * Pauses event processing for a single Mule Service. Unlike stop(), a paused     * service will still consume messages from the underlying transport, but those     * messages will be queued until the service is resumed.     */    void pause() throws MuleException;    /**     * Resumes a single Mule Service that has been paused. If the service is not     * paused nothing is executed.     */    void resume() throws MuleException;    /**     * True if the service is in a paused state, false otherwise     *      * @return True if the service is in a paused state, false otherwise     */    boolean isPaused();        /**     * The exception strategy to use to handle exceptions in the Mule UMO.     *     * @return the exception strategy to use. If none has been set a default will be     *         used.     */    ExceptionListener getExceptionListener();    /**     * Inbound Routers control how events are received by a service. If no router is     * set. A default will be used that uses the inboundProvider set on his     * descriptor.     *      * @return the inbound router for this service. This will always return a valid     *         router.     * @see InboundRouterCollection     */    InboundRouterCollection getInboundRouter();    /**     * Outbound Routers control how events are published by a service once. the     * event has been processed. If no router is set. A default will be used that     * uses the outboundProvider set on his descriptor to route the event.     *     * @return the outbound router for this service     * @see OutboundRouterCollection     */    OutboundRouterCollection getOutboundRouter();    /**     * Response Routers control how events are returned in a request/response call.     * It can be use to aggregate response events before returning, thus acting as a     * Join in a forked process. This can be used to make request/response calls a     * lot more efficient as independent tasks can be forked, execute concurrently     * and then join before the request completes     *     * @return the response router for this service     * @see ResponseRouterCollection     */    ResponseRouterCollection getResponseRouter();    /**     * Returns the initial state of this service     *     * @return the initial state of this service     */    String getInitialState();    /**     * Returns the name of the model that this descriptor is registered with.     * @return the name of the model that this descriptor is registered with or null     *         if this descriptor has not been registered with a model yet     */    Model getModel();    /**     * The exception strategy to use to handle exceptions in the Mule UMO.     *      * @param listener the exception strategy to use. If none has been set or     *            argument is null a default     */    void setExceptionListener(ExceptionListener listener);    /**     * Inbound Routers control how events are received by a service. If no router is     * set. A default will be used that uses the inboundProvider set on his     * descriptor.     *     * @param router the inbound router for this service     * @see InboundRouterCollection     */    void setInboundRouter(InboundRouterCollection router);    /**     * Outbound Routers control how events are published by a service once. the     * event has been processed. If no router is set. A default will be used that     * uses the outboundProvider set on his descriptor to route the event.     *     * @param router the outbound router for this service     * @see OutboundRouterCollection     */    void setOutboundRouter(OutboundRouterCollection router);    /**     * Response Routers control how events are returned in a request/response call.     * It can be use to aggregate response events before returning, thus acting as a     * Join in a forked process. This can be used to make request/response calls a     * lot more efficient as independent tasks can be forked, execute concurrently     * and then join before the request completes     *     * @param router the response router for this service     * @see org.mule.api.routing.ResponseRouterCollection     */    void setResponseRouter(ResponseRouterCollection router);    /**     * Sets the initial state of this service     *     * @param state the initial state of this service     * @see org.mule.ImmutableMuleDescriptor#INITIAL_STATE_STARTED     * @see org.mule.ImmutableMuleDescriptor#INITIAL_STATE_STOPPED     * @see org.mule.ImmutableMuleDescriptor#INITIAL_STATE_PAUSED     */    void setInitialState(String state);    /**     * Sets the Model name that this descriptor is registered within.     * @param modelName name of the model     */    void setModel(Model model);    /**     * Returns the Component that is a invoked by a {@link Service} for each incoming     * {@link MuleEvent} routed on by the {@link InboundRouterCollection}.     *      * @return     */    Component getComponent();    /**     * Sets the Component that is a invoked by a {@link Service} for each incoming     * {@link MuleEvent} routed on by the {@link InboundRouterCollection}.     *      * @param component     */    void setComponent(Component component);        /**     * Returns the Service statistics.  This provides Service router and component statistics.     * @return     */    ServiceStatistics getStatistics();        MuleContext getMuleContext();}