Cactus 1.5 for J2EE API 1.2

Clover coverage report - Cactus 1.5 for J2EE API 1.2

Coverage timestamp: Wed Feb 18 2004 09:04:33 EST

FRAMES NO FRAMES

file stats:	LOC:	219		Methods:	8
	NCLOC:	71		Classes:	1

Source file

Conditionals

Statements

Methods

TOTAL

AbstractJavaContainer.java

 /*
  * ====================================================================
  *
  * The Apache Software License, Version 1.1
  *
  * Copyright (c) 2003 The Apache Software Foundation.  All rights
  * reserved.
  *
  * Redistribution and use in source and binary forms, with or without
  * modification, are permitted provided that the following conditions
  * are met:
  *
  * 1. Redistributions of source code must retain the above copyright
  *    notice, this list of conditions and the following disclaimer.
  *
  * 2. Redistributions in binary form must reproduce the above copyright
  *    notice, this list of conditions and the following disclaimer in
  *    the documentation and/or other materials provided with the
  *    distribution.
  *
  * 3. The end-user documentation included with the redistribution, if
  *    any, must include the following acknowlegement:
  *       "This product includes software developed by the
  *        Apache Software Foundation (http://www.apache.org/)."
  *    Alternately, this acknowlegement may appear in the software itself,
  *    if and wherever such third-party acknowlegements normally appear.
  *
  * 4. The names "The Jakarta Project", "Cactus" and "Apache Software
  *    Foundation" must not be used to endorse or promote products
  *    derived from this software without prior written permission. For
  *    written permission, please contact apache@apache.org.
  *
  * 5. Products derived from this software may not be called "Apache"
  *    nor may "Apache" appear in their names without prior written
  *    permission of the Apache Group.
  *
  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  * SUCH DAMAGE.
  * ====================================================================
  *
  * This software consists of voluntary contributions made by many
  * individuals on behalf of the Apache Software Foundation.  For more
  * information on the Apache Software Foundation, please see
  * <http://www.apache.org/>.
  *
  */
 package org.apache.cactus.integration.ant.container;
 
 import java.io.File;
 import java.io.FileNotFoundException;
 
 import org.apache.tools.ant.taskdefs.Java;
 import org.apache.tools.ant.types.Path;
 import org.apache.tools.ant.types.Environment.Variable;
 
 /**
  * Abstract base class for containers that perform the starting and stopping
  * of the server by executing Java classes in a forked JVM.
  * 
  * @author <a href="mailto:cmlenz@apache.org">Christopher Lenz</a>
  * 
  * @version $Id: AbstractJavaContainer.java,v 1.2.2.1 2003/10/23 18:20:43 vmassol Exp $
  */
 public abstract class AbstractJavaContainer extends AbstractContainer
 {
     // Instance Variables ------------------------------------------------------
 
     /**
      * The file to which output of the container should be written.
      */
     private File output;
 
     /**
      * Whether output of the container should be appended to an existing file, 
      * or the existing file should be truncated.
      */
     private boolean append;
 
     // Public Methods ----------------------------------------------------------
 
     /**
      * Sets the file to which output of the container should be written.
      * 
      * @param theOutput The output file to set
      */
     public final void setOutput(File theOutput)
     {
         this.output = theOutput;
     }
 
     /**
      * Sets whether output of the container should be appended to an existing
      * file, or the existing file should be truncated.
      * 
      * @param isAppend Whether output should be appended
      */
     public final void setAppend(boolean isAppend)
     {
         this.append = isAppend;
     }
 
     // Protected Methods -------------------------------------------------------
 
     /**
      * Creates a preinitialized instance of the Ant Java task to be used for
      * shutting down the container.
      * 
      * @return The created task instance
      */
     protected final Java createJavaForShutDown()
     {
         Java java = (Java) createAntTask("java");
         java.setFork(true);
         return java;
     }
 
     /**
      * Creates a preinitialized instance of the Ant Java task to be used for
      * starting down the container.
      * 
      * @return The created task instance
      */
     protected final Java createJavaForStartUp()
     {
         Java java = (Java) createAntTask("java");
         java.setFork(true);
         java.setOutput(this.output);
         java.setAppend(this.append);
 
         // Add Cactus properties for the server side
         for (int i = 0; i < getSystemProperties().length; i++)
         {
             java.addSysproperty(
                 createSysProperty(getSystemProperties()[i].getKey(),
                     getSystemProperties()[i].getValue()));
         }
 
         return java;
     }
 
     /**
      * Convenience method to create an Ant environment variable that points to
      * a file.
      * 
      * @param theKey The key or name of the variable
      * @param theFile The file the variable should point to
      * @return The created environment variable
      */
     protected final Variable createSysProperty(String theKey, File theFile)
     {
         Variable var = new Variable();
         var.setKey(theKey);
         var.setFile(theFile);
         return var;
     }
 
     /**
      * Convenience method to create an Ant environment variable that contains
      * a path.
      * 
      * @param theKey The key or name of the variable
      * @param thePath The path
      * @return The created environment variable
      */
     protected final Variable createSysProperty(String theKey, Path thePath)
     {
         Variable var = new Variable();
         var.setKey(theKey);
         var.setPath(thePath);
         return var;
     }
 
     /**
      * Convenience method to create an Ant environment variable that contains a 
      * string.
      * 
      * @param theKey The key or name of the variable
      * @param theValue The value
      * @return The created environment variable
      */
     protected final Variable createSysProperty(String theKey, String theValue)
     {
         Variable var = new Variable();
         var.setKey(theKey);
         var.setValue(theValue);
         return var;
     }
 
     /**
      * Returns the file containing the JDK tools (such as the compiler).
      * 
      * @return The tools.jar file
      * @throws FileNotFoundException If the tools.jar file could not be found
      */
     protected final File getToolsJar()
         throws FileNotFoundException
     {
         String javaHome = System.getProperty("java.home"); 
         // TODO: Fix this as it fails on Max OSX (which doesn't have a 
         // tools.jar file).
         File toolsJar = new File(javaHome + "/../lib/tools.jar");
         if (!toolsJar.isFile())
         {
             throw new FileNotFoundException(toolsJar.getAbsolutePath());
         }
         return toolsJar;
     }   
 }
 

