SystemPropertyUtils

 

1. /*
2.  * Copyright 2002-2007 the original author or authors.
3.  *
4.  * Licensed under the Apache License, Version 2.0 (the "License");
5.  * you may not use this file except in compliance with the License.
6.  * You may obtain a copy of the License at
7.  *
8.  *      http://www.apache.org/licenses/LICENSE-2.0
9.  *
10.  * Unless required by applicable law or agreed to in writing, software
11.  * distributed under the License is distributed on an "AS IS" BASIS,
12.  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13.  * See the License for the specific language governing permissions and
14.  * limitations under the License.
15.  */
17. package org.springframework.util;
19. import org.apache.commons.logging.Log;
20. import org.apache.commons.logging.LogFactory;
22. /**
23.  * Helper class for resolving placeholders in texts. Usually applied to file paths.
24.  *
25.  * <p>A text may contain <code>${...}</code> placeholders, to be resolved as
26.  * system properties: e.g. <code>${user.dir}</code>.
27.  *
28.  * @author Juergen Hoeller
29.  * @since 1.2.5
30.  * @see #PLACEHOLDER_PREFIX
31.  * @see #PLACEHOLDER_SUFFIX
32.  * @see System#getProperty(String)
33.  */
34. public abstract class SystemPropertyUtils {
36.     /** Prefix for system property placeholders: "${" */
37.     public static final String PLACEHOLDER_PREFIX = "${";
39.     /** Suffix for system property placeholders: "}" */
40.     public static final String PLACEHOLDER_SUFFIX = "}";
42.     private static final Log logger = LogFactory.getLog(SystemPropertyUtils.class);
45.     /**
46.      * Resolve ${...} placeholders in the given text,
47.      * replacing them with corresponding system property values.
48.      * @param text the String to resolve
49.      * @return the resolved String
50.      * @see #PLACEHOLDER_PREFIX
51.      * @see #PLACEHOLDER_SUFFIX
52.      */
53.     public static String resolvePlaceholders(String text) {
54.         StringBuffer buf = new StringBuffer(text);
56.         int startIndex = buf.indexOf(PLACEHOLDER_PREFIX);
57.         while (startIndex != -1) {
58.             int endIndex = buf.indexOf(PLACEHOLDER_SUFFIX, startIndex + PLACEHOLDER_PREFIX.length());
59.             if (endIndex != -1) {
60.                 String placeholder = buf.substring(startIndex + PLACEHOLDER_PREFIX.length(), endIndex);
61.                 int nextIndex = endIndex + PLACEHOLDER_SUFFIX.length();
62.                 try {
63.                     String propVal = System.getProperty(placeholder);
64.                     if (propVal == null) {
65.                         // Fall back to searching the system environment.
66.                         propVal = System.getenv(placeholder);
67.                     }
68.                     if (propVal != null) {
69.                         buf.replace(startIndex, endIndex + PLACEHOLDER_SUFFIX.length(), propVal);
70.                         nextIndex = startIndex + propVal.length();
71.                     }
72.                     else {
73.                         if (logger.isWarnEnabled()) {
74.                             logger.warn("Could not resolve placeholder '" + placeholder + "' in [" + text +
75.                                     "] as system property: neither system property nor environment variable found");
76.                         }
77.                     }
78.                 }
79.                 catch (Throwable ex) {
80.                     if (logger.isWarnEnabled()) {
81.                         logger.warn("Could not resolve placeholder '" + placeholder + "' in [" + text +
82.                                 "] as system property: " + ex);
83.                     }
84.                 }
85.                 startIndex = buf.indexOf(PLACEHOLDER_PREFIX, nextIndex);
86.             }
87.             else {
88.                 startIndex = -1;
89.             }
90.         }
92.         return buf.toString();
93.     }
95. }