Modified: websites/production/commons/content/proper/commons-daemon/apidocs/src-html/org/apache/commons/daemon/DaemonPermission.html ============================================================================== --- websites/production/commons/content/proper/commons-daemon/apidocs/src-html/org/apache/commons/daemon/DaemonPermission.html (original) +++ websites/production/commons/content/proper/commons-daemon/apidocs/src-html/org/apache/commons/daemon/DaemonPermission.html Fri May 12 13:32:29 2023 @@ -1,451 +1,450 @@ -<!DOCTYPE HTML> +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> <html lang="en"> <head> <title>Source code</title> <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> </head> <body> -<main role="main"> <div class="sourceContainer"> -<pre><span class="sourceLineNo">001</span><a id="line.1">/*</a> -<span class="sourceLineNo">002</span><a id="line.2"> * Licensed to the Apache Software Foundation (ASF) under one or more</a> -<span class="sourceLineNo">003</span><a id="line.3"> * contributor license agreements. See the NOTICE file distributed with</a> -<span class="sourceLineNo">004</span><a id="line.4"> * this work for additional information regarding copyright ownership.</a> -<span class="sourceLineNo">005</span><a id="line.5"> * The ASF licenses this file to You under the Apache License, Version 2.0</a> -<span class="sourceLineNo">006</span><a id="line.6"> * (the "License"); you may not use this file except in compliance with</a> -<span class="sourceLineNo">007</span><a id="line.7"> * the License. You may obtain a copy of the License at</a> -<span class="sourceLineNo">008</span><a id="line.8"> *</a> -<span class="sourceLineNo">009</span><a id="line.9"> * http://www.apache.org/licenses/LICENSE-2.0</a> -<span class="sourceLineNo">010</span><a id="line.10"> *</a> -<span class="sourceLineNo">011</span><a id="line.11"> * Unless required by applicable law or agreed to in writing, software</a> -<span class="sourceLineNo">012</span><a id="line.12"> * distributed under the License is distributed on an "AS IS" BASIS,</a> -<span class="sourceLineNo">013</span><a id="line.13"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</a> -<span class="sourceLineNo">014</span><a id="line.14"> * See the License for the specific language governing permissions and</a> -<span class="sourceLineNo">015</span><a id="line.15"> * limitations under the License.</a> -<span class="sourceLineNo">016</span><a id="line.16"> */</a> -<span class="sourceLineNo">017</span><a id="line.17"></a> -<span class="sourceLineNo">018</span><a id="line.18">package org.apache.commons.daemon;</a> -<span class="sourceLineNo">019</span><a id="line.19"></a> -<span class="sourceLineNo">020</span><a id="line.20">import java.security.Permission;</a> -<span class="sourceLineNo">021</span><a id="line.21">import java.util.StringTokenizer;</a> -<span class="sourceLineNo">022</span><a id="line.22"></a> -<span class="sourceLineNo">023</span><a id="line.23">/**</a> -<span class="sourceLineNo">024</span><a id="line.24"> * Represents the permissions to control and query the status of</a> -<span class="sourceLineNo">025</span><a id="line.25"> * a {@code Daemon}. A {@code DaemonPermission} consists of a</a> -<span class="sourceLineNo">026</span><a id="line.26"> * target name and a list of actions associated with it.</a> -<span class="sourceLineNo">027</span><a id="line.27"> * <p></a> -<span class="sourceLineNo">028</span><a id="line.28"> * In this specification version the only available target name for this</a> -<span class="sourceLineNo">029</span><a id="line.29"> * permission is &quot;control&quot;, but further releases may add more target</a> -<span class="sourceLineNo">030</span><a id="line.30"> * names to fine-tune the access that needs to be granted to the caller.</a> -<span class="sourceLineNo">031</span><a id="line.31"> * </p></a> -<span class="sourceLineNo">032</span><a id="line.32"> * <p></a> -<span class="sourceLineNo">033</span><a id="line.33"> * Actions are defined by a string of comma-separated values, as shown in the</a> -<span class="sourceLineNo">034</span><a id="line.34"> * table below. The empty string implies no permission at all, while the</a> -<span class="sourceLineNo">035</span><a id="line.35"> * special &quot;*&quot; value implies all permissions for the given</a> -<span class="sourceLineNo">036</span><a id="line.36"> * name:</a> -<span class="sourceLineNo">037</span><a id="line.37"> * </p></a> -<span class="sourceLineNo">038</span><a id="line.38"> * <table border="1"></a> -<span class="sourceLineNo">039</span><a id="line.39"> * <caption>Supported Actions</caption></a> -<span class="sourceLineNo">040</span><a id="line.40"> * <tr></a> -<span class="sourceLineNo">041</span><a id="line.41"> * <th>Target&quot;Name</th></a> -<span class="sourceLineNo">042</span><a id="line.42"> * <th>Action</th></a> -<span class="sourceLineNo">043</span><a id="line.43"> * <th>Description</th></a> -<span class="sourceLineNo">044</span><a id="line.44"> * </tr></a> -<span class="sourceLineNo">045</span><a id="line.45"> * <tr></a> -<span class="sourceLineNo">046</span><a id="line.46"> * <td rowspan="5">&quot;control&quot;</td></a> -<span class="sourceLineNo">047</span><a id="line.47"> * <td>&quot;start&quot;</td></a> -<span class="sourceLineNo">048</span><a id="line.48"> * <td></a> -<span class="sourceLineNo">049</span><a id="line.49"> * The permission to call the {@code start()} method in an instance</a> -<span class="sourceLineNo">050</span><a id="line.50"> * of a {@code DaemonController} interface.</a> -<span class="sourceLineNo">051</span><a id="line.51"> * </td></a> -<span class="sourceLineNo">052</span><a id="line.52"> * </tr></a> -<span class="sourceLineNo">053</span><a id="line.53"> * <tr></a> -<span class="sourceLineNo">054</span><a id="line.54"> * <td>&quot;stop&quot;</td></a> -<span class="sourceLineNo">055</span><a id="line.55"> * <td></a> -<span class="sourceLineNo">056</span><a id="line.56"> * The permission to call the {@code stop()} method in an instance</a> -<span class="sourceLineNo">057</span><a id="line.57"> * of a {@code DaemonController} interface.</a> -<span class="sourceLineNo">058</span><a id="line.58"> * </td></a> -<span class="sourceLineNo">059</span><a id="line.59"> * </tr></a> -<span class="sourceLineNo">060</span><a id="line.60"> * <tr></a> -<span class="sourceLineNo">061</span><a id="line.61"> * <td>&quot;shutdown&quot;</td></a> -<span class="sourceLineNo">062</span><a id="line.62"> * <td></a> -<span class="sourceLineNo">063</span><a id="line.63"> * The permission to call the {@code shutdown()} method in an instance</a> -<span class="sourceLineNo">064</span><a id="line.64"> * of a {@code DaemonController} interface.</a> -<span class="sourceLineNo">065</span><a id="line.65"> * </td></a> -<span class="sourceLineNo">066</span><a id="line.66"> * </tr></a> -<span class="sourceLineNo">067</span><a id="line.67"> * <tr></a> -<span class="sourceLineNo">068</span><a id="line.68"> * <td>&quot;reload&quot;</td></a> -<span class="sourceLineNo">069</span><a id="line.69"> * <td></a> -<span class="sourceLineNo">070</span><a id="line.70"> * The permission to call the {@code reload()} method in an instance</a> -<span class="sourceLineNo">071</span><a id="line.71"> * of a {@code DaemonController} interface.</a> -<span class="sourceLineNo">072</span><a id="line.72"> * </td></a> -<span class="sourceLineNo">073</span><a id="line.73"> * </tr></a> -<span class="sourceLineNo">074</span><a id="line.74"> * <tr></a> -<span class="sourceLineNo">075</span><a id="line.75"> * <td>&quot;*&quot;</td></a> -<span class="sourceLineNo">076</span><a id="line.76"> * <td></a> -<span class="sourceLineNo">077</span><a id="line.77"> * The special wildcard action implies all above-mentioned action. This is</a> -<span class="sourceLineNo">078</span><a id="line.78"> * equal to construct a permission with the &quot;start, stop, shutdown,</a> -<span class="sourceLineNo">079</span><a id="line.79"> * reload&quot; list of actions.</a> -<span class="sourceLineNo">080</span><a id="line.80"> * </td></a> -<span class="sourceLineNo">081</span><a id="line.81"> * </tr></a> -<span class="sourceLineNo">082</span><a id="line.82"> * </table></a> -<span class="sourceLineNo">083</span><a id="line.83"> */</a> -<span class="sourceLineNo">084</span><a id="line.84">public final class DaemonPermission extends Permission</a> -<span class="sourceLineNo">085</span><a id="line.85">{</a> -<span class="sourceLineNo">086</span><a id="line.86"></a> -<span class="sourceLineNo">087</span><a id="line.87"> /* ====================================================================</a> -<span class="sourceLineNo">088</span><a id="line.88"> * Constants.</a> -<span class="sourceLineNo">089</span><a id="line.89"> */</a> -<span class="sourceLineNo">090</span><a id="line.90"></a> -<span class="sourceLineNo">091</span><a id="line.91"> private static final long serialVersionUID = -8682149075879731987L;</a> -<span class="sourceLineNo">092</span><a id="line.92"></a> -<span class="sourceLineNo">093</span><a id="line.93"> /**</a> -<span class="sourceLineNo">094</span><a id="line.94"> * The target name when associated with control actions</a> -<span class="sourceLineNo">095</span><a id="line.95"> * (&quot;control&quot;).</a> -<span class="sourceLineNo">096</span><a id="line.96"> */</a> -<span class="sourceLineNo">097</span><a id="line.97"> protected static final String CONTROL = "control";</a> -<span class="sourceLineNo">098</span><a id="line.98"></a> -<span class="sourceLineNo">099</span><a id="line.99"> /**</a> -<span class="sourceLineNo">100</span><a id="line.100"> * The target type when associated with control actions.</a> -<span class="sourceLineNo">101</span><a id="line.101"> */</a> -<span class="sourceLineNo">102</span><a id="line.102"> protected static final int TYPE_CONTROL = 1;</a> -<span class="sourceLineNo">103</span><a id="line.103"></a> -<span class="sourceLineNo">104</span><a id="line.104"> /**</a> -<span class="sourceLineNo">105</span><a id="line.105"> * The action name associated with the permission to call the</a> -<span class="sourceLineNo">106</span><a id="line.106"> * {@code DaemonController.start()} method.</a> -<span class="sourceLineNo">107</span><a id="line.107"> */</a> -<span class="sourceLineNo">108</span><a id="line.108"> protected static final String CONTROL_START = "start";</a> -<span class="sourceLineNo">109</span><a id="line.109"></a> -<span class="sourceLineNo">110</span><a id="line.110"> /**</a> -<span class="sourceLineNo">111</span><a id="line.111"> * The action name associated with the permission to call the</a> -<span class="sourceLineNo">112</span><a id="line.112"> * {@code DaemonController.stop()} method.</a> -<span class="sourceLineNo">113</span><a id="line.113"> */</a> -<span class="sourceLineNo">114</span><a id="line.114"> protected static final String CONTROL_STOP = "stop";</a> -<span class="sourceLineNo">115</span><a id="line.115"></a> -<span class="sourceLineNo">116</span><a id="line.116"> /**</a> -<span class="sourceLineNo">117</span><a id="line.117"> * The action name associated with the permission to call the</a> -<span class="sourceLineNo">118</span><a id="line.118"> * {@code DaemonController.shutdown()} method.</a> -<span class="sourceLineNo">119</span><a id="line.119"> */</a> -<span class="sourceLineNo">120</span><a id="line.120"> protected static final String CONTROL_SHUTDOWN = "shutdown";</a> -<span class="sourceLineNo">121</span><a id="line.121"></a> -<span class="sourceLineNo">122</span><a id="line.122"> /**</a> -<span class="sourceLineNo">123</span><a id="line.123"> * The action name associated with the permission to call the</a> -<span class="sourceLineNo">124</span><a id="line.124"> * {@code DaemonController.reload()} method.</a> -<span class="sourceLineNo">125</span><a id="line.125"> */</a> -<span class="sourceLineNo">126</span><a id="line.126"> protected static final String CONTROL_RELOAD = "reload";</a> -<span class="sourceLineNo">127</span><a id="line.127"></a> -<span class="sourceLineNo">128</span><a id="line.128"> /**</a> -<span class="sourceLineNo">129</span><a id="line.129"> * The action mask associated with the permission to call the</a> -<span class="sourceLineNo">130</span><a id="line.130"> * {@code DaemonController.start()} method.</a> -<span class="sourceLineNo">131</span><a id="line.131"> */</a> -<span class="sourceLineNo">132</span><a id="line.132"> protected static final int MASK_CONTROL_START = 0x01;</a> -<span class="sourceLineNo">133</span><a id="line.133"></a> -<span class="sourceLineNo">134</span><a id="line.134"> /**</a> -<span class="sourceLineNo">135</span><a id="line.135"> * The action mask associated with the permission to call the</a> -<span class="sourceLineNo">136</span><a id="line.136"> * {@code DaemonController.stop()} method.</a> -<span class="sourceLineNo">137</span><a id="line.137"> */</a> -<span class="sourceLineNo">138</span><a id="line.138"> protected static final int MASK_CONTROL_STOP = 0x02;</a> -<span class="sourceLineNo">139</span><a id="line.139"></a> -<span class="sourceLineNo">140</span><a id="line.140"> /**</a> -<span class="sourceLineNo">141</span><a id="line.141"> * The action mask associated with the permission to call the</a> -<span class="sourceLineNo">142</span><a id="line.142"> * {@code DaemonController.shutdown()} method.</a> -<span class="sourceLineNo">143</span><a id="line.143"> */</a> -<span class="sourceLineNo">144</span><a id="line.144"> protected static final int MASK_CONTROL_SHUTDOWN = 0x04;</a> -<span class="sourceLineNo">145</span><a id="line.145"></a> -<span class="sourceLineNo">146</span><a id="line.146"> /**</a> -<span class="sourceLineNo">147</span><a id="line.147"> * The action mask associated with the permission to call the</a> -<span class="sourceLineNo">148</span><a id="line.148"> * {@code DaemonController.reload()} method.</a> -<span class="sourceLineNo">149</span><a id="line.149"> */</a> -<span class="sourceLineNo">150</span><a id="line.150"> protected static final int MASK_CONTROL_RELOAD = 0x08;</a> -<span class="sourceLineNo">151</span><a id="line.151"></a> -<span class="sourceLineNo">152</span><a id="line.152"> /**</a> -<span class="sourceLineNo">153</span><a id="line.153"> * The &quot;wildcard&quot; action implying all actions for the given</a> -<span class="sourceLineNo">154</span><a id="line.154"> * target name.</a> -<span class="sourceLineNo">155</span><a id="line.155"> */</a> -<span class="sourceLineNo">156</span><a id="line.156"> protected static final String WILDCARD = "*";</a> -<span class="sourceLineNo">157</span><a id="line.157"></a> -<span class="sourceLineNo">158</span><a id="line.158"> /* ====================================================================</a> -<span class="sourceLineNo">159</span><a id="line.159"> * Instance variables</a> -<span class="sourceLineNo">160</span><a id="line.160"> */</a> -<span class="sourceLineNo">161</span><a id="line.161"></a> -<span class="sourceLineNo">162</span><a id="line.162"> /** The type of this permission object. */</a> -<span class="sourceLineNo">163</span><a id="line.163"> private transient int type;</a> -<span class="sourceLineNo">164</span><a id="line.164"> /** The permission mask associated with this permission object. */</a> -<span class="sourceLineNo">165</span><a id="line.165"> private transient int mask;</a> -<span class="sourceLineNo">166</span><a id="line.166"> /** The String representation of this permission object. */</a> -<span class="sourceLineNo">167</span><a id="line.167"> private transient String desc;</a> -<span class="sourceLineNo">168</span><a id="line.168"></a> -<span class="sourceLineNo">169</span><a id="line.169"> /* ====================================================================</a> -<span class="sourceLineNo">170</span><a id="line.170"> * Constructors</a> -<span class="sourceLineNo">171</span><a id="line.171"> */</a> -<span class="sourceLineNo">172</span><a id="line.172"></a> -<span class="sourceLineNo">173</span><a id="line.173"> /**</a> -<span class="sourceLineNo">174</span><a id="line.174"> * Creates a new {@code DaemonPermission} instance with a specified</a> -<span class="sourceLineNo">175</span><a id="line.175"> * permission name.</a> -<span class="sourceLineNo">176</span><a id="line.176"> * <p></a> -<span class="sourceLineNo">177</span><a id="line.177"> * This constructor will create a new {@code DaemonPermission}</a> -<span class="sourceLineNo">178</span><a id="line.178"> * instance that <b>will not</b> grant any permission to the caller.</a> -<span class="sourceLineNo">179</span><a id="line.179"> *</a> -<span class="sourceLineNo">180</span><a id="line.180"> * @param target The target name of this permission.</a> -<span class="sourceLineNo">181</span><a id="line.181"> * @throws IllegalArgumentException If the specified target name is not</a> -<span class="sourceLineNo">182</span><a id="line.182"> * supported.</a> -<span class="sourceLineNo">183</span><a id="line.183"> */</a> -<span class="sourceLineNo">184</span><a id="line.184"> public DaemonPermission(final String target)</a> -<span class="sourceLineNo">185</span><a id="line.185"> throws IllegalArgumentException</a> -<span class="sourceLineNo">186</span><a id="line.186"> {</a> -<span class="sourceLineNo">187</span><a id="line.187"> // Set up the target name of this permission object.</a> -<span class="sourceLineNo">188</span><a id="line.188"> super(target);</a> -<span class="sourceLineNo">189</span><a id="line.189"></a> -<span class="sourceLineNo">190</span><a id="line.190"> // Check if the permission target name was specified</a> -<span class="sourceLineNo">191</span><a id="line.191"> if (target == null) {</a> -<span class="sourceLineNo">192</span><a id="line.192"> throw new IllegalArgumentException("Null permission name");</a> -<span class="sourceLineNo">193</span><a id="line.193"> }</a> -<span class="sourceLineNo">194</span><a id="line.194"></a> -<span class="sourceLineNo">195</span><a id="line.195"> // Check if this is a "control" permission and set up accordingly.</a> -<span class="sourceLineNo">196</span><a id="line.196"> if (CONTROL.equalsIgnoreCase(target)) {</a> -<span class="sourceLineNo">197</span><a id="line.197"> type = TYPE_CONTROL;</a> -<span class="sourceLineNo">198</span><a id="line.198"> return;</a> -<span class="sourceLineNo">199</span><a id="line.199"> }</a> -<span class="sourceLineNo">200</span><a id="line.200"></a> -<span class="sourceLineNo">201</span><a id="line.201"> // If we got here, we have an invalid permission name.</a> -<span class="sourceLineNo">202</span><a id="line.202"> throw new IllegalArgumentException("Invalid permission name \"" +</a> -<span class="sourceLineNo">203</span><a id="line.203"> target + "\" specified");</a> -<span class="sourceLineNo">204</span><a id="line.204"> }</a> -<span class="sourceLineNo">205</span><a id="line.205"></a> -<span class="sourceLineNo">206</span><a id="line.206"> /**</a> -<span class="sourceLineNo">207</span><a id="line.207"> * Creates a new {@code DaemonPermission} instance with a specified</a> -<span class="sourceLineNo">208</span><a id="line.208"> * permission name and a specified list of actions.</a> -<span class="sourceLineNo">209</span><a id="line.209"> *</a> -<span class="sourceLineNo">210</span><a id="line.210"> * @param target The target name of this permission.</a> -<span class="sourceLineNo">211</span><a id="line.211"> * @param actions The list of actions permitted by this permission.</a> -<span class="sourceLineNo">212</span><a id="line.212"> * @throws IllegalArgumentException If the specified target name is not</a> -<span class="sourceLineNo">213</span><a id="line.213"> * supported, or the specified list of actions includes an</a> -<span class="sourceLineNo">214</span><a id="line.214"> * invalid value.</a> -<span class="sourceLineNo">215</span><a id="line.215"> */</a> -<span class="sourceLineNo">216</span><a id="line.216"> public DaemonPermission(final String target, final String actions)</a> -<span class="sourceLineNo">217</span><a id="line.217"> throws IllegalArgumentException</a> -<span class="sourceLineNo">218</span><a id="line.218"> {</a> -<span class="sourceLineNo">219</span><a id="line.219"> // Setup this instance's target name.</a> -<span class="sourceLineNo">220</span><a id="line.220"> this(target);</a> -<span class="sourceLineNo">221</span><a id="line.221"></a> -<span class="sourceLineNo">222</span><a id="line.222"> // Create the appropriate mask if this is a control permission.</a> -<span class="sourceLineNo">223</span><a id="line.223"> if (this.type == TYPE_CONTROL) {</a> -<span class="sourceLineNo">224</span><a id="line.224"> this.mask = this.createControlMask(actions);</a> -<span class="sourceLineNo">225</span><a id="line.225"> }</a> -<span class="sourceLineNo">226</span><a id="line.226"> }</a> -<span class="sourceLineNo">227</span><a id="line.227"></a> -<span class="sourceLineNo">228</span><a id="line.228"> /* ====================================================================</a> -<span class="sourceLineNo">229</span><a id="line.229"> * Public methods</a> -<span class="sourceLineNo">230</span><a id="line.230"> */</a> -<span class="sourceLineNo">231</span><a id="line.231"></a> -<span class="sourceLineNo">232</span><a id="line.232"> /**</a> -<span class="sourceLineNo">233</span><a id="line.233"> * Returns the list of actions permitted by this instance of</a> -<span class="sourceLineNo">234</span><a id="line.234"> * {@code DaemonPermission} in its canonical form.</a> -<span class="sourceLineNo">235</span><a id="line.235"> *</a> -<span class="sourceLineNo">236</span><a id="line.236"> * @return The canonicalized list of actions.</a> -<span class="sourceLineNo">237</span><a id="line.237"> */</a> -<span class="sourceLineNo">238</span><a id="line.238"> @Override</a> -<span class="sourceLineNo">239</span><a id="line.239"> public String getActions()</a> -<span class="sourceLineNo">240</span><a id="line.240"> {</a> -<span class="sourceLineNo">241</span><a id="line.241"> if (this.type == TYPE_CONTROL) {</a> -<span class="sourceLineNo">242</span><a id="line.242"> return this.createControlActions(this.mask);</a> -<span class="sourceLineNo">243</span><a id="line.243"> }</a> -<span class="sourceLineNo">244</span><a id="line.244"> return "";</a> -<span class="sourceLineNo">245</span><a id="line.245"> }</a> -<span class="sourceLineNo">246</span><a id="line.246"></a> -<span class="sourceLineNo">247</span><a id="line.247"> /**</a> -<span class="sourceLineNo">248</span><a id="line.248"> * Returns the hash code for this {@code DaemonPermission} instance.</a> -<span class="sourceLineNo">249</span><a id="line.249"> *</a> -<span class="sourceLineNo">250</span><a id="line.250"> * @return An hash code value.</a> -<span class="sourceLineNo">251</span><a id="line.251"> */</a> -<span class="sourceLineNo">252</span><a id="line.252"> @Override</a> -<span class="sourceLineNo">253</span><a id="line.253"> public int hashCode()</a> -<span class="sourceLineNo">254</span><a id="line.254"> {</a> -<span class="sourceLineNo">255</span><a id="line.255"> this.setupDescription();</a> -<span class="sourceLineNo">256</span><a id="line.256"> return this.desc.hashCode();</a> -<span class="sourceLineNo">257</span><a id="line.257"> }</a> -<span class="sourceLineNo">258</span><a id="line.258"></a> -<span class="sourceLineNo">259</span><a id="line.259"> /**</a> -<span class="sourceLineNo">260</span><a id="line.260"> * Checks if a specified object equals {@code DaemonPermission}.</a> -<span class="sourceLineNo">261</span><a id="line.261"> *</a> -<span class="sourceLineNo">262</span><a id="line.262"> * @return <b>true</b> or <b>false</b> whether the specified object equals</a> -<span class="sourceLineNo">263</span><a id="line.263"> * this {@code DaemonPermission} instance or not.</a> -<span class="sourceLineNo">264</span><a id="line.264"> */</a> -<span class="sourceLineNo">265</span><a id="line.265"> @Override</a> -<span class="sourceLineNo">266</span><a id="line.266"> public boolean equals(final Object object)</a> -<span class="sourceLineNo">267</span><a id="line.267"> {</a> -<span class="sourceLineNo">268</span><a id="line.268"> if (object == this) {</a> -<span class="sourceLineNo">269</span><a id="line.269"> return true;</a> -<span class="sourceLineNo">270</span><a id="line.270"> }</a> -<span class="sourceLineNo">271</span><a id="line.271"></a> -<span class="sourceLineNo">272</span><a id="line.272"> if (!(object instanceof DaemonPermission)) {</a> -<span class="sourceLineNo">273</span><a id="line.273"> return false;</a> -<span class="sourceLineNo">274</span><a id="line.274"> }</a> -<span class="sourceLineNo">275</span><a id="line.275"></a> -<span class="sourceLineNo">276</span><a id="line.276"> final DaemonPermission that = (DaemonPermission) object;</a> -<span class="sourceLineNo">277</span><a id="line.277"></a> -<span class="sourceLineNo">278</span><a id="line.278"> if (this.type != that.type) {</a> -<span class="sourceLineNo">279</span><a id="line.279"> return false;</a> -<span class="sourceLineNo">280</span><a id="line.280"> }</a> -<span class="sourceLineNo">281</span><a id="line.281"> return this.mask == that.mask;</a> -<span class="sourceLineNo">282</span><a id="line.282"> }</a> -<span class="sourceLineNo">283</span><a id="line.283"></a> -<span class="sourceLineNo">284</span><a id="line.284"> /**</a> -<span class="sourceLineNo">285</span><a id="line.285"> * Checks if this {@code DaemonPermission} implies another</a> -<span class="sourceLineNo">286</span><a id="line.286"> * {@code Permission}.</a> -<span class="sourceLineNo">287</span><a id="line.287"> *</a> -<span class="sourceLineNo">288</span><a id="line.288"> * @return <b>true</b> or <b>false</b> whether the specified permission</a> -<span class="sourceLineNo">289</span><a id="line.289"> * is implied by this {@code DaemonPermission} instance or</a> -<span class="sourceLineNo">290</span><a id="line.290"> * not.</a> -<span class="sourceLineNo">291</span><a id="line.291"> */</a> -<span class="sourceLineNo">292</span><a id="line.292"> @Override</a> -<span class="sourceLineNo">293</span><a id="line.293"> public boolean implies(final Permission permission)</a> -<span class="sourceLineNo">294</span><a id="line.294"> {</a> -<span class="sourceLineNo">295</span><a id="line.295"> if (permission == this) {</a> -<span class="sourceLineNo">296</span><a id="line.296"> return true;</a> -<span class="sourceLineNo">297</span><a id="line.297"> }</a> -<span class="sourceLineNo">298</span><a id="line.298"></a> -<span class="sourceLineNo">299</span><a id="line.299"> if (!(permission instanceof DaemonPermission)) {</a> -<span class="sourceLineNo">300</span><a id="line.300"> return false;</a> -<span class="sourceLineNo">301</span><a id="line.301"> }</a> -<span class="sourceLineNo">302</span><a id="line.302"></a> -<span class="sourceLineNo">303</span><a id="line.303"> final DaemonPermission that = (DaemonPermission) permission;</a> -<span class="sourceLineNo">304</span><a id="line.304"></a> -<span class="sourceLineNo">305</span><a id="line.305"> if (this.type != that.type) {</a> -<span class="sourceLineNo">306</span><a id="line.306"> return false;</a> -<span class="sourceLineNo">307</span><a id="line.307"> }</a> -<span class="sourceLineNo">308</span><a id="line.308"> return (this.mask & that.mask) == that.mask;</a> -<span class="sourceLineNo">309</span><a id="line.309"> }</a> -<span class="sourceLineNo">310</span><a id="line.310"></a> -<span class="sourceLineNo">311</span><a id="line.311"> /**</a> -<span class="sourceLineNo">312</span><a id="line.312"> * Returns a {@code String} representation of this instance.</a> -<span class="sourceLineNo">313</span><a id="line.313"> *</a> -<span class="sourceLineNo">314</span><a id="line.314"> * @return A {@code String} representing this</a> -<span class="sourceLineNo">315</span><a id="line.315"> * {@code DaemonPermission} instance.</a> -<span class="sourceLineNo">316</span><a id="line.316"> */</a> -<span class="sourceLineNo">317</span><a id="line.317"> @Override</a> -<span class="sourceLineNo">318</span><a id="line.318"> public String toString()</a> -<span class="sourceLineNo">319</span><a id="line.319"> {</a> -<span class="sourceLineNo">320</span><a id="line.320"> this.setupDescription();</a> -<span class="sourceLineNo">321</span><a id="line.321"> return this.desc;</a> -<span class="sourceLineNo">322</span><a id="line.322"> }</a> -<span class="sourceLineNo">323</span><a id="line.323"></a> -<span class="sourceLineNo">324</span><a id="line.324"> /* ====================================================================</a> -<span class="sourceLineNo">325</span><a id="line.325"> * Private methods</a> -<span class="sourceLineNo">326</span><a id="line.326"> */</a> -<span class="sourceLineNo">327</span><a id="line.327"></a> -<span class="sourceLineNo">328</span><a id="line.328"> /**</a> -<span class="sourceLineNo">329</span><a id="line.329"> * Creates a String description for this permission instance.</a> -<span class="sourceLineNo">330</span><a id="line.330"> */</a> -<span class="sourceLineNo">331</span><a id="line.331"> private void setupDescription()</a> -<span class="sourceLineNo">332</span><a id="line.332"> {</a> -<span class="sourceLineNo">333</span><a id="line.333"> if (this.desc != null) {</a> -<span class="sourceLineNo">334</span><a id="line.334"> return;</a> -<span class="sourceLineNo">335</span><a id="line.335"> }</a> -<span class="sourceLineNo">336</span><a id="line.336"></a> -<span class="sourceLineNo">337</span><a id="line.337"> final StringBuilder buf = new StringBuilder();</a> -<span class="sourceLineNo">338</span><a id="line.338"> buf.append(this.getClass().getName());</a> -<span class="sourceLineNo">339</span><a id="line.339"> buf.append('[');</a> -<span class="sourceLineNo">340</span><a id="line.340"> switch (this.type) {</a> -<span class="sourceLineNo">341</span><a id="line.341"> case TYPE_CONTROL:</a> -<span class="sourceLineNo">342</span><a id="line.342"> buf.append(CONTROL);</a> -<span class="sourceLineNo">343</span><a id="line.343"> break;</a> -<span class="sourceLineNo">344</span><a id="line.344"> default:</a> -<span class="sourceLineNo">345</span><a id="line.345"> buf.append("UNKNOWN");</a> -<span class="sourceLineNo">346</span><a id="line.346"> break;</a> -<span class="sourceLineNo">347</span><a id="line.347"> }</a> -<span class="sourceLineNo">348</span><a id="line.348"> buf.append(':');</a> -<span class="sourceLineNo">349</span><a id="line.349"> buf.append(this.getActions());</a> -<span class="sourceLineNo">350</span><a id="line.350"> buf.append(']');</a> -<span class="sourceLineNo">351</span><a id="line.351"></a> -<span class="sourceLineNo">352</span><a id="line.352"> this.desc = buf.toString();</a> -<span class="sourceLineNo">353</span><a id="line.353"> }</a> -<span class="sourceLineNo">354</span><a id="line.354"></a> -<span class="sourceLineNo">355</span><a id="line.355"> /**</a> -<span class="sourceLineNo">356</span><a id="line.356"> * Creates a permission mask for a given control actions string.</a> -<span class="sourceLineNo">357</span><a id="line.357"> */</a> -<span class="sourceLineNo">358</span><a id="line.358"> private int createControlMask(final String actions)</a> -<span class="sourceLineNo">359</span><a id="line.359"> throws IllegalArgumentException</a> -<span class="sourceLineNo">360</span><a id="line.360"> {</a> -<span class="sourceLineNo">361</span><a id="line.361"> if (actions == null) {</a> -<span class="sourceLineNo">362</span><a id="line.362"> return 0;</a> -<span class="sourceLineNo">363</span><a id="line.363"> }</a> -<span class="sourceLineNo">364</span><a id="line.364"></a> -<span class="sourceLineNo">365</span><a id="line.365"> int mask = 0;</a> -<span class="sourceLineNo">366</span><a id="line.366"> final StringTokenizer tok = new StringTokenizer(actions, ",", false);</a> -<span class="sourceLineNo">367</span><a id="line.367"></a> -<span class="sourceLineNo">368</span><a id="line.368"> while (tok.hasMoreTokens()) {</a> -<span class="sourceLineNo">369</span><a id="line.369"> final String val = tok.nextToken().trim();</a> -<span class="sourceLineNo">370</span><a id="line.370"></a> -<span class="sourceLineNo">371</span><a id="line.371"> if (WILDCARD.equals(val)) {</a> -<span class="sourceLineNo">372</span><a id="line.372"> return MASK_CONTROL_START | MASK_CONTROL_STOP |</a> -<span class="sourceLineNo">373</span><a id="line.373"> MASK_CONTROL_SHUTDOWN | MASK_CONTROL_RELOAD;</a> -<span class="sourceLineNo">374</span><a id="line.374"> }</a> -<span class="sourceLineNo">375</span><a id="line.375"> if (CONTROL_START.equalsIgnoreCase(val)) {</a> -<span class="sourceLineNo">376</span><a id="line.376"> mask = mask | MASK_CONTROL_START;</a> -<span class="sourceLineNo">377</span><a id="line.377"> }</a> -<span class="sourceLineNo">378</span><a id="line.378"> else if (CONTROL_STOP.equalsIgnoreCase(val)) {</a> -<span class="sourceLineNo">379</span><a id="line.379"> mask = mask | MASK_CONTROL_STOP;</a> -<span class="sourceLineNo">380</span><a id="line.380"> }</a> -<span class="sourceLineNo">381</span><a id="line.381"> else if (CONTROL_SHUTDOWN.equalsIgnoreCase(val)) {</a> -<span class="sourceLineNo">382</span><a id="line.382"> mask = mask | MASK_CONTROL_SHUTDOWN;</a> -<span class="sourceLineNo">383</span><a id="line.383"> }</a> -<span class="sourceLineNo">384</span><a id="line.384"> else if (CONTROL_RELOAD.equalsIgnoreCase(val)) {</a> -<span class="sourceLineNo">385</span><a id="line.385"> mask = mask | MASK_CONTROL_RELOAD;</a> -<span class="sourceLineNo">386</span><a id="line.386"> }</a> -<span class="sourceLineNo">387</span><a id="line.387"> else {</a> -<span class="sourceLineNo">388</span><a id="line.388"> throw new IllegalArgumentException("Invalid action name \"" +</a> -<span class="sourceLineNo">389</span><a id="line.389"> val + "\" specified");</a> -<span class="sourceLineNo">390</span><a id="line.390"> }</a> -<span class="sourceLineNo">391</span><a id="line.391"> }</a> -<span class="sourceLineNo">392</span><a id="line.392"> return mask;</a> -<span class="sourceLineNo">393</span><a id="line.393"> }</a> -<span class="sourceLineNo">394</span><a id="line.394"></a> -<span class="sourceLineNo">395</span><a id="line.395"> /** Creates an actions list for a given control permission mask. */</a> -<span class="sourceLineNo">396</span><a id="line.396"> private String createControlActions(final int mask)</a> -<span class="sourceLineNo">397</span><a id="line.397"> {</a> -<span class="sourceLineNo">398</span><a id="line.398"> final StringBuilder buf = new StringBuilder();</a> -<span class="sourceLineNo">399</span><a id="line.399"> boolean sep = false;</a> -<span class="sourceLineNo">400</span><a id="line.400"></a> -<span class="sourceLineNo">401</span><a id="line.401"> if ((mask & MASK_CONTROL_START) == MASK_CONTROL_START) {</a> -<span class="sourceLineNo">402</span><a id="line.402"> sep = true;</a> -<span class="sourceLineNo">403</span><a id="line.403"> buf.append(CONTROL_START);</a> -<span class="sourceLineNo">404</span><a id="line.404"> }</a> -<span class="sourceLineNo">405</span><a id="line.405"></a> -<span class="sourceLineNo">406</span><a id="line.406"> if ((mask & MASK_CONTROL_STOP) == MASK_CONTROL_STOP) {</a> -<span class="sourceLineNo">407</span><a id="line.407"> if (sep) {</a> -<span class="sourceLineNo">408</span><a id="line.408"> buf.append(",");</a> -<span class="sourceLineNo">409</span><a id="line.409"> }</a> -<span class="sourceLineNo">410</span><a id="line.410"> else {</a> -<span class="sourceLineNo">411</span><a id="line.411"> sep = true;</a> -<span class="sourceLineNo">412</span><a id="line.412"> }</a> -<span class="sourceLineNo">413</span><a id="line.413"> buf.append(CONTROL_STOP);</a> -<span class="sourceLineNo">414</span><a id="line.414"> }</a> -<span class="sourceLineNo">415</span><a id="line.415"></a> -<span class="sourceLineNo">416</span><a id="line.416"> if ((mask & MASK_CONTROL_SHUTDOWN) == MASK_CONTROL_SHUTDOWN) {</a> -<span class="sourceLineNo">417</span><a id="line.417"> if (sep) {</a> -<span class="sourceLineNo">418</span><a id="line.418"> buf.append(",");</a> -<span class="sourceLineNo">419</span><a id="line.419"> }</a> -<span class="sourceLineNo">420</span><a id="line.420"> else {</a> -<span class="sourceLineNo">421</span><a id="line.421"> sep = true;</a> -<span class="sourceLineNo">422</span><a id="line.422"> }</a> -<span class="sourceLineNo">423</span><a id="line.423"> buf.append(CONTROL_SHUTDOWN);</a> -<span class="sourceLineNo">424</span><a id="line.424"> }</a> -<span class="sourceLineNo">425</span><a id="line.425"></a> -<span class="sourceLineNo">426</span><a id="line.426"> if ((mask & MASK_CONTROL_RELOAD) == MASK_CONTROL_RELOAD) {</a> -<span class="sourceLineNo">427</span><a id="line.427"> if (sep) {</a> -<span class="sourceLineNo">428</span><a id="line.428"> buf.append(",");</a> -<span class="sourceLineNo">429</span><a id="line.429"> }</a> -<span class="sourceLineNo">430</span><a id="line.430"> else {</a> -<span class="sourceLineNo">431</span><a id="line.431"> sep = true;</a> -<span class="sourceLineNo">432</span><a id="line.432"> }</a> -<span class="sourceLineNo">433</span><a id="line.433"> buf.append(CONTROL_RELOAD);</a> -<span class="sourceLineNo">434</span><a id="line.434"> }</a> -<span class="sourceLineNo">435</span><a id="line.435"></a> -<span class="sourceLineNo">436</span><a id="line.436"> return buf.toString();</a> -<span class="sourceLineNo">437</span><a id="line.437"> }</a> -<span class="sourceLineNo">438</span><a id="line.438">}</a> -<span class="sourceLineNo">439</span><a id="line.439"></a> +<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>import java.security.Permission;<a name="line.20"></a> +<span class="sourceLineNo">021</span>import java.util.StringTokenizer;<a name="line.21"></a> +<span class="sourceLineNo">022</span><a name="line.22"></a> +<span class="sourceLineNo">023</span>/**<a name="line.23"></a> +<span class="sourceLineNo">024</span> * Represents the permissions to control and query the status of<a name="line.24"></a> +<span class="sourceLineNo">025</span> * a {@code Daemon}. A {@code DaemonPermission} consists of a<a name="line.25"></a> +<span class="sourceLineNo">026</span> * target name and a list of actions associated with it.<a name="line.26"></a> +<span class="sourceLineNo">027</span> * <p><a name="line.27"></a> +<span class="sourceLineNo">028</span> * In this specification version the only available target name for this<a name="line.28"></a> +<span class="sourceLineNo">029</span> * permission is &quot;control&quot;, but further releases may add more target<a name="line.29"></a> +<span class="sourceLineNo">030</span> * names to fine-tune the access that needs to be granted to the caller.<a name="line.30"></a> +<span class="sourceLineNo">031</span> * </p><a name="line.31"></a> +<span class="sourceLineNo">032</span> * <p><a name="line.32"></a> +<span class="sourceLineNo">033</span> * Actions are defined by a string of comma-separated values, as shown in the<a name="line.33"></a> +<span class="sourceLineNo">034</span> * table below. The empty string implies no permission at all, while the<a name="line.34"></a> +<span class="sourceLineNo">035</span> * special &quot;*&quot; value implies all permissions for the given<a name="line.35"></a> +<span class="sourceLineNo">036</span> * name:<a name="line.36"></a> +<span class="sourceLineNo">037</span> * </p><a name="line.37"></a> +<span class="sourceLineNo">038</span> * <table border="1"><a name="line.38"></a> +<span class="sourceLineNo">039</span> * <caption>Supported Actions</caption><a name="line.39"></a> +<span class="sourceLineNo">040</span> * <tr><a name="line.40"></a> +<span class="sourceLineNo">041</span> * <th>Target&quot;Name</th><a name="line.41"></a> +<span class="sourceLineNo">042</span> * <th>Action</th><a name="line.42"></a> +<span class="sourceLineNo">043</span> * <th>Description</th><a name="line.43"></a> +<span class="sourceLineNo">044</span> * </tr><a name="line.44"></a> +<span class="sourceLineNo">045</span> * <tr><a name="line.45"></a> +<span class="sourceLineNo">046</span> * <td rowspan="5">&quot;control&quot;</td><a name="line.46"></a> +<span class="sourceLineNo">047</span> * <td>&quot;start&quot;</td><a name="line.47"></a> +<span class="sourceLineNo">048</span> * <td><a name="line.48"></a> +<span class="sourceLineNo">049</span> * The permission to call the {@code start()} method in an instance<a name="line.49"></a> +<span class="sourceLineNo">050</span> * of a {@code DaemonController} interface.<a name="line.50"></a> +<span class="sourceLineNo">051</span> * </td><a name="line.51"></a> +<span class="sourceLineNo">052</span> * </tr><a name="line.52"></a> +<span class="sourceLineNo">053</span> * <tr><a name="line.53"></a> +<span class="sourceLineNo">054</span> * <td>&quot;stop&quot;</td><a name="line.54"></a> +<span class="sourceLineNo">055</span> * <td><a name="line.55"></a> +<span class="sourceLineNo">056</span> * The permission to call the {@code stop()} method in an instance<a name="line.56"></a> +<span class="sourceLineNo">057</span> * of a {@code DaemonController} interface.<a name="line.57"></a> +<span class="sourceLineNo">058</span> * </td><a name="line.58"></a> +<span class="sourceLineNo">059</span> * </tr><a name="line.59"></a> +<span class="sourceLineNo">060</span> * <tr><a name="line.60"></a> +<span class="sourceLineNo">061</span> * <td>&quot;shutdown&quot;</td><a name="line.61"></a> +<span class="sourceLineNo">062</span> * <td><a name="line.62"></a> +<span class="sourceLineNo">063</span> * The permission to call the {@code shutdown()} method in an instance<a name="line.63"></a> +<span class="sourceLineNo">064</span> * of a {@code DaemonController} interface.<a name="line.64"></a> +<span class="sourceLineNo">065</span> * </td><a name="line.65"></a> +<span class="sourceLineNo">066</span> * </tr><a name="line.66"></a> +<span class="sourceLineNo">067</span> * <tr><a name="line.67"></a> +<span class="sourceLineNo">068</span> * <td>&quot;reload&quot;</td><a name="line.68"></a> +<span class="sourceLineNo">069</span> * <td><a name="line.69"></a> +<span class="sourceLineNo">070</span> * The permission to call the {@code reload()} method in an instance<a name="line.70"></a> +<span class="sourceLineNo">071</span> * of a {@code DaemonController} interface.<a name="line.71"></a> +<span class="sourceLineNo">072</span> * </td><a name="line.72"></a> +<span class="sourceLineNo">073</span> * </tr><a name="line.73"></a> +<span class="sourceLineNo">074</span> * <tr><a name="line.74"></a> +<span class="sourceLineNo">075</span> * <td>&quot;*&quot;</td><a name="line.75"></a> +<span class="sourceLineNo">076</span> * <td><a name="line.76"></a> +<span class="sourceLineNo">077</span> * The special wildcard action implies all above-mentioned action. This is<a name="line.77"></a> +<span class="sourceLineNo">078</span> * equal to construct a permission with the &quot;start, stop, shutdown,<a name="line.78"></a> +<span class="sourceLineNo">079</span> * reload&quot; list of actions.<a name="line.79"></a> +<span class="sourceLineNo">080</span> * </td><a name="line.80"></a> +<span class="sourceLineNo">081</span> * </tr><a name="line.81"></a> +<span class="sourceLineNo">082</span> * </table><a name="line.82"></a> +<span class="sourceLineNo">083</span> */<a name="line.83"></a> +<span class="sourceLineNo">084</span>public final class DaemonPermission extends Permission<a name="line.84"></a> +<span class="sourceLineNo">085</span>{<a name="line.85"></a> +<span class="sourceLineNo">086</span><a name="line.86"></a> +<span class="sourceLineNo">087</span> /* ====================================================================<a name="line.87"></a> +<span class="sourceLineNo">088</span> * Constants.<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> private static final long serialVersionUID = -8682149075879731987L;<a name="line.91"></a> +<span class="sourceLineNo">092</span><a name="line.92"></a> +<span class="sourceLineNo">093</span> /**<a name="line.93"></a> +<span class="sourceLineNo">094</span> * The target name when associated with control actions<a name="line.94"></a> +<span class="sourceLineNo">095</span> * (&quot;control&quot;).<a name="line.95"></a> +<span class="sourceLineNo">096</span> */<a name="line.96"></a> +<span class="sourceLineNo">097</span> protected static final String CONTROL = "control";<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> * The target type when associated with control actions.<a name="line.100"></a> +<span class="sourceLineNo">101</span> */<a name="line.101"></a> +<span class="sourceLineNo">102</span> protected static final int TYPE_CONTROL = 1;<a name="line.102"></a> +<span class="sourceLineNo">103</span><a name="line.103"></a> +<span class="sourceLineNo">104</span> /**<a name="line.104"></a> +<span class="sourceLineNo">105</span> * The action name associated with the permission to call the<a name="line.105"></a> +<span class="sourceLineNo">106</span> * {@code DaemonController.start()} method.<a name="line.106"></a> +<span class="sourceLineNo">107</span> */<a name="line.107"></a> +<span class="sourceLineNo">108</span> protected static final String CONTROL_START = "start";<a name="line.108"></a> +<span class="sourceLineNo">109</span><a name="line.109"></a> +<span class="sourceLineNo">110</span> /**<a name="line.110"></a> +<span class="sourceLineNo">111</span> * The action name associated with the permission to call the<a name="line.111"></a> +<span class="sourceLineNo">112</span> * {@code DaemonController.stop()} method.<a name="line.112"></a> +<span class="sourceLineNo">113</span> */<a name="line.113"></a> +<span class="sourceLineNo">114</span> protected static final String CONTROL_STOP = "stop";<a name="line.114"></a> +<span class="sourceLineNo">115</span><a name="line.115"></a> +<span class="sourceLineNo">116</span> /**<a name="line.116"></a> +<span class="sourceLineNo">117</span> * The action name associated with the permission to call the<a name="line.117"></a> +<span class="sourceLineNo">118</span> * {@code DaemonController.shutdown()} method.<a name="line.118"></a> +<span class="sourceLineNo">119</span> */<a name="line.119"></a> +<span class="sourceLineNo">120</span> protected static final String CONTROL_SHUTDOWN = "shutdown";<a name="line.120"></a> +<span class="sourceLineNo">121</span><a name="line.121"></a> +<span class="sourceLineNo">122</span> /**<a name="line.122"></a> +<span class="sourceLineNo">123</span> * The action name associated with the permission to call the<a name="line.123"></a> +<span class="sourceLineNo">124</span> * {@code DaemonController.reload()} method.<a name="line.124"></a> +<span class="sourceLineNo">125</span> */<a name="line.125"></a> +<span class="sourceLineNo">126</span> protected static final String CONTROL_RELOAD = "reload";<a name="line.126"></a> +<span class="sourceLineNo">127</span><a name="line.127"></a> +<span class="sourceLineNo">128</span> /**<a name="line.128"></a> +<span class="sourceLineNo">129</span> * The action mask associated with the permission to call the<a name="line.129"></a> +<span class="sourceLineNo">130</span> * {@code DaemonController.start()} method.<a name="line.130"></a> +<span class="sourceLineNo">131</span> */<a name="line.131"></a> +<span class="sourceLineNo">132</span> protected static final int MASK_CONTROL_START = 0x01;<a name="line.132"></a> +<span class="sourceLineNo">133</span><a name="line.133"></a> +<span class="sourceLineNo">134</span> /**<a name="line.134"></a> +<span class="sourceLineNo">135</span> * The action mask associated with the permission to call the<a name="line.135"></a> +<span class="sourceLineNo">136</span> * {@code DaemonController.stop()} method.<a name="line.136"></a> +<span class="sourceLineNo">137</span> */<a name="line.137"></a> +<span class="sourceLineNo">138</span> protected static final int MASK_CONTROL_STOP = 0x02;<a name="line.138"></a> +<span class="sourceLineNo">139</span><a name="line.139"></a> +<span class="sourceLineNo">140</span> /**<a name="line.140"></a> +<span class="sourceLineNo">141</span> * The action mask associated with the permission to call the<a name="line.141"></a> +<span class="sourceLineNo">142</span> * {@code DaemonController.shutdown()} method.<a name="line.142"></a> +<span class="sourceLineNo">143</span> */<a name="line.143"></a> +<span class="sourceLineNo">144</span> protected static final int MASK_CONTROL_SHUTDOWN = 0x04;<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> * The action mask associated with the permission to call the<a name="line.147"></a> +<span class="sourceLineNo">148</span> * {@code DaemonController.reload()} method.<a name="line.148"></a> +<span class="sourceLineNo">149</span> */<a name="line.149"></a> +<span class="sourceLineNo">150</span> protected static final int MASK_CONTROL_RELOAD = 0x08;<a name="line.150"></a> +<span class="sourceLineNo">151</span><a name="line.151"></a> +<span class="sourceLineNo">152</span> /**<a name="line.152"></a> +<span class="sourceLineNo">153</span> * The &quot;wildcard&quot; action implying all actions for the given<a name="line.153"></a> +<span class="sourceLineNo">154</span> * target name.<a name="line.154"></a> +<span class="sourceLineNo">155</span> */<a name="line.155"></a> +<span class="sourceLineNo">156</span> protected static final String WILDCARD = "*";<a name="line.156"></a> +<span class="sourceLineNo">157</span><a name="line.157"></a> +<span class="sourceLineNo">158</span> /* ====================================================================<a name="line.158"></a> +<span class="sourceLineNo">159</span> * Instance variables<a name="line.159"></a> +<span class="sourceLineNo">160</span> */<a name="line.160"></a> +<span class="sourceLineNo">161</span><a name="line.161"></a> +<span class="sourceLineNo">162</span> /** The type of this permission object. */<a name="line.162"></a> +<span class="sourceLineNo">163</span> private transient int type;<a name="line.163"></a> +<span class="sourceLineNo">164</span> /** The permission mask associated with this permission object. */<a name="line.164"></a> +<span class="sourceLineNo">165</span> private transient int mask;<a name="line.165"></a> +<span class="sourceLineNo">166</span> /** The String representation of this permission object. */<a name="line.166"></a> +<span class="sourceLineNo">167</span> private transient String desc;<a name="line.167"></a> +<span class="sourceLineNo">168</span><a name="line.168"></a> +<span class="sourceLineNo">169</span> /* ====================================================================<a name="line.169"></a> +<span class="sourceLineNo">170</span> * Constructors<a name="line.170"></a> +<span class="sourceLineNo">171</span> */<a name="line.171"></a> +<span class="sourceLineNo">172</span><a name="line.172"></a> +<span class="sourceLineNo">173</span> /**<a name="line.173"></a> +<span class="sourceLineNo">174</span> * Creates a new {@code DaemonPermission} instance with a specified<a name="line.174"></a> +<span class="sourceLineNo">175</span> * permission name.<a name="line.175"></a> +<span class="sourceLineNo">176</span> * <p><a name="line.176"></a> +<span class="sourceLineNo">177</span> * This constructor will create a new {@code DaemonPermission}<a name="line.177"></a> +<span class="sourceLineNo">178</span> * instance that <b>will not</b> grant any permission to the caller.<a name="line.178"></a> +<span class="sourceLineNo">179</span> *<a name="line.179"></a> +<span class="sourceLineNo">180</span> * @param target The target name of this permission.<a name="line.180"></a> +<span class="sourceLineNo">181</span> * @throws IllegalArgumentException If the specified target name is not<a name="line.181"></a> +<span class="sourceLineNo">182</span> * supported.<a name="line.182"></a> +<span class="sourceLineNo">183</span> */<a name="line.183"></a> +<span class="sourceLineNo">184</span> public DaemonPermission(final String target)<a name="line.184"></a> +<span class="sourceLineNo">185</span> throws IllegalArgumentException<a name="line.185"></a> +<span class="sourceLineNo">186</span> {<a name="line.186"></a> +<span class="sourceLineNo">187</span> // Set up the target name of this permission object.<a name="line.187"></a> +<span class="sourceLineNo">188</span> super(target);<a name="line.188"></a> +<span class="sourceLineNo">189</span><a name="line.189"></a> +<span class="sourceLineNo">190</span> // Check if the permission target name was specified<a name="line.190"></a> +<span class="sourceLineNo">191</span> if (target == null) {<a name="line.191"></a> +<span class="sourceLineNo">192</span> throw new IllegalArgumentException("Null permission name");<a name="line.192"></a> +<span class="sourceLineNo">193</span> }<a name="line.193"></a> +<span class="sourceLineNo">194</span><a name="line.194"></a> +<span class="sourceLineNo">195</span> // Check if this is a "control" permission and set up accordingly.<a name="line.195"></a> +<span class="sourceLineNo">196</span> if (CONTROL.equalsIgnoreCase(target)) {<a name="line.196"></a> +<span class="sourceLineNo">197</span> type = TYPE_CONTROL;<a name="line.197"></a> +<span class="sourceLineNo">198</span> return;<a name="line.198"></a> +<span class="sourceLineNo">199</span> }<a name="line.199"></a> +<span class="sourceLineNo">200</span><a name="line.200"></a> +<span class="sourceLineNo">201</span> // If we got here, we have an invalid permission name.<a name="line.201"></a> +<span class="sourceLineNo">202</span> throw new IllegalArgumentException("Invalid permission name \"" +<a name="line.202"></a> +<span class="sourceLineNo">203</span> target + "\" specified");<a name="line.203"></a> +<span class="sourceLineNo">204</span> }<a name="line.204"></a> +<span class="sourceLineNo">205</span><a name="line.205"></a> +<span class="sourceLineNo">206</span> /**<a name="line.206"></a> +<span class="sourceLineNo">207</span> * Creates a new {@code DaemonPermission} instance with a specified<a name="line.207"></a> +<span class="sourceLineNo">208</span> * permission name and a specified list of actions.<a name="line.208"></a> +<span class="sourceLineNo">209</span> *<a name="line.209"></a> +<span class="sourceLineNo">210</span> * @param target The target name of this permission.<a name="line.210"></a> +<span class="sourceLineNo">211</span> * @param actions The list of actions permitted by this permission.<a name="line.211"></a> +<span class="sourceLineNo">212</span> * @throws IllegalArgumentException If the specified target name is not<a name="line.212"></a> +<span class="sourceLineNo">213</span> * supported, or the specified list of actions includes an<a name="line.213"></a> +<span class="sourceLineNo">214</span> * invalid value.<a name="line.214"></a> +<span class="sourceLineNo">215</span> */<a name="line.215"></a> +<span class="sourceLineNo">216</span> public DaemonPermission(final String target, final String actions)<a name="line.216"></a> +<span class="sourceLineNo">217</span> throws IllegalArgumentException<a name="line.217"></a> +<span class="sourceLineNo">218</span> {<a name="line.218"></a> +<span class="sourceLineNo">219</span> // Setup this instance's target name.<a name="line.219"></a> +<span class="sourceLineNo">220</span> this(target);<a name="line.220"></a> +<span class="sourceLineNo">221</span><a name="line.221"></a> +<span class="sourceLineNo">222</span> // Create the appropriate mask if this is a control permission.<a name="line.222"></a> +<span class="sourceLineNo">223</span> if (this.type == TYPE_CONTROL) {<a name="line.223"></a> +<span class="sourceLineNo">224</span> this.mask = this.createControlMask(actions);<a name="line.224"></a> +<span class="sourceLineNo">225</span> }<a name="line.225"></a> +<span class="sourceLineNo">226</span> }<a name="line.226"></a> +<span class="sourceLineNo">227</span><a name="line.227"></a> +<span class="sourceLineNo">228</span> /* ====================================================================<a name="line.228"></a> +<span class="sourceLineNo">229</span> * Public methods<a name="line.229"></a> +<span class="sourceLineNo">230</span> */<a name="line.230"></a> +<span class="sourceLineNo">231</span><a name="line.231"></a> +<span class="sourceLineNo">232</span> /**<a name="line.232"></a> +<span class="sourceLineNo">233</span> * Returns the list of actions permitted by this instance of<a name="line.233"></a> +<span class="sourceLineNo">234</span> * {@code DaemonPermission} in its canonical form.<a name="line.234"></a> +<span class="sourceLineNo">235</span> *<a name="line.235"></a> +<span class="sourceLineNo">236</span> * @return The canonicalized list of actions.<a name="line.236"></a> +<span class="sourceLineNo">237</span> */<a name="line.237"></a> +<span class="sourceLineNo">238</span> @Override<a name="line.238"></a> +<span class="sourceLineNo">239</span> public String getActions()<a name="line.239"></a> +<span class="sourceLineNo">240</span> {<a name="line.240"></a> +<span class="sourceLineNo">241</span> if (this.type == TYPE_CONTROL) {<a name="line.241"></a> +<span class="sourceLineNo">242</span> return this.createControlActions(this.mask);<a name="line.242"></a> +<span class="sourceLineNo">243</span> }<a name="line.243"></a> +<span class="sourceLineNo">244</span> return "";<a name="line.244"></a> +<span class="sourceLineNo">245</span> }<a name="line.245"></a> +<span class="sourceLineNo">246</span><a name="line.246"></a> +<span class="sourceLineNo">247</span> /**<a name="line.247"></a> +<span class="sourceLineNo">248</span> * Returns the hash code for this {@code DaemonPermission} instance.<a name="line.248"></a> +<span class="sourceLineNo">249</span> *<a name="line.249"></a> +<span class="sourceLineNo">250</span> * @return An hash code value.<a name="line.250"></a> +<span class="sourceLineNo">251</span> */<a name="line.251"></a> +<span class="sourceLineNo">252</span> @Override<a name="line.252"></a> +<span class="sourceLineNo">253</span> public int hashCode()<a name="line.253"></a> +<span class="sourceLineNo">254</span> {<a name="line.254"></a> +<span class="sourceLineNo">255</span> this.setupDescription();<a name="line.255"></a> +<span class="sourceLineNo">256</span> return this.desc.hashCode();<a name="line.256"></a> +<span class="sourceLineNo">257</span> }<a name="line.257"></a> +<span class="sourceLineNo">258</span><a name="line.258"></a> +<span class="sourceLineNo">259</span> /**<a name="line.259"></a> +<span class="sourceLineNo">260</span> * Checks if a specified object equals {@code DaemonPermission}.<a name="line.260"></a> +<span class="sourceLineNo">261</span> *<a name="line.261"></a> +<span class="sourceLineNo">262</span> * @return <b>true</b> or <b>false</b> whether the specified object equals<a name="line.262"></a> +<span class="sourceLineNo">263</span> * this {@code DaemonPermission} instance or not.<a name="line.263"></a> +<span class="sourceLineNo">264</span> */<a name="line.264"></a> +<span class="sourceLineNo">265</span> @Override<a name="line.265"></a> +<span class="sourceLineNo">266</span> public boolean equals(final Object object)<a name="line.266"></a> +<span class="sourceLineNo">267</span> {<a name="line.267"></a> +<span class="sourceLineNo">268</span> if (object == this) {<a name="line.268"></a> +<span class="sourceLineNo">269</span> return true;<a name="line.269"></a> +<span class="sourceLineNo">270</span> }<a name="line.270"></a> +<span class="sourceLineNo">271</span><a name="line.271"></a> +<span class="sourceLineNo">272</span> if (!(object instanceof DaemonPermission)) {<a name="line.272"></a> +<span class="sourceLineNo">273</span> return false;<a name="line.273"></a> +<span class="sourceLineNo">274</span> }<a name="line.274"></a> +<span class="sourceLineNo">275</span><a name="line.275"></a> +<span class="sourceLineNo">276</span> final DaemonPermission that = (DaemonPermission) object;<a name="line.276"></a> +<span class="sourceLineNo">277</span><a name="line.277"></a> +<span class="sourceLineNo">278</span> if (this.type != that.type) {<a name="line.278"></a> +<span class="sourceLineNo">279</span> return false;<a name="line.279"></a> +<span class="sourceLineNo">280</span> }<a name="line.280"></a> +<span class="sourceLineNo">281</span> return this.mask == that.mask;<a name="line.281"></a> +<span class="sourceLineNo">282</span> }<a name="line.282"></a> +<span class="sourceLineNo">283</span><a name="line.283"></a> +<span class="sourceLineNo">284</span> /**<a name="line.284"></a> +<span class="sourceLineNo">285</span> * Checks if this {@code DaemonPermission} implies another<a name="line.285"></a> +<span class="sourceLineNo">286</span> * {@code Permission}.<a name="line.286"></a> +<span class="sourceLineNo">287</span> *<a name="line.287"></a> +<span class="sourceLineNo">288</span> * @return <b>true</b> or <b>false</b> whether the specified permission<a name="line.288"></a> +<span class="sourceLineNo">289</span> * is implied by this {@code DaemonPermission} instance or<a name="line.289"></a> +<span class="sourceLineNo">290</span> * not.<a name="line.290"></a> +<span class="sourceLineNo">291</span> */<a name="line.291"></a> +<span class="sourceLineNo">292</span> @Override<a name="line.292"></a> +<span class="sourceLineNo">293</span> public boolean implies(final Permission permission)<a name="line.293"></a> +<span class="sourceLineNo">294</span> {<a name="line.294"></a> +<span class="sourceLineNo">295</span> if (permission == this) {<a name="line.295"></a> +<span class="sourceLineNo">296</span> return true;<a name="line.296"></a> +<span class="sourceLineNo">297</span> }<a name="line.297"></a> +<span class="sourceLineNo">298</span><a name="line.298"></a> +<span class="sourceLineNo">299</span> if (!(permission instanceof DaemonPermission)) {<a name="line.299"></a> +<span class="sourceLineNo">300</span> return false;<a name="line.300"></a> +<span class="sourceLineNo">301</span> }<a name="line.301"></a> +<span class="sourceLineNo">302</span><a name="line.302"></a> +<span class="sourceLineNo">303</span> final DaemonPermission that = (DaemonPermission) permission;<a name="line.303"></a> +<span class="sourceLineNo">304</span><a name="line.304"></a> +<span class="sourceLineNo">305</span> if (this.type != that.type) {<a name="line.305"></a> +<span class="sourceLineNo">306</span> return false;<a name="line.306"></a> +<span class="sourceLineNo">307</span> }<a name="line.307"></a> +<span class="sourceLineNo">308</span> return (this.mask & that.mask) == that.mask;<a name="line.308"></a> +<span class="sourceLineNo">309</span> }<a name="line.309"></a> +<span class="sourceLineNo">310</span><a name="line.310"></a> +<span class="sourceLineNo">311</span> /**<a name="line.311"></a> +<span class="sourceLineNo">312</span> * Returns a {@code String} representation of this instance.<a name="line.312"></a> +<span class="sourceLineNo">313</span> *<a name="line.313"></a> +<span class="sourceLineNo">314</span> * @return A {@code String} representing this<a name="line.314"></a> +<span class="sourceLineNo">315</span> * {@code DaemonPermission} instance.<a name="line.315"></a> +<span class="sourceLineNo">316</span> */<a name="line.316"></a> +<span class="sourceLineNo">317</span> @Override<a name="line.317"></a> +<span class="sourceLineNo">318</span> public String toString()<a name="line.318"></a> +<span class="sourceLineNo">319</span> {<a name="line.319"></a> +<span class="sourceLineNo">320</span> this.setupDescription();<a name="line.320"></a> +<span class="sourceLineNo">321</span> return this.desc;<a name="line.321"></a> +<span class="sourceLineNo">322</span> }<a name="line.322"></a> +<span class="sourceLineNo">323</span><a name="line.323"></a> +<span class="sourceLineNo">324</span> /* ====================================================================<a name="line.324"></a> +<span class="sourceLineNo">325</span> * Private methods<a name="line.325"></a> +<span class="sourceLineNo">326</span> */<a name="line.326"></a> +<span class="sourceLineNo">327</span><a name="line.327"></a> +<span class="sourceLineNo">328</span> /**<a name="line.328"></a> +<span class="sourceLineNo">329</span> * Creates a String description for this permission instance.<a name="line.329"></a> +<span class="sourceLineNo">330</span> */<a name="line.330"></a> +<span class="sourceLineNo">331</span> private void setupDescription()<a name="line.331"></a> +<span class="sourceLineNo">332</span> {<a name="line.332"></a> +<span class="sourceLineNo">333</span> if (this.desc != null) {<a name="line.333"></a> +<span class="sourceLineNo">334</span> return;<a name="line.334"></a> +<span class="sourceLineNo">335</span> }<a name="line.335"></a> +<span class="sourceLineNo">336</span><a name="line.336"></a> +<span class="sourceLineNo">337</span> final StringBuilder buf = new StringBuilder();<a name="line.337"></a> +<span class="sourceLineNo">338</span> buf.append(this.getClass().getName());<a name="line.338"></a> +<span class="sourceLineNo">339</span> buf.append('[');<a name="line.339"></a> +<span class="sourceLineNo">340</span> switch (this.type) {<a name="line.340"></a> +<span class="sourceLineNo">341</span> case TYPE_CONTROL:<a name="line.341"></a> +<span class="sourceLineNo">342</span> buf.append(CONTROL);<a name="line.342"></a> +<span class="sourceLineNo">343</span> break;<a name="line.343"></a> +<span class="sourceLineNo">344</span> default:<a name="line.344"></a> +<span class="sourceLineNo">345</span> buf.append("UNKNOWN");<a name="line.345"></a> +<span class="sourceLineNo">346</span> break;<a name="line.346"></a> +<span class="sourceLineNo">347</span> }<a name="line.347"></a> +<span class="sourceLineNo">348</span> buf.append(':');<a name="line.348"></a> +<span class="sourceLineNo">349</span> buf.append(this.getActions());<a name="line.349"></a> +<span class="sourceLineNo">350</span> buf.append(']');<a name="line.350"></a> +<span class="sourceLineNo">351</span><a name="line.351"></a> +<span class="sourceLineNo">352</span> this.desc = buf.toString();<a name="line.352"></a> +<span class="sourceLineNo">353</span> }<a name="line.353"></a> +<span class="sourceLineNo">354</span><a name="line.354"></a> +<span class="sourceLineNo">355</span> /**<a name="line.355"></a> +<span class="sourceLineNo">356</span> * Creates a permission mask for a given control actions string.<a name="line.356"></a> +<span class="sourceLineNo">357</span> */<a name="line.357"></a> +<span class="sourceLineNo">358</span> private int createControlMask(final String actions)<a name="line.358"></a> +<span class="sourceLineNo">359</span> throws IllegalArgumentException<a name="line.359"></a> +<span class="sourceLineNo">360</span> {<a name="line.360"></a> +<span class="sourceLineNo">361</span> if (actions == null) {<a name="line.361"></a> +<span class="sourceLineNo">362</span> return 0;<a name="line.362"></a> +<span class="sourceLineNo">363</span> }<a name="line.363"></a> +<span class="sourceLineNo">364</span><a name="line.364"></a> +<span class="sourceLineNo">365</span> int mask = 0;<a name="line.365"></a> +<span class="sourceLineNo">366</span> final StringTokenizer tok = new StringTokenizer(actions, ",", false);<a name="line.366"></a> +<span class="sourceLineNo">367</span><a name="line.367"></a> +<span class="sourceLineNo">368</span> while (tok.hasMoreTokens()) {<a name="line.368"></a> +<span class="sourceLineNo">369</span> final String val = tok.nextToken().trim();<a name="line.369"></a> +<span class="sourceLineNo">370</span><a name="line.370"></a> +<span class="sourceLineNo">371</span> if (WILDCARD.equals(val)) {<a name="line.371"></a> +<span class="sourceLineNo">372</span> return MASK_CONTROL_START | MASK_CONTROL_STOP |<a name="line.372"></a> +<span class="sourceLineNo">373</span> MASK_CONTROL_SHUTDOWN | MASK_CONTROL_RELOAD;<a name="line.373"></a> +<span class="sourceLineNo">374</span> }<a name="line.374"></a> +<span class="sourceLineNo">375</span> if (CONTROL_START.equalsIgnoreCase(val)) {<a name="line.375"></a> +<span class="sourceLineNo">376</span> mask = mask | MASK_CONTROL_START;<a name="line.376"></a> +<span class="sourceLineNo">377</span> }<a name="line.377"></a> +<span class="sourceLineNo">378</span> else if (CONTROL_STOP.equalsIgnoreCase(val)) {<a name="line.378"></a> +<span class="sourceLineNo">379</span> mask = mask | MASK_CONTROL_STOP;<a name="line.379"></a> +<span class="sourceLineNo">380</span> }<a name="line.380"></a> +<span class="sourceLineNo">381</span> else if (CONTROL_SHUTDOWN.equalsIgnoreCase(val)) {<a name="line.381"></a> +<span class="sourceLineNo">382</span> mask = mask | MASK_CONTROL_SHUTDOWN;<a name="line.382"></a> +<span class="sourceLineNo">383</span> }<a name="line.383"></a> +<span class="sourceLineNo">384</span> else if (CONTROL_RELOAD.equalsIgnoreCase(val)) {<a name="line.384"></a> +<span class="sourceLineNo">385</span> mask = mask | MASK_CONTROL_RELOAD;<a name="line.385"></a> +<span class="sourceLineNo">386</span> }<a name="line.386"></a> +<span class="sourceLineNo">387</span> else {<a name="line.387"></a> +<span class="sourceLineNo">388</span> throw new IllegalArgumentException("Invalid action name \"" +<a name="line.388"></a> +<span class="sourceLineNo">389</span> val + "\" specified");<a name="line.389"></a> +<span class="sourceLineNo">390</span> }<a name="line.390"></a> +<span class="sourceLineNo">391</span> }<a name="line.391"></a> +<span class="sourceLineNo">392</span> return mask;<a name="line.392"></a> +<span class="sourceLineNo">393</span> }<a name="line.393"></a> +<span class="sourceLineNo">394</span><a name="line.394"></a> +<span class="sourceLineNo">395</span> /** Creates an actions list for a given control permission mask. */<a name="line.395"></a> +<span class="sourceLineNo">396</span> private String createControlActions(final int mask)<a name="line.396"></a> +<span class="sourceLineNo">397</span> {<a name="line.397"></a> +<span class="sourceLineNo">398</span> final StringBuilder buf = new StringBuilder();<a name="line.398"></a> +<span class="sourceLineNo">399</span> boolean sep = false;<a name="line.399"></a> +<span class="sourceLineNo">400</span><a name="line.400"></a> +<span class="sourceLineNo">401</span> if ((mask & MASK_CONTROL_START) == MASK_CONTROL_START) {<a name="line.401"></a> +<span class="sourceLineNo">402</span> sep = true;<a name="line.402"></a> +<span class="sourceLineNo">403</span> buf.append(CONTROL_START);<a name="line.403"></a> +<span class="sourceLineNo">404</span> }<a name="line.404"></a> +<span class="sourceLineNo">405</span><a name="line.405"></a> +<span class="sourceLineNo">406</span> if ((mask & MASK_CONTROL_STOP) == MASK_CONTROL_STOP) {<a name="line.406"></a> +<span class="sourceLineNo">407</span> if (sep) {<a name="line.407"></a> +<span class="sourceLineNo">408</span> buf.append(",");<a name="line.408"></a> +<span class="sourceLineNo">409</span> }<a name="line.409"></a> +<span class="sourceLineNo">410</span> else {<a name="line.410"></a> +<span class="sourceLineNo">411</span> sep = true;<a name="line.411"></a> +<span class="sourceLineNo">412</span> }<a name="line.412"></a> +<span class="sourceLineNo">413</span> buf.append(CONTROL_STOP);<a name="line.413"></a> +<span class="sourceLineNo">414</span> }<a name="line.414"></a> +<span class="sourceLineNo">415</span><a name="line.415"></a> +<span class="sourceLineNo">416</span> if ((mask & MASK_CONTROL_SHUTDOWN) == MASK_CONTROL_SHUTDOWN) {<a name="line.416"></a> +<span class="sourceLineNo">417</span> if (sep) {<a name="line.417"></a> +<span class="sourceLineNo">418</span> buf.append(",");<a name="line.418"></a> +<span class="sourceLineNo">419</span> }<a name="line.419"></a> +<span class="sourceLineNo">420</span> else {<a name="line.420"></a> +<span class="sourceLineNo">421</span> sep = true;<a name="line.421"></a> +<span class="sourceLineNo">422</span> }<a name="line.422"></a> +<span class="sourceLineNo">423</span> buf.append(CONTROL_SHUTDOWN);<a name="line.423"></a> +<span class="sourceLineNo">424</span> }<a name="line.424"></a> +<span class="sourceLineNo">425</span><a name="line.425"></a> +<span class="sourceLineNo">426</span> if ((mask & MASK_CONTROL_RELOAD) == MASK_CONTROL_RELOAD) {<a name="line.426"></a> +<span class="sourceLineNo">427</span> if (sep) {<a name="line.427"></a> +<span class="sourceLineNo">428</span> buf.append(",");<a name="line.428"></a> +<span class="sourceLineNo">429</span> }<a name="line.429"></a> +<span class="sourceLineNo">430</span> else {<a name="line.430"></a> +<span class="sourceLineNo">431</span> sep = true;<a name="line.431"></a> +<span class="sourceLineNo">432</span> }<a name="line.432"></a> +<span class="sourceLineNo">433</span> buf.append(CONTROL_RELOAD);<a name="line.433"></a> +<span class="sourceLineNo">434</span> }<a name="line.434"></a> +<span class="sourceLineNo">435</span><a name="line.435"></a> +<span class="sourceLineNo">436</span> return buf.toString();<a name="line.436"></a> +<span class="sourceLineNo">437</span> }<a name="line.437"></a> +<span class="sourceLineNo">438</span>}<a name="line.438"></a> +<span class="sourceLineNo">439</span><a name="line.439"></a> @@ -508,6 +507,5 @@ </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/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 12 13:32:29 2023 @@ -1,49 +1,48 @@ -<!DOCTYPE HTML> +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> <html lang="en"> <head> <title>Source code</title> <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> </head> <body> -<main role="main"> <div class="sourceContainer"> -<pre><span class="sourceLineNo">001</span><a id="line.1">/*</a> -<span class="sourceLineNo">002</span><a id="line.2"> * Licensed to the Apache Software Foundation (ASF) under one or more</a> -<span class="sourceLineNo">003</span><a id="line.3"> * contributor license agreements. See the NOTICE file distributed with</a> -<span class="sourceLineNo">004</span><a id="line.4"> * this work for additional information regarding copyright ownership.</a> -<span class="sourceLineNo">005</span><a id="line.5"> * The ASF licenses this file to You under the Apache License, Version 2.0</a> -<span class="sourceLineNo">006</span><a id="line.6"> * (the "License"); you may not use this file except in compliance with</a> -<span class="sourceLineNo">007</span><a id="line.7"> * the License. You may obtain a copy of the License at</a> -<span class="sourceLineNo">008</span><a id="line.8"> *</a> -<span class="sourceLineNo">009</span><a id="line.9"> * http://www.apache.org/licenses/LICENSE-2.0</a> -<span class="sourceLineNo">010</span><a id="line.10"> *</a> -<span class="sourceLineNo">011</span><a id="line.11"> * Unless required by applicable law or agreed to in writing, software</a> -<span class="sourceLineNo">012</span><a id="line.12"> * distributed under the License is distributed on an "AS IS" BASIS,</a> -<span class="sourceLineNo">013</span><a id="line.13"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</a> -<span class="sourceLineNo">014</span><a id="line.14"> * See the License for the specific language governing permissions and</a> -<span class="sourceLineNo">015</span><a id="line.15"> * limitations under the License.</a> -<span class="sourceLineNo">016</span><a id="line.16"> */</a> -<span class="sourceLineNo">017</span><a id="line.17"></a> -<span class="sourceLineNo">018</span><a id="line.18">package org.apache.commons.daemon;</a> -<span class="sourceLineNo">019</span><a id="line.19"></a> -<span class="sourceLineNo">020</span><a id="line.20">/**</a> -<span class="sourceLineNo">021</span><a id="line.21"> * Tags a Daemon as supporting some kind of</a> -<span class="sourceLineNo">022</span><a id="line.22"> * signalling method that allows the java application to</a> -<span class="sourceLineNo">023</span><a id="line.23"> * perform a custom action.</a> -<span class="sourceLineNo">024</span><a id="line.24"> * <p></a> -<span class="sourceLineNo">025</span><a id="line.25"> * User must implement a signal method that will be called from</a> -<span class="sourceLineNo">026</span><a id="line.26"> * native upon receiving {@code SIGUSR2} signal from the operating system.</a> -<span class="sourceLineNo">027</span><a id="line.27"> * </p></a> -<span class="sourceLineNo">028</span><a id="line.28"> */</a> -<span class="sourceLineNo">029</span><a id="line.29">public interface DaemonUserSignal</a> -<span class="sourceLineNo">030</span><a id="line.30">{</a> -<span class="sourceLineNo">031</span><a id="line.31"></a> -<span class="sourceLineNo">032</span><a id="line.32"> /**</a> -<span class="sourceLineNo">033</span><a id="line.33"> * Performs a custom action on received user signal.</a> -<span class="sourceLineNo">034</span><a id="line.34"> */</a> -<span class="sourceLineNo">035</span><a id="line.35"> void signal();</a> -<span class="sourceLineNo">036</span><a id="line.36"></a> -<span class="sourceLineNo">037</span><a id="line.37">}</a> +<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> @@ -106,6 +105,5 @@ </pre> </div> -</main> </body> </html> \ No newline at end of file