1		/*
2		* ====================================================================
3		*
4		* The Apache Software License, Version 1.1
5		*
6		* Copyright (c) 2003 The Apache Software Foundation. All rights
7		* reserved.
8		*
9		* Redistribution and use in source and binary forms, with or without
10		* modification, are permitted provided that the following conditions
11		* are met:
12		*
13		* 1. Redistributions of source code must retain the above copyright
14		* notice, this list of conditions and the following disclaimer.
15		*
16		* 2. Redistributions in binary form must reproduce the above copyright
17		* notice, this list of conditions and the following disclaimer in
18		* the documentation and/or other materials provided with the
19		* distribution.
20		*
21		* 3. The end-user documentation included with the redistribution, if
22		* any, must include the following acknowlegement:
23		* "This product includes software developed by the
24		* Apache Software Foundation (http://www.apache.org/)."
25		* Alternately, this acknowlegement may appear in the software itself,
26		* if and wherever such third-party acknowlegements normally appear.
27		*
28		* 4. The names "The Jakarta Project", "Cactus" and "Apache Software
29		* Foundation" must not be used to endorse or promote products
30		* derived from this software without prior written permission. For
31		* written permission, please contact apache@apache.org.
32		*
33		* 5. Products derived from this software may not be called "Apache"
34		* nor may "Apache" appear in their names without prior written
35		* permission of the Apache Group.
36		*
37		* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
38		* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
39		* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
40		* DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
41		* ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
42		* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
43		* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
44		* USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
45		* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
46		* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
47		* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
48		* SUCH DAMAGE.
49		* ====================================================================
50		*
51		* This software consists of voluntary contributions made by many
52		* individuals on behalf of the Apache Software Foundation. For more
53		* information on the Apache Software Foundation, please see
54		* <http://www.apache.org/>.
55		*
56		*/
57		package org.apache.cactus.integration.ant.container;
58
59		import java.io.File;
60		import java.io.FileNotFoundException;
61
62		import org.apache.tools.ant.taskdefs.Java;
63		import org.apache.tools.ant.types.Path;
64		import org.apache.tools.ant.types.Environment.Variable;
65
66		/**
67		* Abstract base class for containers that perform the starting and stopping
68		* of the server by executing Java classes in a forked JVM.
69		*
70		* @author <a href="mailto:cmlenz@apache.org">Christopher Lenz</a>
71		*
72		* @version $Id: AbstractJavaContainer.java,v 1.2.2.1 2003/10/23 18:20:43 vmassol Exp $
73		*/
74		public abstract class AbstractJavaContainer extends AbstractContainer
75		{
76		// Instance Variables ------------------------------------------------------
77
78		/**
79		* The file to which output of the container should be written.
80		*/
81		private File output;
82
83		/**
84		* Whether output of the container should be appended to an existing file,
85		* or the existing file should be truncated.
86		*/
87		private boolean append;
88
89		// Public Methods ----------------------------------------------------------
90
91		/**
92		* Sets the file to which output of the container should be written.
93		*
94		* @param theOutput The output file to set
95		*/
96	0	public final void setOutput(File theOutput)
97		{
98	0	this.output = theOutput;
99		}
100
101		/**
102		* Sets whether output of the container should be appended to an existing
103		* file, or the existing file should be truncated.
104		*
105		* @param isAppend Whether output should be appended
106		*/
107	0	public final void setAppend(boolean isAppend)
108		{
109	0	this.append = isAppend;
110		}
111
112		// Protected Methods -------------------------------------------------------
113
114		/**
115		* Creates a preinitialized instance of the Ant Java task to be used for
116		* shutting down the container.
117		*
118		* @return The created task instance
119		*/
120	0	protected final Java createJavaForShutDown()
121		{
122	0	Java java = (Java) createAntTask("java");
123	0	java.setFork(true);
124	0	return java;
125		}
126
127		/**
128		* Creates a preinitialized instance of the Ant Java task to be used for
129		* starting down the container.
130		*
131		* @return The created task instance
132		*/
133	0	protected final Java createJavaForStartUp()
134		{
135	0	Java java = (Java) createAntTask("java");
136	0	java.setFork(true);
137	0	java.setOutput(this.output);
138	0	java.setAppend(this.append);
139
140		// Add Cactus properties for the server side
141	0	for (int i = 0; i < getSystemProperties().length; i++)
142		{
143	0	java.addSysproperty(
144		createSysProperty(getSystemProperties()[i].getKey(),
145		getSystemProperties()[i].getValue()));
146		}
147
148	0	return java;
149		}
150
151		/**
152		* Convenience method to create an Ant environment variable that points to
153		* a file.
154		*
155		* @param theKey The key or name of the variable
156		* @param theFile The file the variable should point to
157		* @return The created environment variable
158		*/
159	0	protected final Variable createSysProperty(String theKey, File theFile)
160		{
161	0	Variable var = new Variable();
162	0	var.setKey(theKey);
163	0	var.setFile(theFile);
164	0	return var;
165		}
166
167		/**
168		* Convenience method to create an Ant environment variable that contains
169		* a path.
170		*
171		* @param theKey The key or name of the variable
172		* @param thePath The path
173		* @return The created environment variable
174		*/
175	0	protected final Variable createSysProperty(String theKey, Path thePath)
176		{
177	0	Variable var = new Variable();
178	0	var.setKey(theKey);
179	0	var.setPath(thePath);
180	0	return var;
181		}
182
183		/**
184		* Convenience method to create an Ant environment variable that contains a
185		* string.
186		*
187		* @param theKey The key or name of the variable
188		* @param theValue The value
189		* @return The created environment variable
190		*/
191	0	protected final Variable createSysProperty(String theKey, String theValue)
192		{
193	0	Variable var = new Variable();
194	0	var.setKey(theKey);
195	0	var.setValue(theValue);
196	0	return var;
197		}
198
199		/**
200		* Returns the file containing the JDK tools (such as the compiler).
201		*
202		* @return The tools.jar file
203		* @throws FileNotFoundException If the tools.jar file could not be found
204		*/
205	0	protected final File getToolsJar()
206		throws FileNotFoundException
207		{
208	0	String javaHome = System.getProperty("java.home");
209		// TODO: Fix this as it fails on Max OSX (which doesn't have a
210		// tools.jar file).
211	0	File toolsJar = new File(javaHome + "/../lib/tools.jar");
212	0	if (!toolsJar.isFile())
213		{
214	0	throw new FileNotFoundException(toolsJar.getAbsolutePath());
215		}
216	0	return toolsJar;
217		}
218		}
219