abstractservice.java

一个工作流设计及定义的系统,可以直接与数据库结合进行系统工作流程的定义及应用.

/*
 * Copyright (c) 2005, John Mettraux, OpenWFE.org
 * All rights reserved.
 * 
 * Redistribution and use in source and binary forms, with or without 
 * modification, are permitted provided that the following conditions are met:
 * 
 * . Redistributions of source code must retain the above copyright notice, this
 *   list of conditions and the following disclaimer.  
 * 
 * . Redistributions in binary form must reproduce the above copyright notice, 
 *   this list of conditions and the following disclaimer in the documentation 
 *   and/or other materials provided with the distribution.
 * 
 * . Neither the name of the "OpenWFE" nor the names of its contributors may be
 *   used to endorse or promote products derived from this software without
 *   specific prior written permission.
 * 
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE 
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 
 * POSSIBILITY OF SUCH DAMAGE.
 *
 * $Id: AbstractService.java,v 1.5 2005/05/17 16:40:12 jmettraux Exp $
 */

//
// AbstractService.java
//
// [e-mail]
//
// generated with 
// jtmpl 1.0.04 31.10.2002 John Mettraux ([e-mail])
//

package openwfe.org;

import openwfe.org.state.PausedState;
import openwfe.org.state.RunningState;
import openwfe.org.state.StoppedState;
import openwfe.org.state.ServiceState;


/**
 * A classical service, Service with particular needs should extend
 * this class.
 *
 * <p><font size=2>CVS Info :
 * <br>$Author: jmettraux $
 * <br>$Date: 2005/05/17 16:40:12 $
 * <br>$Id: AbstractService.java,v 1.5 2005/05/17 16:40:12 jmettraux Exp $ </font>
 *
 * @author [e-mail]
 */
public abstract class AbstractService

    implements Service

{

    private final static org.apache.log4j.Logger log = org.apache.log4j.Logger
        .getLogger(AbstractService.class.getName());

    //
    // CONSTANTS (definitions)

    //
    // FIELDS

    private String name = null;
    private ApplicationContext context = null;
    private java.util.Map serviceParams = null;

    private ServiceState serviceState = null;

    //
    // CONSTRUCTORS

    //
    // METHODS from Service

    /**
     * will get overriden by child RemoteService
     */
    public void init 
        (final String serviceName, 
         final ApplicationContext context, 
         final java.util.Map serviceParams)
    throws 
        ServiceException
    {
        this.name = serviceName;
        this.context = context;
        this.serviceParams = serviceParams;

        this.serviceState = new RunningState();
    }

    /**
     * If the service is not running, will start it.
     */
    public void play ()
    {
        log.info("play() requested for service '"+getName()+"'");

        if ( ! this.isRunning()) this.serviceState = new RunningState();
    }

    /**
     * If the service is running, will pause it.
     */
    public void pause ()
    {
        log.info("pause() requested for service '"+getName()+"'");

        if (this.isRunning()) this.serviceState = new PausedState();
    }

    /**
     * Stops the service
     */
    public void stop ()
        throws ServiceException
    {
        log.info("stop() requested for service '"+getName()+"'");

        this.serviceState = new StoppedState();
    }

    /**
     * Returns a ServiceState instance which tells if the service is running,
     * paused or stopped and since when. Other ServiceState implementations
     * may also be returned of course.
     */
    public ServiceState getState () 
    {
        return this.serviceState;
    }

    /**
     * Protected : sets the state of the service.
     */
    protected void setState (ServiceState state)
    {
        this.serviceState = state;
    }

    /**
     * Returns the name associated to this service (usually found in the
     * XML configuration file describing the services).
     */
    public String getName ()
    {
        return this.name;
    }

    /**
     * Returns the context to which this service belongs.
     */
    public ApplicationContext getContext ()
    {
        return this.context;
    }

    /**
     * Returns the params passed to this service for its initialization.
     */
    public java.util.Map getParams ()
    {
        return java.util.Collections.unmodifiableMap(this.serviceParams);
    }

    /**
     * Returns the status (not the state) of this service.
     */
    public org.jdom.Element getStatus ()
    {
        return new org.jdom.Element(this.name);
    }

    /**
     * Returns true if the service is in the RunningState ServiceState.
     */
    public boolean isRunning ()
    {
        return getState() instanceof RunningState;
    }

    //
    // METHODS

}