001: /*
002: * $Header: /home/cvs/jakarta-tomcat-4.0/catalina/src/share/org/apache/catalina/startup/CatalinaManagerMBean.java,v 1.3 2001/07/22 20:25:13 pier Exp $
003: * $Revision: 1.3 $
004: * $Date: 2001/07/22 20:25:13 $
005: *
006: * ====================================================================
007: *
008: * The Apache Software License, Version 1.1
009: *
010: * Copyright (c) 1999 The Apache Software Foundation. All rights
011: * reserved.
012: *
013: * Redistribution and use in source and binary forms, with or without
014: * modification, are permitted provided that the following conditions
015: * are met:
016: *
017: * 1. Redistributions of source code must retain the above copyright
018: * notice, this list of conditions and the following disclaimer.
019: *
020: * 2. Redistributions in binary form must reproduce the above copyright
021: * notice, this list of conditions and the following disclaimer in
022: * the documentation and/or other materials provided with the
023: * distribution.
024: *
025: * 3. The end-user documentation included with the redistribution, if
026: * any, must include the following acknowlegement:
027: * "This product includes software developed by the
028: * Apache Software Foundation (http://www.apache.org/)."
029: * Alternately, this acknowlegement may appear in the software itself,
030: * if and wherever such third-party acknowlegements normally appear.
031: *
032: * 4. The names "The Jakarta Project", "Tomcat", and "Apache Software
033: * Foundation" must not be used to endorse or promote products derived
034: * from this software without prior written permission. For written
035: * permission, please contact apache@apache.org.
036: *
037: * 5. Products derived from this software may not be called "Apache"
038: * nor may "Apache" appear in their names without prior written
039: * permission of the Apache Group.
040: *
041: * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
042: * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
043: * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
044: * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
045: * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
046: * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
047: * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
048: * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
049: * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
050: * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
051: * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
052: * SUCH DAMAGE.
053: * ====================================================================
054: *
055: * This software consists of voluntary contributions made by many
056: * individuals on behalf of the Apache Software Foundation. For more
057: * information on the Apache Software Foundation, please see
058: * <http://www.apache.org/>.
059: *
060: * [Additional notices, if required by prior licensing conditions]
061: *
062: */
063:
064: package org.apache.catalina.startup;
065:
066: /**
067: * Catalina MBean interface.
068: * To be used, the JAR containing this MBean should contain all the classes
069: * which are present in bootstrap.jar. The setPath(String path) method should
070: * be used to set the correct path where the Tomcat distribution is.
071: *
072: * @author <a href="mailto:remm@apache.org">Remy Maucherat</a>
073: * @version $Revision: 1.3 $
074: */
075:
076: public interface CatalinaManagerMBean {
077:
078: // -------------------------------------------------------------- Constants
079:
080: /**
081: * Status constants.
082: */
083: public static final String[] states = { "Stopped", "Stopping",
084: "Starting", "Started" };
085:
086: public static final int STOPPED = 0;
087: public static final int STOPPING = 1;
088: public static final int STARTING = 2;
089: public static final int STARTED = 3;
090:
091: /**
092: * Component name.
093: */
094: public static final String NAME = "Catalina servlet container";
095:
096: /**
097: * Object name.
098: */
099: public static final String OBJECT_NAME = ":service=Catalina";
100:
101: // ------------------------------------------------------ Interface Methods
102:
103: /**
104: * Retruns the Catalina component name.
105: */
106: public String getName();
107:
108: /**
109: * Returns the state.
110: */
111: public int getState();
112:
113: /**
114: * Returns a String representation of the state.
115: */
116: public String getStateString();
117:
118: /**
119: * Path accessor.
120: */
121: public String getPath();
122:
123: /**
124: * Path mutator.
125: */
126: public void setPath(String Path);
127:
128: /**
129: * Start the servlet container.
130: */
131: public void start() throws Exception;
132:
133: /**
134: * Stop the servlet container.
135: */
136: public void stop();
137:
138: /**
139: * Destroy servlet container (if any is running).
140: */
141: public void destroy();
142:
143: }
|