/*
* ========================================================================
*
* Copyright 2003 The Apache Software Foundation.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
* ========================================================================
*/
package org.apache.cactus.integration.ant.container;
import java.util.ArrayList;
import java.util.Iterator;
import java.util.List;
import org.apache.tools.ant.BuildException;
import org.apache.tools.ant.Task;
import org.apache.tools.ant.TaskContainer;
import org.apache.tools.ant.taskdefs.CallTarget;
/**
* A generic container that can be nested in the
* {@link org.apache.cactus.integration.ant.CactusTask} to support complete
* customization of the container lifecycle from a build file.
*
* @version $Id: GenericContainer.java 238811 2004-02-29 10:10:42Z vmassol $
*/
public final class GenericContainer extends AbstractContainer
{
// Inner Classes -----------------------------------------------------------
/**
* Class that represents the nested 'startup' and 'shutdown' elements. It
* supports either an Ant target to delegate to, or a list of nested tasks
* that are to be executed in order to perform the operation.
*/
public final class Hook implements TaskContainer
{
// Instance Variables --------------------------------------------------
/**
* The target to call when the hook is executed.
*/
private String target;
/**
* Ordered list of the contained tasks that should be invoked when the
* hook is executed.
*/
private List tasks = new ArrayList();
// Public Methods ------------------------------------------------------
/**
* Sets the target to call.
*
* @param theTarget The name of the target
*/
public void setTarget(String theTarget)
{
if (!this.tasks.isEmpty())
{
throw new BuildException("The generic element supports either "
+ "a [target] attribute or nested tasks, but not both");
}
this.target = theTarget;
}
/**
* @see org.apache.tools.ant.TaskContainer#addTask
*/
public void addTask(Task theTask) throws BuildException
{
if (this.target != null)
{
throw new BuildException("The generic element supports either "
+ "a [target] attribute or nested tasks, but not both");
}
this.tasks.add(theTask);
}
/**
* Executes the hook by either calling the specified target, or invoking
* all nested tasks.
*
* @throws BuildException If thrown by the called target or one of the
* nested tasks
*/
public void execute() throws BuildException
{
if (this.target != null)
{
CallTarget antCall = (CallTarget) createAntTask("antcall");
antCall.setInheritAll(true);
antCall.setInheritRefs(true);
antCall.init();
antCall.setTarget(this.target);
antCall.execute();
}
else
{
for (Iterator i = this.tasks.iterator(); i.hasNext();)
{
Task task = (Task) i.next();
task.perform();
}
}
}
}
// Instance Variables ------------------------------------------------------
/**
* Name of the container for logging purposes.
*/
private String name = "Unknown Container";
/**
* The hook that is called when the container should be started.
*/
private Hook startUpHook;
/**
* The hook that is called when the container should be shut down.
*/
private Hook shutDownHook;
/**
* The port to which the container should be bound.
*/
private int port = 8080;
// Public Methods ----------------------------------------------------------
/**
* Creates a nested 'startup' element.
*
* @return The new hook element
* @throws BuildException If a startup hook has already been added
*/
public Hook createStartUp() throws BuildException
{
if (isStartUpSet())
{
throw new BuildException("The container element supports only one"
+ "nested [startup] element");
}
this.startUpHook = new Hook();
return this.startUpHook;
}
/**
* Creates a nested 'shutdown' element.
*
* @return The new hook element
* @throws BuildException If a shutdown hook has already been added
*/
public Hook createShutDown() throws BuildException
{
if (isShutDownSet())
{
throw new BuildException("The container element supports only one"
+ "nested [shutdown] element");
}
this.shutDownHook = new Hook();
return this.shutDownHook;
}
/**
* Returns whether a way to start the container has already been set, either
* as a target, or as a nested task container.
*
* @return <code>true</code> if the shut down procedure has been set
*/
public boolean isShutDownSet()
{
return (this.shutDownHook != null);
}
/**
* Returns whether a way to stop the container has already been set, either
* as a target, or as a nested task container.
*
* @return <code>true</code> if the start up procedure has been set
*/
public boolean isStartUpSet()
{
return (this.startUpHook != null);
}
/**
* Sets the name of the container for logging purposes.
*
* @param theName The container name
*/
public void setName(String theName)
{
this.name = theName;
}
/**
* Sets the port to which the container should listen.
*
* @param thePort The port to set
*/
public void setPort(int thePort)
{
this.port = thePort;
}
/**
* Sets the target to call to start the server.
*
* @param theStartUpTarget the Ant target to call
*/
public void setStartUpTarget(String theStartUpTarget)
{
if (isStartUpSet())
{
throw new BuildException("Either specify the [startuptarget] "
+ "attribute or the nested [startup] element, but not both");
}
this.startUpHook = new Hook();
this.startUpHook.setTarget(theStartUpTarget);
}
/**
* Sets the target to call to stop the server.
*
* @param theShutDownTarget the Ant target to call
*/
public void setShutDownTarget(String theShutDownTarget)
{
if (isShutDownSet())
{
throw new BuildException("Either specify the [shutdowntarget] "
+ "attribute or the nested [shutdown] element, but not both");
}
this.shutDownHook = new Hook();
this.shutDownHook.setTarget(theShutDownTarget);
}
// AbstractContainer Implementation ----------------------------------------
/**
* @see org.apache.cactus.integration.ant.container.Container#getName
*/
public String getName()
{
return this.name;
}
/**
* Returns the port to which the container should listen.
*
* @return The port
*/
public int getPort()
{
return this.port;
}
/**
* Starts up the container by delegating to the startup hook.
*
* @throws BuildException If thrown by the startup hook
*/
public void startUp() throws BuildException
{
if (this.startUpHook != null)
{
this.startUpHook.execute();
}
}
/**
* Shuts down the container by delegating to the shutdown hook.
*
* @throws BuildException If thrown by the shutdown hook
*/
public void shutDown() throws BuildException
{
if (this.shutDownHook != null)
{
this.shutDownHook.execute();
}
}
}