KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > jcorporate > expresso > core > misc > SystemMacros


1 /* ====================================================================
2  * The Jcorporate Apache Style Software License, Version 1.2 05-07-2002
3  *
4  * Copyright (c) 1995-2002 Jcorporate Ltd. All rights reserved.
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions
8  * are met:
9  *
10  * 1. Redistributions of source code must retain the above copyright
11  * notice, this list of conditions and the following disclaimer.
12  *
13  * 2. Redistributions in binary form must reproduce the above copyright
14  * notice, this list of conditions and the following disclaimer in
15  * the documentation and/or other materials provided with the
16  * distribution.
17  *
18  * 3. The end-user documentation included with the redistribution,
19  * if any, must include the following acknowledgment:
20  * "This product includes software developed by Jcorporate Ltd.
21  * (http://www.jcorporate.com/)."
22  * Alternately, this acknowledgment may appear in the software itself,
23  * if and wherever such third-party acknowledgments normally appear.
24  *
25  * 4. "Jcorporate" and product names such as "Expresso" must
26  * not be used to endorse or promote products derived from this
27  * software without prior written permission. For written permission,
28  * please contact info@jcorporate.com.
29  *
30  * 5. Products derived from this software may not be called "Expresso",
31  * or other Jcorporate product names; nor may "Expresso" or other
32  * Jcorporate product names appear in their name, without prior
33  * written permission of Jcorporate Ltd.
34  *
35  * 6. No product derived from this software may compete in the same
36  * market space, i.e. framework, without prior written permission
37  * of Jcorporate Ltd. For written permission, please contact
38  * partners@jcorporate.com.
39  *
40  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
41  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
42  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
43  * DISCLAIMED. IN NO EVENT SHALL JCORPORATE LTD OR ITS CONTRIBUTORS
44  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
45  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
46  * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
47  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
48  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
49  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
50  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
51  * SUCH DAMAGE.
52  * ====================================================================
53  *
54  * This software consists of voluntary contributions made by many
55  * individuals on behalf of the Jcorporate Ltd. Contributions back
56  * to the project(s) are encouraged when you make modifications.
57  * Please send them to support@jcorporate.com. For more information
58  * on Jcorporate Ltd. and its products, please see
59  * <http://www.jcorporate.com/>.
60  *
61  * Portions of this software are based upon other open source
62  * products and are subject to their respective licenses.
63  */
64
65 package com.jcorporate.expresso.core.misc;
66
67
68 /**
69  * @author Michael Rimov
70  */
71 public class SystemMacros {
72
73     private static SystemMacros theInstance = new SystemMacros();
74     private String JavaDoc webAppDir = "";
75     private String JavaDoc contextPath = "";
76     private String JavaDoc expressoDir = "expresso";
77     private String JavaDoc serverPrefix = "";
78
79     protected SystemMacros() {
80     }
81
82     public static synchronized SystemMacros getInstance() {
83         return theInstance;
84     }
85
86     public void setWebAppDir(String JavaDoc newDir) {
87         StringUtil.assertNotBlank(newDir,
88                 "A blank or null directory is not allowed here");
89         webAppDir = newDir.replace('\\', '/');
90
91         if (!webAppDir.endsWith("/")) {
92             webAppDir = webAppDir + "/";
93         }
94     }
95
96     public String JavaDoc getWebAppDir() {
97         if (webAppDir == null) {
98             return "";
99         }
100         return webAppDir;
101     }
102
103     public void setContextPath(String JavaDoc newContextPath) {
104         //Must be allowed to be blank for root context.
105 if (newContextPath == null) {
106             throw new IllegalArgumentException JavaDoc("Context path may not be null");
107         }
108
109         contextPath = newContextPath;
110     }
111
112     public String JavaDoc getContextPath() {
113         return contextPath;
114     }
115
116     public void setExpressoDir(String JavaDoc expressoDir) {
117         this.expressoDir = expressoDir;
118     }
119
120     public String JavaDoc getExpressoDir() {
121         return expressoDir;
122     }
123
124     public void setServerPrefix(String JavaDoc serverPrefix) {
125         this.serverPrefix = serverPrefix;
126     }
127
128     public String JavaDoc getServerPrefix() {
129         return serverPrefix;
130     }
131
132     /**
133      * Expand the value with all the available system macros
134      *
135      * @param propValue The value to check for macros and expand.
136      * @return java.lang.String.
137      */
138     public String JavaDoc expandValue(String JavaDoc propValue) {
139         if (propValue == null) {
140             return null;
141         }
142
143         /* the %web-app% macro expands to the current
144          * directory that is the real (e.g. filesystem) path
145          * that this web-application is installed in.
146          * It will always end with a "/"
147          */
148         if (propValue.indexOf("%web-app%") >= 0) {
149             propValue = StringUtil.replace(propValue, "%web-app%", getWebAppDir());
150         }
151
152         /* The %context% macro expands to the current
153          * context path for the current web application (if any).
154          * It does *not* end in a "/"
155          */
156         if (propValue.indexOf("%context%") >= 0) {
157             propValue = StringUtil.replace(propValue, "%context%", getContextPath());
158         }
159         /* The %expresso-dir% macro expands to the directory name within the current
160          * web application where Expresso's files are contained.
161          * It does *not* end in a "/"
162          */
163         if (propValue.indexOf("%expresso-dir%") >= 0) {
164             propValue = StringUtil.replace(propValue, "%expresso-dir%",
165                     getExpressoDir());
166         }
167         if (propValue.indexOf("%server%") >= 0) {
168             propValue = StringUtil.replace(propValue, "%server%", getServerPrefix());
169         }
170
171         return propValue;
172
173     }
174
175 }
Popular Tags