Coverage Report

Coverage Report - org.apache.ojb.broker.util.dbhandling.DBHandlingTask

Classes in this File

3.071

 package org.apache.ojb.broker.util.dbhandling;
 
 /* Copyright 2004-2005 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.
  */
 
 import java.io.IOException;
 import java.util.ArrayList;
 import java.util.Iterator;
 import java.util.StringTokenizer;
 
 import org.apache.ojb.broker.PBKey;
 import org.apache.ojb.broker.PersistenceBrokerFactory;
 import org.apache.ojb.broker.util.ClassHelper;
 import org.apache.ojb.broker.metadata.ConnectionRepository;
 import org.apache.ojb.broker.metadata.MetadataManager;
 import org.apache.tools.ant.*;
 import org.apache.tools.ant.types.FileSet;
 
 /**
  * Ant task for performing basic db setup functions.
  * 
  * @author Thomas Dudziak
  */
 public class DBHandlingTask extends Task
 {
     /** The name of the known db handlings */
     private static final String HANDLING_TORQUE = "torque";
     /** The commands */
     private static final String COMMAND_CREATE  = "create";
     private static final String COMMAND_INIT    = "init";
     
     /** The name of the db handling to use */
     private String _handling = HANDLING_TORQUE;
     /** The path to the properties file */
     private String _propertiesFile = null;
     /** The alias of the jdbc connection to use (empty = default connection) */
     private String _jcdAlias = null;
     /** The working directory */
     private String _workDir = null;
     /** The input files */
     private ArrayList _fileSets = new ArrayList();
     /** The commands to perform */
     private String _commands = "";
     
     /**
      * Sets the name of the handling to use.
      * 
      * @param name The short name of the handling
      */
     public void setHandling(String name)
     {
         _handling = (name == null ? HANDLING_TORQUE : name.toLowerCase());
     }
 
     /**
      * Returns the name of the handling that is used.
      * 
      * @return The short name of the handling
      */
     public String getHandling()
     {
         return _handling;
     }
 
     /**
      * Sets the properties file (OJB.properties).
      * 
      * @param path The path to the properties file
      */
     public void setPropertiesFile(String path)
     {
         _propertiesFile = path;
     }
 
     /**
      * Returns the properties file.
      * 
      * @return The path to the properties file
      */
     public String getPropertiesFile()
     {
         return _propertiesFile;
     }
 
     /**
      * Sets the alias of the jdbc connection to use.
      * 
      * @param alias The alias of the connection
      */
     public void setJcdAlias(String alias)
     {
         _jcdAlias = alias;
     }
 
     /**
      * Returns the alias of the jdbc connection.
      * 
      * @return The alias
      */
     public String getJcdAlias()
     {
         return _jcdAlias;
     }
 
     /**
      * Sets the working directory. If none is given, then the system's temporary directory is used.
      * 
      * @param dir The working directory
      */
     public void setWorkDir(String dir)
     {
         _workDir = dir;
     }
 
     /**
      * Returns the working directory.
      * 
      * @return The working directory
      */
     public String getWorkDir()
     {
         return _workDir;
     }
 
     /**
      * Adds a fileset.
      * 
      * @param fileset The additional input files
      */
     public void addFileset(FileSet fileset)
     {
         _fileSets.add(fileset);
     }
 
     /**
      * Sets the list of commands to perform.
      * 
      * @param listOfCommands The comma-separated list of commands
      */
     public void setCommands(String listOfCommands)
     {
         _commands = listOfCommands;
     }
 
     /**
      * Returns the list of commands.
      * 
      * @return The comma-separated list of commands
      */
     public String getCommands()
     {
         return _commands;
     }
 
     /* (non-Javadoc)
      * @see org.apache.tools.ant.Task#execute()
      */
     public void execute() throws BuildException
     {
         if ((_commands == null) || (_commands.length() == 0))
         {
             return;
         }
 
         DBHandling handling = createDBHandling();
 
         try
         {
             if ((_workDir != null) && (_workDir.length() > 0))
             {
                 handling.setWorkDir(_workDir);
                 System.setProperty("user.dir", _workDir);
             }
             for (Iterator it = _fileSets.iterator(); it.hasNext();)
             {
                 addIncludes(handling, (FileSet)it.next());
             }
 
             if ((_propertiesFile != null) && (_propertiesFile.length() > 0))
             {
                 System.setProperty("OJB.properties", _propertiesFile);
             }
 
             ConnectionRepository connRep = MetadataManager.getInstance().connectionRepository();
             PBKey                pbKey   = null;
 
             if ((_jcdAlias == null) || (_jcdAlias.length() == 0))
             {
                 pbKey = PersistenceBrokerFactory.getDefaultKey();
             }
             else
             {
                 pbKey = connRep.getStandardPBKeyForJcdAlias(_jcdAlias);
                 if (pbKey == null)
                 {
                     throw new BuildException("Undefined jcdAlias "+_jcdAlias);
                 }
             }
             handling.setConnection(connRep.getDescriptor(pbKey));
 
             String command;
 
             for (StringTokenizer tokenizer = new StringTokenizer(_commands, ","); tokenizer.hasMoreTokens();)
             {
                 command = tokenizer.nextToken().toLowerCase().trim();
                 if (COMMAND_CREATE.equals(command))
                 {
                     handling.createDB();
                 }
                 else if (COMMAND_INIT.equals(command))
                 {
                     handling.initDB();
                 }
                 else
                 {
                     throw new BuildException("Unknown command "+command);
                 }
             }
         }
         catch (Exception ex)
         {
             throw new BuildException(ex);
         }
     }
 
     /**
      * Creates a db handling object.
      * 
      * @return The db handling object
      * @throws BuildException If the handling is invalid
      */
     private DBHandling createDBHandling() throws BuildException
     {
         if ((_handling == null) || (_handling.length() == 0))
         {
             throw new BuildException("No handling specified");
         }
         try
         {
             String className     = "org.apache.ojb.broker.platforms."+
                                                        Character.toTitleCase(_handling.charAt(0))+_handling.substring(1)+
                                                        "DBHandling";
             Class  handlingClass = ClassHelper.getClass(className);
 
             return (DBHandling)handlingClass.newInstance();
         }
         catch (Exception ex)
         {
             throw new BuildException("Invalid handling '"+_handling+"' specified");
         }
     }
 
     /**
      * Adds the includes of the fileset to the handling.
      * 
      * @param handling The handling
      * @param fileSet  The fileset
      */
     private void addIncludes(DBHandling handling, FileSet fileSet) throws BuildException
     {
         DirectoryScanner scanner  = fileSet.getDirectoryScanner(getProject());
         String[]         files    = scanner.getIncludedFiles();
         StringBuffer     includes = new StringBuffer();
 
         for (int idx = 0; idx < files.length; idx++)
         {
             if (idx > 0)
             {
                 includes.append(",");
             }
             includes.append(files[idx]);
         }
         try
         {
             handling.addDBDefinitionFiles(fileSet.getDir(getProject()).getAbsolutePath(), includes.toString());
         }
         catch (IOException ex)
         {
             throw new BuildException(ex);
         }
     }
 }

