Modified: websites/production/commons/content/proper/commons-daemon/apidocs/src-html/org/apache/commons/daemon/DaemonUserSignal.html ============================================================================== --- websites/production/commons/content/proper/commons-daemon/apidocs/src-html/org/apache/commons/daemon/DaemonUserSignal.html (original) +++ websites/production/commons/content/proper/commons-daemon/apidocs/src-html/org/apache/commons/daemon/DaemonUserSignal.html Fri May 24 09:43:12 2024 @@ -1,48 +1,53 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<!DOCTYPE HTML> <html lang="en"> <head> +<!-- Generated by javadoc (17) --> <title>Source code</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta name="description" content="source: package: org.apache.commons.daemon, interface: DaemonUserSignal"> +<meta name="generator" content="javadoc/SourceToHTMLConverter"> <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> </head> -<body> -<div class="sourceContainer"> -<pre><span class="sourceLineNo">001</span>/*<a name="line.1"></a> -<span class="sourceLineNo">002</span> * Licensed to the Apache Software Foundation (ASF) under one or more<a name="line.2"></a> -<span class="sourceLineNo">003</span> * contributor license agreements. See the NOTICE file distributed with<a name="line.3"></a> -<span class="sourceLineNo">004</span> * this work for additional information regarding copyright ownership.<a name="line.4"></a> -<span class="sourceLineNo">005</span> * The ASF licenses this file to You under the Apache License, Version 2.0<a name="line.5"></a> -<span class="sourceLineNo">006</span> * (the "License"); you may not use this file except in compliance with<a name="line.6"></a> -<span class="sourceLineNo">007</span> * the License. You may obtain a copy of the License at<a name="line.7"></a> -<span class="sourceLineNo">008</span> *<a name="line.8"></a> -<span class="sourceLineNo">009</span> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.9"></a> -<span class="sourceLineNo">010</span> *<a name="line.10"></a> -<span class="sourceLineNo">011</span> * Unless required by applicable law or agreed to in writing, software<a name="line.11"></a> -<span class="sourceLineNo">012</span> * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.12"></a> -<span class="sourceLineNo">013</span> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.13"></a> -<span class="sourceLineNo">014</span> * See the License for the specific language governing permissions and<a name="line.14"></a> -<span class="sourceLineNo">015</span> * limitations under the License.<a name="line.15"></a> -<span class="sourceLineNo">016</span> */<a name="line.16"></a> -<span class="sourceLineNo">017</span><a name="line.17"></a> -<span class="sourceLineNo">018</span>package org.apache.commons.daemon;<a name="line.18"></a> -<span class="sourceLineNo">019</span><a name="line.19"></a> -<span class="sourceLineNo">020</span>/**<a name="line.20"></a> -<span class="sourceLineNo">021</span> * Tags a Daemon as supporting some kind of<a name="line.21"></a> -<span class="sourceLineNo">022</span> * signalling method that allows the java application to<a name="line.22"></a> -<span class="sourceLineNo">023</span> * perform a custom action.<a name="line.23"></a> -<span class="sourceLineNo">024</span> * <p><a name="line.24"></a> -<span class="sourceLineNo">025</span> * User must implement a signal method that will be called from<a name="line.25"></a> -<span class="sourceLineNo">026</span> * native upon receiving {@code SIGUSR2} signal from the operating system.<a name="line.26"></a> -<span class="sourceLineNo">027</span> * </p><a name="line.27"></a> -<span class="sourceLineNo">028</span> */<a name="line.28"></a> -<span class="sourceLineNo">029</span>public interface DaemonUserSignal<a name="line.29"></a> -<span class="sourceLineNo">030</span>{<a name="line.30"></a> -<span class="sourceLineNo">031</span><a name="line.31"></a> -<span class="sourceLineNo">032</span> /**<a name="line.32"></a> -<span class="sourceLineNo">033</span> * Performs a custom action on received user signal.<a name="line.33"></a> -<span class="sourceLineNo">034</span> */<a name="line.34"></a> -<span class="sourceLineNo">035</span> void signal();<a name="line.35"></a> -<span class="sourceLineNo">036</span><a name="line.36"></a> -<span class="sourceLineNo">037</span>}<a name="line.37"></a> +<body class="source-page"> +<main role="main"> +<div class="source-container"> +<pre><span class="source-line-no">001</span><span id="line-1">/*</span> +<span class="source-line-no">002</span><span id="line-2"> * Licensed to the Apache Software Foundation (ASF) under one or more</span> +<span class="source-line-no">003</span><span id="line-3"> * contributor license agreements. See the NOTICE file distributed with</span> +<span class="source-line-no">004</span><span id="line-4"> * this work for additional information regarding copyright ownership.</span> +<span class="source-line-no">005</span><span id="line-5"> * The ASF licenses this file to You under the Apache License, Version 2.0</span> +<span class="source-line-no">006</span><span id="line-6"> * (the "License"); you may not use this file except in compliance with</span> +<span class="source-line-no">007</span><span id="line-7"> * the License. You may obtain a copy of the License at</span> +<span class="source-line-no">008</span><span id="line-8"> *</span> +<span class="source-line-no">009</span><span id="line-9"> * http://www.apache.org/licenses/LICENSE-2.0</span> +<span class="source-line-no">010</span><span id="line-10"> *</span> +<span class="source-line-no">011</span><span id="line-11"> * Unless required by applicable law or agreed to in writing, software</span> +<span class="source-line-no">012</span><span id="line-12"> * distributed under the License is distributed on an "AS IS" BASIS,</span> +<span class="source-line-no">013</span><span id="line-13"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span> +<span class="source-line-no">014</span><span id="line-14"> * See the License for the specific language governing permissions and</span> +<span class="source-line-no">015</span><span id="line-15"> * limitations under the License.</span> +<span class="source-line-no">016</span><span id="line-16"> */</span> +<span class="source-line-no">017</span><span id="line-17"></span> +<span class="source-line-no">018</span><span id="line-18">package org.apache.commons.daemon;</span> +<span class="source-line-no">019</span><span id="line-19"></span> +<span class="source-line-no">020</span><span id="line-20">/**</span> +<span class="source-line-no">021</span><span id="line-21"> * Tags a Daemon as supporting some kind of</span> +<span class="source-line-no">022</span><span id="line-22"> * signalling method that allows the Java application to</span> +<span class="source-line-no">023</span><span id="line-23"> * perform a custom action.</span> +<span class="source-line-no">024</span><span id="line-24"> * <p></span> +<span class="source-line-no">025</span><span id="line-25"> * User must implement a signal method that will be called from</span> +<span class="source-line-no">026</span><span id="line-26"> * native upon receiving {@code SIGUSR2} signal from the operating system.</span> +<span class="source-line-no">027</span><span id="line-27"> * </p></span> +<span class="source-line-no">028</span><span id="line-28"> */</span> +<span class="source-line-no">029</span><span id="line-29">public interface DaemonUserSignal</span> +<span class="source-line-no">030</span><span id="line-30">{</span> +<span class="source-line-no">031</span><span id="line-31"></span> +<span class="source-line-no">032</span><span id="line-32"> /**</span> +<span class="source-line-no">033</span><span id="line-33"> * Performs a custom action on received user signal.</span> +<span class="source-line-no">034</span><span id="line-34"> */</span> +<span class="source-line-no">035</span><span id="line-35"> void signal();</span> +<span class="source-line-no">036</span><span id="line-36"></span> +<span class="source-line-no">037</span><span id="line-37">}</span> @@ -105,5 +110,6 @@ </pre> </div> +</main> </body> </html> \ No newline at end of file
Modified: websites/production/commons/content/proper/commons-daemon/apidocs/src-html/org/apache/commons/daemon/support/DaemonConfiguration.html ============================================================================== --- websites/production/commons/content/proper/commons-daemon/apidocs/src-html/org/apache/commons/daemon/support/DaemonConfiguration.html (original) +++ websites/production/commons/content/proper/commons-daemon/apidocs/src-html/org/apache/commons/daemon/support/DaemonConfiguration.html Fri May 24 09:43:12 2024 @@ -1,207 +1,211 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<!DOCTYPE HTML> <html lang="en"> <head> +<!-- Generated by javadoc (17) --> <title>Source code</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta name="description" content="source: package: org.apache.commons.daemon.support, class: DaemonConfiguration"> +<meta name="generator" content="javadoc/SourceToHTMLConverter"> <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> </head> -<body> -<div class="sourceContainer"> -<pre><span class="sourceLineNo">001</span>/*<a name="line.1"></a> -<span class="sourceLineNo">002</span> * Licensed to the Apache Software Foundation (ASF) under one or more<a name="line.2"></a> -<span class="sourceLineNo">003</span> * contributor license agreements. See the NOTICE file distributed with<a name="line.3"></a> -<span class="sourceLineNo">004</span> * this work for additional information regarding copyright ownership.<a name="line.4"></a> -<span class="sourceLineNo">005</span> * The ASF licenses this file to You under the Apache License, Version 2.0<a name="line.5"></a> -<span class="sourceLineNo">006</span> * (the "License"); you may not use this file except in compliance with<a name="line.6"></a> -<span class="sourceLineNo">007</span> * the License. You may obtain a copy of the License at<a name="line.7"></a> -<span class="sourceLineNo">008</span> *<a name="line.8"></a> -<span class="sourceLineNo">009</span> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.9"></a> -<span class="sourceLineNo">010</span> *<a name="line.10"></a> -<span class="sourceLineNo">011</span> * Unless required by applicable law or agreed to in writing, software<a name="line.11"></a> -<span class="sourceLineNo">012</span> * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.12"></a> -<span class="sourceLineNo">013</span> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.13"></a> -<span class="sourceLineNo">014</span> * See the License for the specific language governing permissions and<a name="line.14"></a> -<span class="sourceLineNo">015</span> * limitations under the License.<a name="line.15"></a> -<span class="sourceLineNo">016</span> */<a name="line.16"></a> -<span class="sourceLineNo">017</span><a name="line.17"></a> -<span class="sourceLineNo">018</span>package org.apache.commons.daemon.support;<a name="line.18"></a> -<span class="sourceLineNo">019</span><a name="line.19"></a> -<span class="sourceLineNo">020</span>import java.io.FileInputStream;<a name="line.20"></a> -<span class="sourceLineNo">021</span>import java.io.IOException;<a name="line.21"></a> -<span class="sourceLineNo">022</span>import java.io.InputStream;<a name="line.22"></a> -<span class="sourceLineNo">023</span>import java.util.ArrayList;<a name="line.23"></a> -<span class="sourceLineNo">024</span>import java.util.Properties;<a name="line.24"></a> -<span class="sourceLineNo">025</span>import java.text.ParseException;<a name="line.25"></a> -<span class="sourceLineNo">026</span><a name="line.26"></a> -<span class="sourceLineNo">027</span>/**<a name="line.27"></a> -<span class="sourceLineNo">028</span> * Used by jsvc for Daemon configuration.<a name="line.28"></a> -<span class="sourceLineNo">029</span> * <p><a name="line.29"></a> -<span class="sourceLineNo">030</span> * Configuration is read from properties file.<a name="line.30"></a> -<span class="sourceLineNo">031</span> * If no properties file is given the {@code daemon.properties}<a name="line.31"></a> -<span class="sourceLineNo">032</span> * is used from the current directory.<a name="line.32"></a> -<span class="sourceLineNo">033</span> * </p><a name="line.33"></a> -<span class="sourceLineNo">034</span> * <p><a name="line.34"></a> -<span class="sourceLineNo">035</span> * The properties file can have property values expanded at runtime<a name="line.35"></a> -<span class="sourceLineNo">036</span> * by using System properties or execution environment. The part<a name="line.36"></a> -<span class="sourceLineNo">037</span> * of the property value between {@code ${} and {@code }}<a name="line.37"></a> -<span class="sourceLineNo">038</span> * will be used as System property or environment key. If found then<a name="line.38"></a> -<span class="sourceLineNo">039</span> * the entire {@code ${foo}} will be replaced by the value of<a name="line.39"></a> -<span class="sourceLineNo">040</span> * either system property or environment variable named {@code foo}.<a name="line.40"></a> -<span class="sourceLineNo">041</span> * </p><a name="line.41"></a> -<span class="sourceLineNo">042</span> * <p><a name="line.42"></a> -<span class="sourceLineNo">043</span> * If no variable is found the {@code ${foo}} will be passed as is.<a name="line.43"></a> -<span class="sourceLineNo">044</span> * In case of {@code $${foo}} this will be unescaped and resulting<a name="line.44"></a> -<span class="sourceLineNo">045</span> * value will be {@code ${foo}}.<a name="line.45"></a> -<span class="sourceLineNo">046</span> * </p><a name="line.46"></a> -<span class="sourceLineNo">047</span> */<a name="line.47"></a> -<span class="sourceLineNo">048</span>public final class DaemonConfiguration<a name="line.48"></a> -<span class="sourceLineNo">049</span>{<a name="line.49"></a> -<span class="sourceLineNo">050</span> /**<a name="line.50"></a> -<span class="sourceLineNo">051</span> * Default configuration file name.<a name="line.51"></a> -<span class="sourceLineNo">052</span> */<a name="line.52"></a> -<span class="sourceLineNo">053</span> protected final static String DEFAULT_CONFIG = "daemon.properties";<a name="line.53"></a> -<span class="sourceLineNo">054</span> /**<a name="line.54"></a> -<span class="sourceLineNo">055</span> * Property prefix<a name="line.55"></a> -<span class="sourceLineNo">056</span> */<a name="line.56"></a> -<span class="sourceLineNo">057</span> protected final static String PREFIX = "daemon.";<a name="line.57"></a> -<span class="sourceLineNo">058</span> private final static String BTOKEN = "${";<a name="line.58"></a> -<span class="sourceLineNo">059</span> private final static String ETOKEN = "}";<a name="line.59"></a> -<span class="sourceLineNo">060</span><a name="line.60"></a> -<span class="sourceLineNo">061</span><a name="line.61"></a> -<span class="sourceLineNo">062</span> private final Properties configurationProperties;<a name="line.62"></a> -<span class="sourceLineNo">063</span> private final Properties systemProperties;<a name="line.63"></a> -<span class="sourceLineNo">064</span><a name="line.64"></a> -<span class="sourceLineNo">065</span> /**<a name="line.65"></a> -<span class="sourceLineNo">066</span> * An empty immutable {@code String} array.<a name="line.66"></a> -<span class="sourceLineNo">067</span> */<a name="line.67"></a> -<span class="sourceLineNo">068</span> static final String[] EMPTY_STRING_ARRAY = {};<a name="line.68"></a> -<span class="sourceLineNo">069</span><a name="line.69"></a> -<span class="sourceLineNo">070</span> /**<a name="line.70"></a> -<span class="sourceLineNo">071</span> * Default constructor<a name="line.71"></a> -<span class="sourceLineNo">072</span> */<a name="line.72"></a> -<span class="sourceLineNo">073</span> public DaemonConfiguration()<a name="line.73"></a> -<span class="sourceLineNo">074</span> {<a name="line.74"></a> -<span class="sourceLineNo">075</span> configurationProperties = new Properties();<a name="line.75"></a> -<span class="sourceLineNo">076</span> systemProperties = System.getProperties();<a name="line.76"></a> -<span class="sourceLineNo">077</span> }<a name="line.77"></a> -<span class="sourceLineNo">078</span><a name="line.78"></a> -<span class="sourceLineNo">079</span> /**<a name="line.79"></a> -<span class="sourceLineNo">080</span> * Loads the configuration properties file.<a name="line.80"></a> -<span class="sourceLineNo">081</span> *<a name="line.81"></a> -<span class="sourceLineNo">082</span> * @param fileName The properties file to load.<a name="line.82"></a> -<span class="sourceLineNo">083</span> * @return {@code true} if the file was loaded.<a name="line.83"></a> -<span class="sourceLineNo">084</span> */<a name="line.84"></a> -<span class="sourceLineNo">085</span> public boolean load(String fileName)<a name="line.85"></a> -<span class="sourceLineNo">086</span> {<a name="line.86"></a> -<span class="sourceLineNo">087</span> if (fileName == null) {<a name="line.87"></a> -<span class="sourceLineNo">088</span> fileName = DEFAULT_CONFIG;<a name="line.88"></a> -<span class="sourceLineNo">089</span> }<a name="line.89"></a> -<span class="sourceLineNo">090</span> <a name="line.90"></a> -<span class="sourceLineNo">091</span> try (InputStream inputStream = new FileInputStream(fileName)) {<a name="line.91"></a> -<span class="sourceLineNo">092</span> configurationProperties.clear();<a name="line.92"></a> -<span class="sourceLineNo">093</span> configurationProperties.load(inputStream);<a name="line.93"></a> -<span class="sourceLineNo">094</span> return true;<a name="line.94"></a> -<span class="sourceLineNo">095</span> } catch (final IOException ex) {<a name="line.95"></a> -<span class="sourceLineNo">096</span> // Error reading properties file<a name="line.96"></a> -<span class="sourceLineNo">097</span> return false;<a name="line.97"></a> -<span class="sourceLineNo">098</span> }<a name="line.98"></a> -<span class="sourceLineNo">099</span> }<a name="line.99"></a> -<span class="sourceLineNo">100</span><a name="line.100"></a> -<span class="sourceLineNo">101</span> private String expandProperty(final String propValue)<a name="line.101"></a> -<span class="sourceLineNo">102</span> throws ParseException<a name="line.102"></a> -<span class="sourceLineNo">103</span> {<a name="line.103"></a> -<span class="sourceLineNo">104</span> final StringBuilder expanded;<a name="line.104"></a> -<span class="sourceLineNo">105</span> int btoken;<a name="line.105"></a> -<span class="sourceLineNo">106</span> int ctoken = 0;<a name="line.106"></a> -<span class="sourceLineNo">107</span><a name="line.107"></a> -<span class="sourceLineNo">108</span> if (propValue == null) {<a name="line.108"></a> -<span class="sourceLineNo">109</span> return null;<a name="line.109"></a> -<span class="sourceLineNo">110</span> }<a name="line.110"></a> -<span class="sourceLineNo">111</span> expanded = new StringBuilder();<a name="line.111"></a> -<span class="sourceLineNo">112</span> btoken = propValue.indexOf(BTOKEN);<a name="line.112"></a> -<span class="sourceLineNo">113</span> while (btoken != -1) {<a name="line.113"></a> -<span class="sourceLineNo">114</span> if (btoken > 0 && propValue.charAt(btoken - 1) == BTOKEN.charAt(0)) {<a name="line.114"></a> -<span class="sourceLineNo">115</span> // Skip and unquote.<a name="line.115"></a> -<span class="sourceLineNo">116</span> expanded.append(propValue.substring(ctoken, btoken));<a name="line.116"></a> -<span class="sourceLineNo">117</span> ctoken = btoken + 1;<a name="line.117"></a> -<span class="sourceLineNo">118</span> btoken = propValue.indexOf(BTOKEN, btoken + BTOKEN.length());<a name="line.118"></a> -<span class="sourceLineNo">119</span> continue;<a name="line.119"></a> -<span class="sourceLineNo">120</span> }<a name="line.120"></a> -<span class="sourceLineNo">121</span> final int etoken = propValue.indexOf(ETOKEN, btoken);<a name="line.121"></a> -<span class="sourceLineNo">122</span> if (etoken == -1) {<a name="line.122"></a> -<span class="sourceLineNo">123</span> // We have "${" without "}"<a name="line.123"></a> -<span class="sourceLineNo">124</span> throw new ParseException("Error while looking for teminating '" +<a name="line.124"></a> -<span class="sourceLineNo">125</span> ETOKEN + "'", btoken);<a name="line.125"></a> -<span class="sourceLineNo">126</span> }<a name="line.126"></a> -<span class="sourceLineNo">127</span> final String variable = propValue.substring(btoken + BTOKEN.length(), etoken);<a name="line.127"></a> -<span class="sourceLineNo">128</span> String sysvalue = systemProperties.getProperty(variable);<a name="line.128"></a> -<span class="sourceLineNo">129</span> if (sysvalue == null) {<a name="line.129"></a> -<span class="sourceLineNo">130</span> // Try with the environment if there was no<a name="line.130"></a> -<span class="sourceLineNo">131</span> // property by that name.<a name="line.131"></a> -<span class="sourceLineNo">132</span> sysvalue = System.getenv(variable);<a name="line.132"></a> -<span class="sourceLineNo">133</span> }<a name="line.133"></a> -<span class="sourceLineNo">134</span> if (sysvalue != null) {<a name="line.134"></a> -<span class="sourceLineNo">135</span> final String strtoken = propValue.substring(ctoken, btoken);<a name="line.135"></a> -<span class="sourceLineNo">136</span> expanded.append(strtoken);<a name="line.136"></a> -<span class="sourceLineNo">137</span> expanded.append(sysvalue);<a name="line.137"></a> -<span class="sourceLineNo">138</span> ctoken = etoken + ETOKEN.length();<a name="line.138"></a> -<span class="sourceLineNo">139</span> }<a name="line.139"></a> -<span class="sourceLineNo">140</span> btoken = propValue.indexOf(BTOKEN, etoken + ETOKEN.length());<a name="line.140"></a> -<span class="sourceLineNo">141</span> }<a name="line.141"></a> -<span class="sourceLineNo">142</span> // Add what's left.<a name="line.142"></a> -<span class="sourceLineNo">143</span> expanded.append(propValue.substring(ctoken));<a name="line.143"></a> -<span class="sourceLineNo">144</span> return expanded.toString();<a name="line.144"></a> -<span class="sourceLineNo">145</span> }<a name="line.145"></a> -<span class="sourceLineNo">146</span><a name="line.146"></a> -<span class="sourceLineNo">147</span> /**<a name="line.147"></a> -<span class="sourceLineNo">148</span> * Gets the configuration property.<a name="line.148"></a> -<span class="sourceLineNo">149</span> *<a name="line.149"></a> -<span class="sourceLineNo">150</span> * @param name The name of the property to get.<a name="line.150"></a> -<span class="sourceLineNo">151</span> *<a name="line.151"></a> -<span class="sourceLineNo">152</span> * @throws ParseException if the property is wrongly formatted.<a name="line.152"></a> -<span class="sourceLineNo">153</span> *<a name="line.153"></a> -<span class="sourceLineNo">154</span> * @return Configuration property including any expansion/replacement<a name="line.154"></a> -<span class="sourceLineNo">155</span> */<a name="line.155"></a> -<span class="sourceLineNo">156</span> public String getProperty(final String name)<a name="line.156"></a> -<span class="sourceLineNo">157</span> throws ParseException<a name="line.157"></a> -<span class="sourceLineNo">158</span> {<a name="line.158"></a> -<span class="sourceLineNo">159</span> if (name == null) {<a name="line.159"></a> -<span class="sourceLineNo">160</span> return null;<a name="line.160"></a> -<span class="sourceLineNo">161</span> }<a name="line.161"></a> -<span class="sourceLineNo">162</span> return expandProperty(configurationProperties.getProperty(PREFIX + name));<a name="line.162"></a> -<span class="sourceLineNo">163</span> }<a name="line.163"></a> -<span class="sourceLineNo">164</span><a name="line.164"></a> -<span class="sourceLineNo">165</span> /**<a name="line.165"></a> -<span class="sourceLineNo">166</span> * Gets the configuration property array.<a name="line.166"></a> -<span class="sourceLineNo">167</span> * <p><a name="line.167"></a> -<span class="sourceLineNo">168</span> * Property array is constructed form the list of properties<a name="line.168"></a> -<span class="sourceLineNo">169</span> * which end with {@code [index]}<a name="line.169"></a> -<span class="sourceLineNo">170</span> * </p><a name="line.170"></a> -<span class="sourceLineNo">171</span> * <pre><a name="line.171"></a> -<span class="sourceLineNo">172</span> * daemon.arg[0] = argument 1<a name="line.172"></a> -<span class="sourceLineNo">173</span> * daemon.arg[1] = argument 2<a name="line.173"></a> -<span class="sourceLineNo">174</span> * daemon.arg[2] = argument 3<a name="line.174"></a> -<span class="sourceLineNo">175</span> * </pre><a name="line.175"></a> -<span class="sourceLineNo">176</span> * @param name The name of the property array to get.<a name="line.176"></a> -<span class="sourceLineNo">177</span> *<a name="line.177"></a> -<span class="sourceLineNo">178</span> * @throws ParseException if the property is wrongly formatted.<a name="line.178"></a> -<span class="sourceLineNo">179</span> *<a name="line.179"></a> -<span class="sourceLineNo">180</span> * @return Configuration property array including any expansion/replacement<a name="line.180"></a> -<span class="sourceLineNo">181</span> */<a name="line.181"></a> -<span class="sourceLineNo">182</span> public String[] getPropertyArray(final String name)<a name="line.182"></a> -<span class="sourceLineNo">183</span> throws ParseException<a name="line.183"></a> -<span class="sourceLineNo">184</span> {<a name="line.184"></a> -<span class="sourceLineNo">185</span> final ArrayList<String> list = new ArrayList<>();<a name="line.185"></a> -<span class="sourceLineNo">186</span> String args;<a name="line.186"></a> -<span class="sourceLineNo">187</span><a name="line.187"></a> -<span class="sourceLineNo">188</span> // Load daemon.arg[0] ... daemon.arg[n] into the String array.<a name="line.188"></a> -<span class="sourceLineNo">189</span> //<a name="line.189"></a> -<span class="sourceLineNo">190</span> while ((args = getProperty(name + "[" + list.size() + "]")) != null) {<a name="line.190"></a> -<span class="sourceLineNo">191</span> list.add(args);<a name="line.191"></a> -<span class="sourceLineNo">192</span> }<a name="line.192"></a> -<span class="sourceLineNo">193</span> return list.toArray(EMPTY_STRING_ARRAY);<a name="line.193"></a> -<span class="sourceLineNo">194</span> }<a name="line.194"></a> -<span class="sourceLineNo">195</span>}<a name="line.195"></a> -<span class="sourceLineNo">196</span><a name="line.196"></a> +<body class="source-page"> +<main role="main"> +<div class="source-container"> +<pre><span class="source-line-no">001</span><span id="line-1">/*</span> +<span class="source-line-no">002</span><span id="line-2"> * Licensed to the Apache Software Foundation (ASF) under one or more</span> +<span class="source-line-no">003</span><span id="line-3"> * contributor license agreements. See the NOTICE file distributed with</span> +<span class="source-line-no">004</span><span id="line-4"> * this work for additional information regarding copyright ownership.</span> +<span class="source-line-no">005</span><span id="line-5"> * The ASF licenses this file to You under the Apache License, Version 2.0</span> +<span class="source-line-no">006</span><span id="line-6"> * (the "License"); you may not use this file except in compliance with</span> +<span class="source-line-no">007</span><span id="line-7"> * the License. You may obtain a copy of the License at</span> +<span class="source-line-no">008</span><span id="line-8"> *</span> +<span class="source-line-no">009</span><span id="line-9"> * http://www.apache.org/licenses/LICENSE-2.0</span> +<span class="source-line-no">010</span><span id="line-10"> *</span> +<span class="source-line-no">011</span><span id="line-11"> * Unless required by applicable law or agreed to in writing, software</span> +<span class="source-line-no">012</span><span id="line-12"> * distributed under the License is distributed on an "AS IS" BASIS,</span> +<span class="source-line-no">013</span><span id="line-13"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span> +<span class="source-line-no">014</span><span id="line-14"> * See the License for the specific language governing permissions and</span> +<span class="source-line-no">015</span><span id="line-15"> * limitations under the License.</span> +<span class="source-line-no">016</span><span id="line-16"> */</span> +<span class="source-line-no">017</span><span id="line-17"></span> +<span class="source-line-no">018</span><span id="line-18">package org.apache.commons.daemon.support;</span> +<span class="source-line-no">019</span><span id="line-19"></span> +<span class="source-line-no">020</span><span id="line-20">import java.io.FileInputStream;</span> +<span class="source-line-no">021</span><span id="line-21">import java.io.IOException;</span> +<span class="source-line-no">022</span><span id="line-22">import java.io.InputStream;</span> +<span class="source-line-no">023</span><span id="line-23">import java.util.ArrayList;</span> +<span class="source-line-no">024</span><span id="line-24">import java.util.Properties;</span> +<span class="source-line-no">025</span><span id="line-25">import java.text.ParseException;</span> +<span class="source-line-no">026</span><span id="line-26"></span> +<span class="source-line-no">027</span><span id="line-27">/**</span> +<span class="source-line-no">028</span><span id="line-28"> * Used by jsvc for Daemon configuration.</span> +<span class="source-line-no">029</span><span id="line-29"> * <p></span> +<span class="source-line-no">030</span><span id="line-30"> * Configuration is read from properties file.</span> +<span class="source-line-no">031</span><span id="line-31"> * If no properties file is given the {@code daemon.properties}</span> +<span class="source-line-no">032</span><span id="line-32"> * is used from the current directory.</span> +<span class="source-line-no">033</span><span id="line-33"> * </p></span> +<span class="source-line-no">034</span><span id="line-34"> * <p></span> +<span class="source-line-no">035</span><span id="line-35"> * The properties file can have property values expanded at runtime</span> +<span class="source-line-no">036</span><span id="line-36"> * by using System properties or execution environment. The part</span> +<span class="source-line-no">037</span><span id="line-37"> * of the property value between {@code ${} and {@code }}</span> +<span class="source-line-no">038</span><span id="line-38"> * will be used as System property or environment key. If found then</span> +<span class="source-line-no">039</span><span id="line-39"> * the entire {@code ${foo}} will be replaced by the value of</span> +<span class="source-line-no">040</span><span id="line-40"> * either system property or environment variable named {@code foo}.</span> +<span class="source-line-no">041</span><span id="line-41"> * </p></span> +<span class="source-line-no">042</span><span id="line-42"> * <p></span> +<span class="source-line-no">043</span><span id="line-43"> * If no variable is found the {@code ${foo}} will be passed as is.</span> +<span class="source-line-no">044</span><span id="line-44"> * In case of {@code $${foo}} this will be unescaped and resulting</span> +<span class="source-line-no">045</span><span id="line-45"> * value will be {@code ${foo}}.</span> +<span class="source-line-no">046</span><span id="line-46"> * </p></span> +<span class="source-line-no">047</span><span id="line-47"> */</span> +<span class="source-line-no">048</span><span id="line-48">public final class DaemonConfiguration</span> +<span class="source-line-no">049</span><span id="line-49">{</span> +<span class="source-line-no">050</span><span id="line-50"> /**</span> +<span class="source-line-no">051</span><span id="line-51"> * Default configuration file name.</span> +<span class="source-line-no">052</span><span id="line-52"> */</span> +<span class="source-line-no">053</span><span id="line-53"> protected final static String DEFAULT_CONFIG = "daemon.properties";</span> +<span class="source-line-no">054</span><span id="line-54"> /**</span> +<span class="source-line-no">055</span><span id="line-55"> * Property prefix</span> +<span class="source-line-no">056</span><span id="line-56"> */</span> +<span class="source-line-no">057</span><span id="line-57"> protected final static String PREFIX = "daemon.";</span> +<span class="source-line-no">058</span><span id="line-58"> private final static String BTOKEN = "${";</span> +<span class="source-line-no">059</span><span id="line-59"> private final static String ETOKEN = "}";</span> +<span class="source-line-no">060</span><span id="line-60"></span> +<span class="source-line-no">061</span><span id="line-61"> private final Properties configurationProperties;</span> +<span class="source-line-no">062</span><span id="line-62"> private final Properties systemProperties;</span> +<span class="source-line-no">063</span><span id="line-63"></span> +<span class="source-line-no">064</span><span id="line-64"> /**</span> +<span class="source-line-no">065</span><span id="line-65"> * An empty immutable {@code String} array.</span> +<span class="source-line-no">066</span><span id="line-66"> */</span> +<span class="source-line-no">067</span><span id="line-67"> static final String[] EMPTY_STRING_ARRAY = {};</span> +<span class="source-line-no">068</span><span id="line-68"></span> +<span class="source-line-no">069</span><span id="line-69"> /**</span> +<span class="source-line-no">070</span><span id="line-70"> * Default constructor</span> +<span class="source-line-no">071</span><span id="line-71"> */</span> +<span class="source-line-no">072</span><span id="line-72"> public DaemonConfiguration()</span> +<span class="source-line-no">073</span><span id="line-73"> {</span> +<span class="source-line-no">074</span><span id="line-74"> configurationProperties = new Properties();</span> +<span class="source-line-no">075</span><span id="line-75"> systemProperties = System.getProperties();</span> +<span class="source-line-no">076</span><span id="line-76"> }</span> +<span class="source-line-no">077</span><span id="line-77"></span> +<span class="source-line-no">078</span><span id="line-78"> /**</span> +<span class="source-line-no">079</span><span id="line-79"> * Loads the configuration properties file.</span> +<span class="source-line-no">080</span><span id="line-80"> *</span> +<span class="source-line-no">081</span><span id="line-81"> * @param fileName The properties file to load.</span> +<span class="source-line-no">082</span><span id="line-82"> * @return {@code true} if the file was loaded.</span> +<span class="source-line-no">083</span><span id="line-83"> */</span> +<span class="source-line-no">084</span><span id="line-84"> public boolean load(String fileName)</span> +<span class="source-line-no">085</span><span id="line-85"> {</span> +<span class="source-line-no">086</span><span id="line-86"> if (fileName == null) {</span> +<span class="source-line-no">087</span><span id="line-87"> fileName = DEFAULT_CONFIG;</span> +<span class="source-line-no">088</span><span id="line-88"> }</span> +<span class="source-line-no">089</span><span id="line-89"> </span> +<span class="source-line-no">090</span><span id="line-90"> try (InputStream inputStream = new FileInputStream(fileName)) {</span> +<span class="source-line-no">091</span><span id="line-91"> configurationProperties.clear();</span> +<span class="source-line-no">092</span><span id="line-92"> configurationProperties.load(inputStream);</span> +<span class="source-line-no">093</span><span id="line-93"> return true;</span> +<span class="source-line-no">094</span><span id="line-94"> } catch (final IOException ex) {</span> +<span class="source-line-no">095</span><span id="line-95"> // Error reading properties file</span> +<span class="source-line-no">096</span><span id="line-96"> return false;</span> +<span class="source-line-no">097</span><span id="line-97"> }</span> +<span class="source-line-no">098</span><span id="line-98"> }</span> +<span class="source-line-no">099</span><span id="line-99"></span> +<span class="source-line-no">100</span><span id="line-100"> private String expandProperty(final String propValue)</span> +<span class="source-line-no">101</span><span id="line-101"> throws ParseException</span> +<span class="source-line-no">102</span><span id="line-102"> {</span> +<span class="source-line-no">103</span><span id="line-103"> final StringBuilder expanded;</span> +<span class="source-line-no">104</span><span id="line-104"> int btoken;</span> +<span class="source-line-no">105</span><span id="line-105"> int ctoken = 0;</span> +<span class="source-line-no">106</span><span id="line-106"></span> +<span class="source-line-no">107</span><span id="line-107"> if (propValue == null) {</span> +<span class="source-line-no">108</span><span id="line-108"> return null;</span> +<span class="source-line-no">109</span><span id="line-109"> }</span> +<span class="source-line-no">110</span><span id="line-110"> expanded = new StringBuilder();</span> +<span class="source-line-no">111</span><span id="line-111"> btoken = propValue.indexOf(BTOKEN);</span> +<span class="source-line-no">112</span><span id="line-112"> while (btoken != -1) {</span> +<span class="source-line-no">113</span><span id="line-113"> if (btoken > 0 && propValue.charAt(btoken - 1) == BTOKEN.charAt(0)) {</span> +<span class="source-line-no">114</span><span id="line-114"> // Skip and unquote.</span> +<span class="source-line-no">115</span><span id="line-115"> expanded.append(propValue.substring(ctoken, btoken));</span> +<span class="source-line-no">116</span><span id="line-116"> ctoken = btoken + 1;</span> +<span class="source-line-no">117</span><span id="line-117"> btoken = propValue.indexOf(BTOKEN, btoken + BTOKEN.length());</span> +<span class="source-line-no">118</span><span id="line-118"> continue;</span> +<span class="source-line-no">119</span><span id="line-119"> }</span> +<span class="source-line-no">120</span><span id="line-120"> final int etoken = propValue.indexOf(ETOKEN, btoken);</span> +<span class="source-line-no">121</span><span id="line-121"> if (etoken == -1) {</span> +<span class="source-line-no">122</span><span id="line-122"> // We have "${" without "}"</span> +<span class="source-line-no">123</span><span id="line-123"> throw new ParseException("Error while looking for teminating '" +</span> +<span class="source-line-no">124</span><span id="line-124"> ETOKEN + "'", btoken);</span> +<span class="source-line-no">125</span><span id="line-125"> }</span> +<span class="source-line-no">126</span><span id="line-126"> final String variable = propValue.substring(btoken + BTOKEN.length(), etoken);</span> +<span class="source-line-no">127</span><span id="line-127"> String sysvalue = systemProperties.getProperty(variable);</span> +<span class="source-line-no">128</span><span id="line-128"> if (sysvalue == null) {</span> +<span class="source-line-no">129</span><span id="line-129"> // Try with the environment if there was no</span> +<span class="source-line-no">130</span><span id="line-130"> // property by that name.</span> +<span class="source-line-no">131</span><span id="line-131"> sysvalue = System.getenv(variable);</span> +<span class="source-line-no">132</span><span id="line-132"> }</span> +<span class="source-line-no">133</span><span id="line-133"> if (sysvalue != null) {</span> +<span class="source-line-no">134</span><span id="line-134"> final String strtoken = propValue.substring(ctoken, btoken);</span> +<span class="source-line-no">135</span><span id="line-135"> expanded.append(strtoken);</span> +<span class="source-line-no">136</span><span id="line-136"> expanded.append(sysvalue);</span> +<span class="source-line-no">137</span><span id="line-137"> ctoken = etoken + ETOKEN.length();</span> +<span class="source-line-no">138</span><span id="line-138"> }</span> +<span class="source-line-no">139</span><span id="line-139"> btoken = propValue.indexOf(BTOKEN, etoken + ETOKEN.length());</span> +<span class="source-line-no">140</span><span id="line-140"> }</span> +<span class="source-line-no">141</span><span id="line-141"> // Add what's left.</span> +<span class="source-line-no">142</span><span id="line-142"> expanded.append(propValue.substring(ctoken));</span> +<span class="source-line-no">143</span><span id="line-143"> return expanded.toString();</span> +<span class="source-line-no">144</span><span id="line-144"> }</span> +<span class="source-line-no">145</span><span id="line-145"></span> +<span class="source-line-no">146</span><span id="line-146"> /**</span> +<span class="source-line-no">147</span><span id="line-147"> * Gets the configuration property.</span> +<span class="source-line-no">148</span><span id="line-148"> *</span> +<span class="source-line-no">149</span><span id="line-149"> * @param name The name of the property to get.</span> +<span class="source-line-no">150</span><span id="line-150"> *</span> +<span class="source-line-no">151</span><span id="line-151"> * @throws ParseException if the property is wrongly formatted.</span> +<span class="source-line-no">152</span><span id="line-152"> *</span> +<span class="source-line-no">153</span><span id="line-153"> * @return Configuration property including any expansion/replacement</span> +<span class="source-line-no">154</span><span id="line-154"> */</span> +<span class="source-line-no">155</span><span id="line-155"> public String getProperty(final String name)</span> +<span class="source-line-no">156</span><span id="line-156"> throws ParseException</span> +<span class="source-line-no">157</span><span id="line-157"> {</span> +<span class="source-line-no">158</span><span id="line-158"> if (name == null) {</span> +<span class="source-line-no">159</span><span id="line-159"> return null;</span> +<span class="source-line-no">160</span><span id="line-160"> }</span> +<span class="source-line-no">161</span><span id="line-161"> return expandProperty(configurationProperties.getProperty(PREFIX + name));</span> +<span class="source-line-no">162</span><span id="line-162"> }</span> +<span class="source-line-no">163</span><span id="line-163"></span> +<span class="source-line-no">164</span><span id="line-164"> /**</span> +<span class="source-line-no">165</span><span id="line-165"> * Gets the configuration property array.</span> +<span class="source-line-no">166</span><span id="line-166"> * <p></span> +<span class="source-line-no">167</span><span id="line-167"> * Property array is constructed form the list of properties</span> +<span class="source-line-no">168</span><span id="line-168"> * which end with {@code [index]}</span> +<span class="source-line-no">169</span><span id="line-169"> * </p></span> +<span class="source-line-no">170</span><span id="line-170"> * <pre></span> +<span class="source-line-no">171</span><span id="line-171"> * daemon.arg[0] = argument 1</span> +<span class="source-line-no">172</span><span id="line-172"> * daemon.arg[1] = argument 2</span> +<span class="source-line-no">173</span><span id="line-173"> * daemon.arg[2] = argument 3</span> +<span class="source-line-no">174</span><span id="line-174"> * </pre></span> +<span class="source-line-no">175</span><span id="line-175"> * @param name The name of the property array to get.</span> +<span class="source-line-no">176</span><span id="line-176"> *</span> +<span class="source-line-no">177</span><span id="line-177"> * @throws ParseException if the property is wrongly formatted.</span> +<span class="source-line-no">178</span><span id="line-178"> *</span> +<span class="source-line-no">179</span><span id="line-179"> * @return Configuration property array including any expansion/replacement</span> +<span class="source-line-no">180</span><span id="line-180"> */</span> +<span class="source-line-no">181</span><span id="line-181"> public String[] getPropertyArray(final String name)</span> +<span class="source-line-no">182</span><span id="line-182"> throws ParseException</span> +<span class="source-line-no">183</span><span id="line-183"> {</span> +<span class="source-line-no">184</span><span id="line-184"> final ArrayList<String> list = new ArrayList<>();</span> +<span class="source-line-no">185</span><span id="line-185"> String args;</span> +<span class="source-line-no">186</span><span id="line-186"></span> +<span class="source-line-no">187</span><span id="line-187"> // Load daemon.arg[0] ... daemon.arg[n] into the String array.</span> +<span class="source-line-no">188</span><span id="line-188"> //</span> +<span class="source-line-no">189</span><span id="line-189"> while ((args = getProperty(name + "[" + list.size() + "]")) != null) {</span> +<span class="source-line-no">190</span><span id="line-190"> list.add(args);</span> +<span class="source-line-no">191</span><span id="line-191"> }</span> +<span class="source-line-no">192</span><span id="line-192"> return list.toArray(EMPTY_STRING_ARRAY);</span> +<span class="source-line-no">193</span><span id="line-193"> }</span> +<span class="source-line-no">194</span><span id="line-194">}</span> +<span class="source-line-no">195</span><span id="line-195"></span> @@ -264,5 +268,6 @@ </pre> </div> +</main> </body> </html> \ No newline at end of file
