1 /*
2 * Copyright (c) 2003, Andreas Pataki
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions are
7 * met:
8 *
9 * Redistributions of source code must retain the above copyright notice,
10 * this list of conditions and the following disclaimer.
11 *
12 * Redistributions in binary form must reproduce the above copyright notice,
13 * this list of conditions and the following disclaimer in the documentation
14 * and/or other materials provided with the distribution.
15 *
16 * Neither the name of the author nor the names of its contributors
17 * may be used to endorse or promote products derived from this software
18 * without specific prior written permission.
19 *
20 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER AND CONTRIBUTORS ``AS
21 * IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
22 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
23 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE
24 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
25 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
29 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
30 * POSSIBILITY OF SUCH DAMAGE.
31 */
32 package net.sf.tm;
33
34 import java.util.List;
35
36 /***
37 * Interface for a Context Manager. The context manager provides all methods
38 * for managing context in a running web server.
39 *
40 * @author Andreas Pataki
41 * @version $Id: IContextManager.java,v 1.1 2003/08/17 12:20:34 apataki Exp $
42 */
43 public interface IContextManager {
44
45 /***
46 * Starts a context by it's name. The context must be stoped.
47 *
48 * @param context Name of the context which should be started
49 * @throws ContextManagerException The context couldn't be started.
50 * Check Stacktrace for reason.
51 */
52 void start(String context) throws ContextManagerException;
53
54 /***
55 * Stops a context by it's name. The context must be started.
56 *
57 * @param context The name of the context to be stopped.
58 * @throws ContextManagerException The context couldn't be stoped.
59 * Check Stacktrace for reason.
60 */
61 void stop(String context) throws ContextManagerException;
62
63 /***
64 * Reloads a context by it's name. The context must be started.
65 *
66 * @param context The name of the context to be reloaded.
67 * @throws ContextManagerException The context couldn't be reloaded.
68 * Check Stacktrace for reason.
69 */
70 void reload(String context) throws ContextManagerException;
71
72 /***
73 * Returns a list of all available context's.
74 *
75 * @return List of {@link WebContext} objects
76 * @throws ContextManagerException The context list couldn't be retrived.
77 * Check Stacktrace for reason.
78 */
79 List getAll() throws ContextManagerException;
80
81
82 }