001: /*
002: * Copyright (c) 1998-2008 Caucho Technology -- all rights reserved
003: *
004: * This file is part of Resin(R) Open Source
005: *
006: * Each copy or derived work must preserve the copyright notice and this
007: * notice unmodified.
008: *
009: * Resin Open Source is free software; you can redistribute it and/or modify
010: * it under the terms of the GNU General Public License as published by
011: * the Free Software Foundation; either version 2 of the License, or
012: * (at your option) any later version.
013: *
014: * Resin Open Source is distributed in the hope that it will be useful,
015: * but WITHOUT ANY WARRANTY; without even the implied warranty of
016: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE, or any warranty
017: * of NON-INFRINGEMENT. See the GNU General Public License for more
018: * details.
019: *
020: * You should have received a copy of the GNU General Public License
021: * along with Resin Open Source; if not, write to the
022: *
023: * Free Software Foundation, Inc.
024: * 59 Temple Place, Suite 330
025: * Boston, MA 02111-1307 USA
026: *
027: * @author Scott Ferguson
028: */
029:
030: package com.caucho.server.deploy;
031:
032: /**
033: * DeployController controls the lifecycle of the DeployInstance.
034: *
035: * <h3>States</h3>
036: *
037: * <ul>
038: * <li>active - responds to requests normally
039: * <li>modified - active with a dependency change like a web.xml
040: * <li>active-idle - active idle state, which can be stopped on timeout
041: * <li>active-error - configuration error (before timeout)
042: * <li>error - configuration error (after timeout)
043: * <li>stop - admin stop, refuses requests with a 503
044: * <li>stop-lazy - lazy stop
045: * </ul>
046: *
047: * error-wait is equivalent to the active state. idle and inactive only
048: * applies to startup=lazy.
049: *
050: * <h3>events</h3>
051: *
052: * <ul>
053: * <li>startOnInit - called at startup time for automatic start
054: * <li>start - admin start
055: * <li>stop - admin stop
056: * <li>update - admin update/restart, ends up in initial state
057: * <li>request - top-level request
058: * <li>subrequest - include/forward
059: * <li>alarm - timeout
060: * <li>
061: */
062: public interface DeployControllerStrategy {
063: /**
064: * Called at initialization time for automatic start.
065: *
066: * @param controller the owning controller
067: */
068: public <I extends DeployInstance> void startOnInit(
069: DeployController<I> controller);
070:
071: /**
072: * Starts the instance from an admin command.
073: *
074: * @param controller the owning controller
075: */
076: public <I extends DeployInstance> void start(
077: DeployController<I> controller);
078:
079: /**
080: * Stops the instance from an admin command.
081: *
082: * @param controller the owning controller
083: */
084: public <I extends DeployInstance> void stop(
085: DeployController<I> controller);
086:
087: /**
088: * Checks for updates from an admin command. The target state will be the
089: * initial state, i.e. update will not start a lazy instance.
090: *
091: * @param controller the owning controller
092: */
093: public <I extends DeployInstance> void update(
094: DeployController<I> controller);
095:
096: /**
097: * On a top-level request, returns the deploy instance, starting if necessary.
098: *
099: * @param controller the owning controller
100: * @return the active deploy instance or null if none are active
101: */
102: /* XXX: should request always return an instance? */
103: public <I extends DeployInstance> I request(
104: DeployController<I> controller);
105:
106: /**
107: * On a sub-request, returns the deploy instance, starting if necessary.
108: *
109: * @param controller the owning controller
110: * @return the active deploy instance or null if none are active
111: */
112: /* XXX: should request always return an instance? */
113: public <I extends DeployInstance> I subrequest(
114: DeployController<I> controller);
115:
116: /**
117: * On a timeout, update or restart as necessary.
118: *
119: * @param controller the owning controller
120: */
121: public <I extends DeployInstance> void alarm(
122: DeployController<I> controller);
123:
124: }
|