/*
* Copyright (c) 1998-2011 Caucho Technology -- all rights reserved
*
* This file is part of Resin(R) Open Source
*
* Each copy or derived work must preserve the copyright notice and this
* notice unmodified.
*
* Resin Open Source is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* Resin Open Source is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE, or any warranty
* of NON-INFRINGEMENT. See the GNU General Public License for more
* details.
*
* You should have received a copy of the GNU General Public License
* along with Resin Open Source; if not, write to the
*
* Free Software Foundation, Inc.
* 59 Temple Place, Suite 330
* Boston, MA 02111-1307 USA
*
* @author Scott Ferguson
*/
package com.caucho.env.deploy;
import com.caucho.lifecycle.LifecycleListener;
import com.caucho.lifecycle.LifecycleState;
/**
* DeployController controls the lifecycle of the DeployInstance.
*/
public interface DeployControllerApi<I extends DeployInstance>
{
/**
* Returns the controller's id, typically a tag value like
* production/webapp/default/ROOT
*/
public String getId();
/**
* Returns true if the entry matches, used for finding a matching web-app
* or host.
*/
public boolean isNameMatch(String name);
/**
* Gets the startup priority.
*/
public int getStartupPriority();
/**
* Returns the controller type
*/
public DeployControllerType getControllerType();
/**
* Merging the controller
*/
public void merge(DeployControllerApi<I> newController);
/**
* Initialization of the controller itself
*/
public boolean init();
/**
* Returns the state name.
*/
public LifecycleState getState();
/**
* Returns the current instance.
*/
public I getDeployInstance();
/**
* Returns the current instance, waiting for active.
*/
public I getActiveDeployInstance();
//
// state transition operations
//
/**
* Start the controller for initialization.
*/
public void startOnInit();
/**
* Force an instance start from an admin command.
*/
public void start();
/**
* Stops the controller from an admin command.
*/
public void stop();
/**
* Force an instance restart from an admin command.
*/
public void restart();
/**
* Check for modification updates, generally from an admin command when
* using "manual" redeployment.
*/
public void update();
/**
* Internal notification for modification updates, either from a timer
* or a repository notification. Depending on the restart mode, the
* alarm may trigger a restart.
*/
public void alarm();
/**
* Returns the instance for a top-level request
* @return the request object or null for none.
*/
public I request();
/**
* Returns the instance for a subrequest.
*
* @return the request object or null for none.
*/
public I subrequest();
/**
* Closes the controller
*/
public void close();
/**
* External lifecycle listeners, so applications can detect deployment
* and redeployment.
*/
public void addLifecycleListener(LifecycleListener listener);
}