1		package org.apache.ojb.broker.util.dbhandling;
2
3		/* Copyright 2004-2005 The Apache Software Foundation
4		*
5		* Licensed under the Apache License, Version 2.0 (the "License");
6		* you may not use this file except in compliance with the License.
7		* You may obtain a copy of the License at
8		*
9		* http://www.apache.org/licenses/LICENSE-2.0
10		*
11		* Unless required by applicable law or agreed to in writing, software
12		* distributed under the License is distributed on an "AS IS" BASIS,
13		* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14		* See the License for the specific language governing permissions and
15		* limitations under the License.
16		*/
17
18		import java.io.IOException;
19		import java.util.ArrayList;
20		import java.util.Iterator;
21		import java.util.StringTokenizer;
22
23		import org.apache.ojb.broker.PBKey;
24		import org.apache.ojb.broker.PersistenceBrokerFactory;
25		import org.apache.ojb.broker.util.ClassHelper;
26		import org.apache.ojb.broker.metadata.ConnectionRepository;
27		import org.apache.ojb.broker.metadata.MetadataManager;
28		import org.apache.tools.ant.*;
29		import org.apache.tools.ant.types.FileSet;
30
31		/**
32		* Ant task for performing basic db setup functions.
33		*
34		* @author Thomas Dudziak
35		*/
36		public class DBHandlingTask extends Task
37		{
38		/** The name of the known db handlings */
39		private static final String HANDLING_TORQUE = "torque";
40		/** The commands */
41		private static final String COMMAND_CREATE = "create";
42		private static final String COMMAND_INIT = "init";
43
44		/** The name of the db handling to use */
45		private String _handling = HANDLING_TORQUE;
46		/** The path to the properties file */
47		private String _propertiesFile = null;
48		/** The alias of the jdbc connection to use (empty = default connection) */
49		private String _jcdAlias = null;
50		/** The working directory */
51		private String _workDir = null;
52		/** The input files */
53		private ArrayList _fileSets = new ArrayList();
54		/** The commands to perform */
55		private String _commands = "";
56
57		/**
58		* Sets the name of the handling to use.
59		*
60		* @param name The short name of the handling
61		*/
62		public void setHandling(String name)
63		{
64		_handling = (name == null ? HANDLING_TORQUE : name.toLowerCase());
65		}
66
67		/**
68		* Returns the name of the handling that is used.
69		*
70		* @return The short name of the handling
71		*/
72		public String getHandling()
73		{
74		return _handling;
75		}
76
77		/**
78		* Sets the properties file (OJB.properties).
79		*
80		* @param path The path to the properties file
81		*/
82		public void setPropertiesFile(String path)
83		{
84		_propertiesFile = path;
85		}
86
87		/**
88		* Returns the properties file.
89		*
90		* @return The path to the properties file
91		*/
92		public String getPropertiesFile()
93		{
94		return _propertiesFile;
95		}
96
97		/**
98		* Sets the alias of the jdbc connection to use.
99		*
100		* @param alias The alias of the connection
101		*/
102		public void setJcdAlias(String alias)
103		{
104		_jcdAlias = alias;
105		}
106
107		/**
108		* Returns the alias of the jdbc connection.
109		*
110		* @return The alias
111		*/
112		public String getJcdAlias()
113		{
114		return _jcdAlias;
115		}
116
117		/**
118		* Sets the working directory. If none is given, then the system's temporary directory is used.
119		*
120		* @param dir The working directory
121		*/
122		public void setWorkDir(String dir)
123		{
124		_workDir = dir;
125		}
126
127		/**
128		* Returns the working directory.
129		*
130		* @return The working directory
131		*/
132		public String getWorkDir()
133		{
134		return _workDir;
135		}
136
137		/**
138		* Adds a fileset.
139		*
140		* @param fileset The additional input files
141		*/
142		public void addFileset(FileSet fileset)
143		{
144		_fileSets.add(fileset);
145		}
146
147		/**
148		* Sets the list of commands to perform.
149		*
150		* @param listOfCommands The comma-separated list of commands
151		*/
152		public void setCommands(String listOfCommands)
153		{
154		_commands = listOfCommands;
155		}
156
157		/**
158		* Returns the list of commands.
159		*
160		* @return The comma-separated list of commands
161		*/
162		public String getCommands()
163		{
164		return _commands;
165		}
166
167		/* (non-Javadoc)
168		* @see org.apache.tools.ant.Task#execute()
169		*/
170		public void execute() throws BuildException
171		{
172		if ((_commands == null) \|\| (_commands.length() == 0))
173		{
174		return;
175		}
176
177		DBHandling handling = createDBHandling();
178
179		try
180		{
181		if ((_workDir != null) && (_workDir.length() > 0))
182		{
183		handling.setWorkDir(_workDir);
184		System.setProperty("user.dir", _workDir);
185		}
186		for (Iterator it = _fileSets.iterator(); it.hasNext();)
187		{
188		addIncludes(handling, (FileSet)it.next());
189		}
190
191		if ((_propertiesFile != null) && (_propertiesFile.length() > 0))
192		{
193		System.setProperty("OJB.properties", _propertiesFile);
194		}
195
196		ConnectionRepository connRep = MetadataManager.getInstance().connectionRepository();
197		PBKey pbKey = null;
198
199		if ((_jcdAlias == null) \|\| (_jcdAlias.length() == 0))
200		{
201		pbKey = PersistenceBrokerFactory.getDefaultKey();
202		}
203		else
204		{
205		pbKey = connRep.getStandardPBKeyForJcdAlias(_jcdAlias);
206		if (pbKey == null)
207		{
208		throw new BuildException("Undefined jcdAlias "+_jcdAlias);
209		}
210		}
211		handling.setConnection(connRep.getDescriptor(pbKey));
212
213		String command;
214
215		for (StringTokenizer tokenizer = new StringTokenizer(_commands, ","); tokenizer.hasMoreTokens();)
216		{
217		command = tokenizer.nextToken().toLowerCase().trim();
218		if (COMMAND_CREATE.equals(command))
219		{
220		handling.createDB();
221		}
222		else if (COMMAND_INIT.equals(command))
223		{
224		handling.initDB();
225		}
226		else
227		{
228		throw new BuildException("Unknown command "+command);
229		}
230		}
231		}
232		catch (Exception ex)
233		{
234		throw new BuildException(ex);
235		}
236		}
237
238		/**
239		* Creates a db handling object.
240		*
241		* @return The db handling object
242		* @throws BuildException If the handling is invalid
243		*/
244		private DBHandling createDBHandling() throws BuildException
245		{
246		if ((_handling == null) \|\| (_handling.length() == 0))
247		{
248		throw new BuildException("No handling specified");
249		}
250		try
251		{
252		String className = "org.apache.ojb.broker.platforms."+
253		Character.toTitleCase(_handling.charAt(0))+_handling.substring(1)+
254		"DBHandling";
255		Class handlingClass = ClassHelper.getClass(className);
256
257		return (DBHandling)handlingClass.newInstance();
258		}
259		catch (Exception ex)
260		{
261		throw new BuildException("Invalid handling '"+_handling+"' specified");
262		}
263		}
264
265		/**
266		* Adds the includes of the fileset to the handling.
267		*
268		* @param handling The handling
269		* @param fileSet The fileset
270		*/
271		private void addIncludes(DBHandling handling, FileSet fileSet) throws BuildException
272		{
273		DirectoryScanner scanner = fileSet.getDirectoryScanner(getProject());
274		String[] files = scanner.getIncludedFiles();
275		StringBuffer includes = new StringBuffer();
276
277		for (int idx = 0; idx < files.length; idx++)
278		{
279		if (idx > 0)
280		{
281		includes.append(",");
282		}
283		includes.append(files[idx]);
284		}
285		try
286		{
287		handling.addDBDefinitionFiles(fileSet.getDir(getProject()).getAbsolutePath(), includes.toString());
288		}
289		catch (IOException ex)
290		{
291		throw new BuildException(ex);
292		}
293		}
294		}