KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > objectstyle > cayenne > project > CayenneUserDir


1 /* ====================================================================
2  *
3  * The ObjectStyle Group Software License, version 1.1
4  * ObjectStyle Group - http://objectstyle.org/
5  *
6  * Copyright (c) 2002-2005, Andrei (Andrus) Adamchik and individual authors
7  * of the software. All rights 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 any,
22  * must include the following acknowlegement:
23  * "This product includes software developed by independent contributors
24  * and hosted on ObjectStyle Group web site (http://objectstyle.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 "ObjectStyle Group" and "Cayenne" must not be used to endorse
29  * or promote products derived from this software without prior written
30  * permission. For written permission, email
31  * "andrus at objectstyle dot org".
32  *
33  * 5. Products derived from this software may not be called "ObjectStyle"
34  * or "Cayenne", nor may "ObjectStyle" or "Cayenne" appear in their
35  * names without prior written permission.
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 OBJECTSTYLE GROUP 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 and hosted on ObjectStyle Group web site. For more
53  * information on the ObjectStyle Group, please see
54  * <http://objectstyle.org/>.
55  */
56 package org.objectstyle.cayenne.project;
57
58 import java.io.File JavaDoc;
59
60 import org.apache.log4j.Logger;
61
62 /**
63  * CayenneUserDir represents a directory where all Cayenne-related information
64  * is stored on the user machine. This is normally a <code>$HOME/.cayenne</code>
65  * directory.
66  *
67  * @author Andrei Adamchik
68  */
69 public class CayenneUserDir {
70     static final Logger logObj = Logger.getLogger(CayenneUserDir.class);
71     
72     protected static CayenneUserDir sharedInstance;
73
74     public static final String JavaDoc CAYENNE_DIR = ".cayenne";
75     
76     /**
77      * A property name for the property that allows to define an alternative
78      * location of Cayenne User Directory (instead of default "$HOME/.cayenne").
79      *
80      * @since 1.1
81      */
82     public static final String JavaDoc ALT_USER_DIR_PROPERTY = "cayenne.userdir";
83
84     protected File JavaDoc cayenneUserDir;
85
86     public static CayenneUserDir getInstance() {
87         if(sharedInstance == null) {
88             sharedInstance = new CayenneUserDir();
89         }
90         return sharedInstance;
91     }
92     
93     
94     /**
95      * Constructor for CayenneUserDir.
96      */
97     protected CayenneUserDir() {
98         super();
99
100         File JavaDoc tmpDir = null;
101         String JavaDoc dirName = System.getProperty(ALT_USER_DIR_PROPERTY);
102
103         if (dirName != null) {
104             tmpDir = new File JavaDoc(dirName);
105         }
106         else {
107             File JavaDoc homeDir = new File JavaDoc(System.getProperty("user.home"));
108             tmpDir = new File JavaDoc(homeDir, CAYENNE_DIR);
109         }
110
111         if (tmpDir.exists() && !tmpDir.isDirectory()) {
112             tmpDir = null;
113             logObj.warn(tmpDir + " is not a directory.");
114         }
115         else if (tmpDir.exists() && !tmpDir.canRead()) {
116             tmpDir = null;
117             logObj.warn(tmpDir + " is not readable.");
118         }
119         else if (!tmpDir.exists()) {
120             tmpDir.mkdirs();
121             if (!tmpDir.exists()) {
122                 tmpDir = null;
123                 logObj.warn("Couldn't create " + tmpDir);
124             }
125         }
126
127         cayenneUserDir = tmpDir;
128     }
129
130     /**
131      * Returns a directory object where all user Cayenne-related configuration is stored.
132      * May return null if the directory is not accessible for whatever reason.
133      */
134     public File JavaDoc getDirectory() {
135         return cayenneUserDir;
136     }
137     
138     /**
139      * Return false if the directory is not accessible for
140      * any reason at least for reading.
141      */
142     public boolean canRead() {
143         return cayenneUserDir != null;
144     }
145     
146     /**
147      * Return false if the directory is not accessible for
148      * any reason at least for reading.
149      */
150     public boolean canWrite() {
151         return cayenneUserDir != null && cayenneUserDir.canWrite();
152     }
153     
154     public File JavaDoc resolveFile(String JavaDoc name) {
155         return new File JavaDoc(cayenneUserDir, name);
156     }
157 }
158
Popular Tags