| <!DOCTYPE HTML> |
| <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">package org.apache.archiva.redback.common.config.api;</a> |
| <span class="sourceLineNo">002</span><a id="line.2"></a> |
| <span class="sourceLineNo">003</span><a id="line.3">/*</a> |
| <span class="sourceLineNo">004</span><a id="line.4"> * Licensed to the Apache Software Foundation (ASF) under one</a> |
| <span class="sourceLineNo">005</span><a id="line.5"> * or more contributor license agreements. See the NOTICE file</a> |
| <span class="sourceLineNo">006</span><a id="line.6"> * distributed with this work for additional information</a> |
| <span class="sourceLineNo">007</span><a id="line.7"> * regarding copyright ownership. The ASF licenses this file</a> |
| <span class="sourceLineNo">008</span><a id="line.8"> * to you under the Apache License, Version 2.0 (the</a> |
| <span class="sourceLineNo">009</span><a id="line.9"> * "License"); you may not use this file except in compliance</a> |
| <span class="sourceLineNo">010</span><a id="line.10"> * with the License. You may obtain a copy of the License at</a> |
| <span class="sourceLineNo">011</span><a id="line.11"> *</a> |
| <span class="sourceLineNo">012</span><a id="line.12"> * http://www.apache.org/licenses/LICENSE-2.0</a> |
| <span class="sourceLineNo">013</span><a id="line.13"> *</a> |
| <span class="sourceLineNo">014</span><a id="line.14"> * Unless required by applicable law or agreed to in writing,</a> |
| <span class="sourceLineNo">015</span><a id="line.15"> * software distributed under the License is distributed on an</a> |
| <span class="sourceLineNo">016</span><a id="line.16"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</a> |
| <span class="sourceLineNo">017</span><a id="line.17"> * KIND, either express or implied. See the License for the</a> |
| <span class="sourceLineNo">018</span><a id="line.18"> * specific language governing permissions and limitations</a> |
| <span class="sourceLineNo">019</span><a id="line.19"> * under the License.</a> |
| <span class="sourceLineNo">020</span><a id="line.20"> */</a> |
| <span class="sourceLineNo">021</span><a id="line.21"></a> |
| <span class="sourceLineNo">022</span><a id="line.22">import java.nio.file.Path;</a> |
| <span class="sourceLineNo">023</span><a id="line.23">import java.util.Collection;</a> |
| <span class="sourceLineNo">024</span><a id="line.24">import java.util.List;</a> |
| <span class="sourceLineNo">025</span><a id="line.25">import java.util.Map;</a> |
| <span class="sourceLineNo">026</span><a id="line.26">import java.util.NoSuchElementException;</a> |
| <span class="sourceLineNo">027</span><a id="line.27">import java.util.regex.Pattern;</a> |
| <span class="sourceLineNo">028</span><a id="line.28"></a> |
| <span class="sourceLineNo">029</span><a id="line.29">/**</a> |
| <span class="sourceLineNo">030</span><a id="line.30"> * The configuration registry is a single source of external configuration.</a> |
| <span class="sourceLineNo">031</span><a id="line.31"> *</a> |
| <span class="sourceLineNo">032</span><a id="line.32"> * Each configuration entry is accessible by a unique key. The keys may be hierarchical so, that</a> |
| <span class="sourceLineNo">033</span><a id="line.33"> * you can build subsets of the configuration.</a> |
| <span class="sourceLineNo">034</span><a id="line.34"> *</a> |
| <span class="sourceLineNo">035</span><a id="line.35"> * A configuration may be combined by multiple sources. How the multiple sources are combined, is</a> |
| <span class="sourceLineNo">036</span><a id="line.36"> * part of the implementation classes.</a> |
| <span class="sourceLineNo">037</span><a id="line.37"> *</a> |
| <span class="sourceLineNo">038</span><a id="line.38"> * You can register listeners that are notified, if the configuration changes. The syntax for filter</a> |
| <span class="sourceLineNo">039</span><a id="line.39"> * of notifications is implementation specific.</a> |
| <span class="sourceLineNo">040</span><a id="line.40"> *</a> |
| <span class="sourceLineNo">041</span><a id="line.41"> */</a> |
| <span class="sourceLineNo">042</span><a id="line.42">public interface ConfigRegistry</a> |
| <span class="sourceLineNo">043</span><a id="line.43">{</a> |
| <span class="sourceLineNo">044</span><a id="line.44"></a> |
| <span class="sourceLineNo">045</span><a id="line.45"> /**</a> |
| <span class="sourceLineNo">046</span><a id="line.46"> * Dump the entire registry to a string, for debugging purposes.</a> |
| <span class="sourceLineNo">047</span><a id="line.47"> *</a> |
| <span class="sourceLineNo">048</span><a id="line.48"> * @return the registry contents</a> |
| <span class="sourceLineNo">049</span><a id="line.49"> */</a> |
| <span class="sourceLineNo">050</span><a id="line.50"> String dump( );</a> |
| <span class="sourceLineNo">051</span><a id="line.51"></a> |
| <span class="sourceLineNo">052</span><a id="line.52"> /**</a> |
| <span class="sourceLineNo">053</span><a id="line.53"> * Get the original value stored in the registry. If not found, <code>null</code> is returned.</a> |
| <span class="sourceLineNo">054</span><a id="line.54"> *</a> |
| <span class="sourceLineNo">055</span><a id="line.55"> * @param key The key in the registry.</a> |
| <span class="sourceLineNo">056</span><a id="line.56"> * @return The value.</a> |
| <span class="sourceLineNo">057</span><a id="line.57"> */</a> |
| <span class="sourceLineNo">058</span><a id="line.58"> Object getValue( String key);</a> |
| <span class="sourceLineNo">059</span><a id="line.59"></a> |
| <span class="sourceLineNo">060</span><a id="line.60"> /**</a> |
| <span class="sourceLineNo">061</span><a id="line.61"> * Get a string value from the registry. If not found, <code>null</code> is returned.</a> |
| <span class="sourceLineNo">062</span><a id="line.62"> *</a> |
| <span class="sourceLineNo">063</span><a id="line.63"> * @param key the key in the registry</a> |
| <span class="sourceLineNo">064</span><a id="line.64"> * @return the value</a> |
| <span class="sourceLineNo">065</span><a id="line.65"> */</a> |
| <span class="sourceLineNo">066</span><a id="line.66"> String getString( String key );</a> |
| <span class="sourceLineNo">067</span><a id="line.67"></a> |
| <span class="sourceLineNo">068</span><a id="line.68"> /**</a> |
| <span class="sourceLineNo">069</span><a id="line.69"> * Get a string value from the registry. If not found, the default value is used.</a> |
| <span class="sourceLineNo">070</span><a id="line.70"> *</a> |
| <span class="sourceLineNo">071</span><a id="line.71"> * @param key the key in the registry</a> |
| <span class="sourceLineNo">072</span><a id="line.72"> * @param defaultValue the default value</a> |
| <span class="sourceLineNo">073</span><a id="line.73"> * @return the value</a> |
| <span class="sourceLineNo">074</span><a id="line.74"> */</a> |
| <span class="sourceLineNo">075</span><a id="line.75"> String getString( String key, String defaultValue );</a> |
| <span class="sourceLineNo">076</span><a id="line.76"></a> |
| <span class="sourceLineNo">077</span><a id="line.77"> /**</a> |
| <span class="sourceLineNo">078</span><a id="line.78"> * Set a string value in the registry.</a> |
| <span class="sourceLineNo">079</span><a id="line.79"> *</a> |
| <span class="sourceLineNo">080</span><a id="line.80"> * @param key the key in the registry</a> |
| <span class="sourceLineNo">081</span><a id="line.81"> * @param value the value to set</a> |
| <span class="sourceLineNo">082</span><a id="line.82"> */</a> |
| <span class="sourceLineNo">083</span><a id="line.83"> void setString( String key, String value );</a> |
| <span class="sourceLineNo">084</span><a id="line.84"></a> |
| <span class="sourceLineNo">085</span><a id="line.85"> /**</a> |
| <span class="sourceLineNo">086</span><a id="line.86"> * Get an integer value from the registry. If not found, an exception is thrown.</a> |
| <span class="sourceLineNo">087</span><a id="line.87"> *</a> |
| <span class="sourceLineNo">088</span><a id="line.88"> * @param key the key in the registry</a> |
| <span class="sourceLineNo">089</span><a id="line.89"> * @return the value</a> |
| <span class="sourceLineNo">090</span><a id="line.90"> * @throws java.util.NoSuchElementException</a> |
| <span class="sourceLineNo">091</span><a id="line.91"> * if the key is not found</a> |
| <span class="sourceLineNo">092</span><a id="line.92"> */</a> |
| <span class="sourceLineNo">093</span><a id="line.93"> int getInt( String key ) throws NoSuchElementException;</a> |
| <span class="sourceLineNo">094</span><a id="line.94"></a> |
| <span class="sourceLineNo">095</span><a id="line.95"> /**</a> |
| <span class="sourceLineNo">096</span><a id="line.96"> * Get an integer value from the registry. If not found, the default value is used.</a> |
| <span class="sourceLineNo">097</span><a id="line.97"> *</a> |
| <span class="sourceLineNo">098</span><a id="line.98"> * @param key the key in the registry</a> |
| <span class="sourceLineNo">099</span><a id="line.99"> * @param defaultValue the default value</a> |
| <span class="sourceLineNo">100</span><a id="line.100"> * @return the value</a> |
| <span class="sourceLineNo">101</span><a id="line.101"> */</a> |
| <span class="sourceLineNo">102</span><a id="line.102"> int getInt( String key, int defaultValue );</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"> * Set an integer value in the registry.</a> |
| <span class="sourceLineNo">106</span><a id="line.106"> *</a> |
| <span class="sourceLineNo">107</span><a id="line.107"> * @param key the key in the registry</a> |
| <span class="sourceLineNo">108</span><a id="line.108"> * @param value the value to set</a> |
| <span class="sourceLineNo">109</span><a id="line.109"> */</a> |
| <span class="sourceLineNo">110</span><a id="line.110"> void setInt( String key, int value );</a> |
| <span class="sourceLineNo">111</span><a id="line.111"></a> |
| <span class="sourceLineNo">112</span><a id="line.112"> /**</a> |
| <span class="sourceLineNo">113</span><a id="line.113"> * Get a boolean value from the registry. If not found, an exception is thrown.</a> |
| <span class="sourceLineNo">114</span><a id="line.114"> *</a> |
| <span class="sourceLineNo">115</span><a id="line.115"> * @param key the key in the registry</a> |
| <span class="sourceLineNo">116</span><a id="line.116"> * @return the value</a> |
| <span class="sourceLineNo">117</span><a id="line.117"> * @throws java.util.NoSuchElementException</a> |
| <span class="sourceLineNo">118</span><a id="line.118"> * if the key is not found</a> |
| <span class="sourceLineNo">119</span><a id="line.119"> */</a> |
| <span class="sourceLineNo">120</span><a id="line.120"> boolean getBoolean( String key ) throws NoSuchElementException;</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"> * Get a boolean value from the registry. If not found, the default value is used.</a> |
| <span class="sourceLineNo">124</span><a id="line.124"> *</a> |
| <span class="sourceLineNo">125</span><a id="line.125"> * @param key the key in the registry</a> |
| <span class="sourceLineNo">126</span><a id="line.126"> * @param defaultValue the default value</a> |
| <span class="sourceLineNo">127</span><a id="line.127"> * @return the value</a> |
| <span class="sourceLineNo">128</span><a id="line.128"> */</a> |
| <span class="sourceLineNo">129</span><a id="line.129"> boolean getBoolean( String key, boolean defaultValue );</a> |
| <span class="sourceLineNo">130</span><a id="line.130"></a> |
| <span class="sourceLineNo">131</span><a id="line.131"> /**</a> |
| <span class="sourceLineNo">132</span><a id="line.132"> * Set a boolean value in the registry.</a> |
| <span class="sourceLineNo">133</span><a id="line.133"> *</a> |
| <span class="sourceLineNo">134</span><a id="line.134"> * @param key the key in the registry</a> |
| <span class="sourceLineNo">135</span><a id="line.135"> * @param value the value to set</a> |
| <span class="sourceLineNo">136</span><a id="line.136"> */</a> |
| <span class="sourceLineNo">137</span><a id="line.137"> void setBoolean( String key, boolean value );</a> |
| <span class="sourceLineNo">138</span><a id="line.138"></a> |
| <span class="sourceLineNo">139</span><a id="line.139"> /**</a> |
| <span class="sourceLineNo">140</span><a id="line.140"> * Load configuration from the given classloader resource.</a> |
| <span class="sourceLineNo">141</span><a id="line.141"> *</a> |
| <span class="sourceLineNo">142</span><a id="line.142"> * @param name the unique name that identifies this configuration in the combined one</a> |
| <span class="sourceLineNo">143</span><a id="line.143"> * @param resource the location to load the configuration from</a> |
| <span class="sourceLineNo">144</span><a id="line.144"> * @throws RegistryException if a problem occurred reading the resource to add to the registry</a> |
| <span class="sourceLineNo">145</span><a id="line.145"> */</a> |
| <span class="sourceLineNo">146</span><a id="line.146"> void addConfigurationFromResource( String name, String resource )</a> |
| <span class="sourceLineNo">147</span><a id="line.147"> throws RegistryException;</a> |
| <span class="sourceLineNo">148</span><a id="line.148"></a> |
| <span class="sourceLineNo">149</span><a id="line.149"> /**</a> |
| <span class="sourceLineNo">150</span><a id="line.150"> * Load configuration from the given classloader resource.</a> |
| <span class="sourceLineNo">151</span><a id="line.151"> *</a> |
| <span class="sourceLineNo">152</span><a id="line.152"> * @param name the unique name that identifies this configuration in the combined one</a> |
| <span class="sourceLineNo">153</span><a id="line.153"> * @param resource the location to load the configuration from</a> |
| <span class="sourceLineNo">154</span><a id="line.154"> * @param prefix the location to add the configuration at in the registry</a> |
| <span class="sourceLineNo">155</span><a id="line.155"> * @throws RegistryException if a problem occurred reading the resource to add to the registry</a> |
| <span class="sourceLineNo">156</span><a id="line.156"> */</a> |
| <span class="sourceLineNo">157</span><a id="line.157"> void addConfigurationFromResource( String name, String resource, String prefix )</a> |
| <span class="sourceLineNo">158</span><a id="line.158"> throws RegistryException;</a> |
| <span class="sourceLineNo">159</span><a id="line.159"></a> |
| <span class="sourceLineNo">160</span><a id="line.160"> /**</a> |
| <span class="sourceLineNo">161</span><a id="line.161"> * Load configuration from the given file.</a> |
| <span class="sourceLineNo">162</span><a id="line.162"> *</a> |
| <span class="sourceLineNo">163</span><a id="line.163"> * @param name the unique name that identifies this configuration in the combined one</a> |
| <span class="sourceLineNo">164</span><a id="line.164"> * @param file the location to load the configuration from</a> |
| <span class="sourceLineNo">165</span><a id="line.165"> * @throws RegistryException if a problem occurred reading the resource to add to the registry</a> |
| <span class="sourceLineNo">166</span><a id="line.166"> */</a> |
| <span class="sourceLineNo">167</span><a id="line.167"> void addConfigurationFromFile( String name, Path file )</a> |
| <span class="sourceLineNo">168</span><a id="line.168"> throws RegistryException;</a> |
| <span class="sourceLineNo">169</span><a id="line.169"></a> |
| <span class="sourceLineNo">170</span><a id="line.170"> /**</a> |
| <span class="sourceLineNo">171</span><a id="line.171"> * Load configuration from the given file.</a> |
| <span class="sourceLineNo">172</span><a id="line.172"> *</a> |
| <span class="sourceLineNo">173</span><a id="line.173"> * @param name the unique name that identifies this configuration in the combined one</a> |
| <span class="sourceLineNo">174</span><a id="line.174"> * @param file the location to load the configuration from</a> |
| <span class="sourceLineNo">175</span><a id="line.175"> * @param prefix the location to add the configuration at in the registry</a> |
| <span class="sourceLineNo">176</span><a id="line.176"> * @throws RegistryException if a problem occurred reading the resource to add to the registry</a> |
| <span class="sourceLineNo">177</span><a id="line.177"> */</a> |
| <span class="sourceLineNo">178</span><a id="line.178"> void addConfigurationFromFile( String name, Path file, String prefix )</a> |
| <span class="sourceLineNo">179</span><a id="line.179"> throws RegistryException;</a> |
| <span class="sourceLineNo">180</span><a id="line.180"></a> |
| <span class="sourceLineNo">181</span><a id="line.181"> /**</a> |
| <span class="sourceLineNo">182</span><a id="line.182"> * Determine if the registry contains any elements.</a> |
| <span class="sourceLineNo">183</span><a id="line.183"> *</a> |
| <span class="sourceLineNo">184</span><a id="line.184"> * @return whether the registry contains any elements</a> |
| <span class="sourceLineNo">185</span><a id="line.185"> */</a> |
| <span class="sourceLineNo">186</span><a id="line.186"> boolean isEmpty( );</a> |
| <span class="sourceLineNo">187</span><a id="line.187"></a> |
| <span class="sourceLineNo">188</span><a id="line.188"> /**</a> |
| <span class="sourceLineNo">189</span><a id="line.189"> * Get a list of strings at the given key in the registry. If not found a empty list will be returned.</a> |
| <span class="sourceLineNo">190</span><a id="line.190"> *</a> |
| <span class="sourceLineNo">191</span><a id="line.191"> * @param key the key to lookup</a> |
| <span class="sourceLineNo">192</span><a id="line.192"> * @return the list of strings</a> |
| <span class="sourceLineNo">193</span><a id="line.193"> */</a> |
| <span class="sourceLineNo">194</span><a id="line.194"> List<String> getList( String key );</a> |
| <span class="sourceLineNo">195</span><a id="line.195"></a> |
| <span class="sourceLineNo">196</span><a id="line.196"> /**</a> |
| <span class="sourceLineNo">197</span><a id="line.197"> * Get the properties at the given key in the registry.</a> |
| <span class="sourceLineNo">198</span><a id="line.198"> *</a> |
| <span class="sourceLineNo">199</span><a id="line.199"> * @param key the key to lookup</a> |
| <span class="sourceLineNo">200</span><a id="line.200"> * @return the properties</a> |
| <span class="sourceLineNo">201</span><a id="line.201"> */</a> |
| <span class="sourceLineNo">202</span><a id="line.202"> Map<String, String> getProperties( String key );</a> |
| <span class="sourceLineNo">203</span><a id="line.203"></a> |
| <span class="sourceLineNo">204</span><a id="line.204"> /**</a> |
| <span class="sourceLineNo">205</span><a id="line.205"> * Get a subset of the registry, for all keys descended from the given key.</a> |
| <span class="sourceLineNo">206</span><a id="line.206"> *</a> |
| <span class="sourceLineNo">207</span><a id="line.207"> * @param key the key to take the subset from</a> |
| <span class="sourceLineNo">208</span><a id="line.208"> * @return the registry subset</a> |
| <span class="sourceLineNo">209</span><a id="line.209"> */</a> |
| <span class="sourceLineNo">210</span><a id="line.210"> ConfigRegistry getSubset( String key ) throws RegistryException;</a> |
| <span class="sourceLineNo">211</span><a id="line.211"></a> |
| <span class="sourceLineNo">212</span><a id="line.212"> /**</a> |
| <span class="sourceLineNo">213</span><a id="line.213"> * Get a list of subsets of the registry, for all keys descended from the given key.</a> |
| <span class="sourceLineNo">214</span><a id="line.214"> *</a> |
| <span class="sourceLineNo">215</span><a id="line.215"> * @param key the key to take the subsets from</a> |
| <span class="sourceLineNo">216</span><a id="line.216"> * @return the registry subsets</a> |
| <span class="sourceLineNo">217</span><a id="line.217"> */</a> |
| <span class="sourceLineNo">218</span><a id="line.218"> List<ConfigRegistry> getSubsetList( String key ) throws RegistryException;</a> |
| <span class="sourceLineNo">219</span><a id="line.219"></a> |
| <span class="sourceLineNo">220</span><a id="line.220"> /**</a> |
| <span class="sourceLineNo">221</span><a id="line.221"> * Get a configuration source part of the registry, identified by the given name. If it doesn't exist, <code>null</code> will be</a> |
| <span class="sourceLineNo">222</span><a id="line.222"> * returned.</a> |
| <span class="sourceLineNo">223</span><a id="line.223"> *</a> |
| <span class="sourceLineNo">224</span><a id="line.224"> * Configurations can be combined from different sources. This returns the configuration of a specific source.</a> |
| <span class="sourceLineNo">225</span><a id="line.225"> * The names are the ones given by the addConfiguration* methods or defined during the initialization process.</a> |
| <span class="sourceLineNo">226</span><a id="line.226"> *</a> |
| <span class="sourceLineNo">227</span><a id="line.227"> * @param name The source name of the configuration source.</a> |
| <span class="sourceLineNo">228</span><a id="line.228"> * @return the The config registry object that represents this source part.</a> |
| <span class="sourceLineNo">229</span><a id="line.229"> */</a> |
| <span class="sourceLineNo">230</span><a id="line.230"> ConfigRegistry getPartOfCombined(String name );</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"> * Save any changes to the registry since it was loaded.</a> |
| <span class="sourceLineNo">234</span><a id="line.234"> *</a> |
| <span class="sourceLineNo">235</span><a id="line.235"> * @throws RegistryException if there was a problem saving the registry</a> |
| <span class="sourceLineNo">236</span><a id="line.236"> * @throws UnsupportedOperationException if the registry is not writable</a> |
| <span class="sourceLineNo">237</span><a id="line.237"> */</a> |
| <span class="sourceLineNo">238</span><a id="line.238"> void save( )</a> |
| <span class="sourceLineNo">239</span><a id="line.239"> throws RegistryException, UnsupportedOperationException;</a> |
| <span class="sourceLineNo">240</span><a id="line.240"></a> |
| <span class="sourceLineNo">241</span><a id="line.241"> /**</a> |
| <span class="sourceLineNo">242</span><a id="line.242"> * Register a change listener for configuration keys that match the given patterns.</a> |
| <span class="sourceLineNo">243</span><a id="line.243"> *</a> |
| <span class="sourceLineNo">244</span><a id="line.244"> * @param listener the listener</a> |
| <span class="sourceLineNo">245</span><a id="line.245"> */</a> |
| <span class="sourceLineNo">246</span><a id="line.246"> void registerChangeListener( RegistryListener listener, String prefix );</a> |
| <span class="sourceLineNo">247</span><a id="line.247"></a> |
| <span class="sourceLineNo">248</span><a id="line.248"> /**</a> |
| <span class="sourceLineNo">249</span><a id="line.249"> * Unregister the change listener for all events.</a> |
| <span class="sourceLineNo">250</span><a id="line.250"> *</a> |
| <span class="sourceLineNo">251</span><a id="line.251"> * @param listener</a> |
| <span class="sourceLineNo">252</span><a id="line.252"> * @return <code>true</code> if has been removed</a> |
| <span class="sourceLineNo">253</span><a id="line.253"> */</a> |
| <span class="sourceLineNo">254</span><a id="line.254"> boolean unregisterChangeListener( RegistryListener listener );</a> |
| <span class="sourceLineNo">255</span><a id="line.255"></a> |
| <span class="sourceLineNo">256</span><a id="line.256"> /**</a> |
| <span class="sourceLineNo">257</span><a id="line.257"> * Get all keys on the base level in this registry. Keys are only retrieved at a depth of 1.</a> |
| <span class="sourceLineNo">258</span><a id="line.258"> *</a> |
| <span class="sourceLineNo">259</span><a id="line.259"> * @return the set of keys</a> |
| <span class="sourceLineNo">260</span><a id="line.260"> */</a> |
| <span class="sourceLineNo">261</span><a id="line.261"> Collection<String> getBaseKeys( );</a> |
| <span class="sourceLineNo">262</span><a id="line.262"></a> |
| <span class="sourceLineNo">263</span><a id="line.263"> /**</a> |
| <span class="sourceLineNo">264</span><a id="line.264"> * Get all the keys in this registry.</a> |
| <span class="sourceLineNo">265</span><a id="line.265"> * @return the set of keys</a> |
| <span class="sourceLineNo">266</span><a id="line.266"> */</a> |
| <span class="sourceLineNo">267</span><a id="line.267"> Collection<String> getKeys( );</a> |
| <span class="sourceLineNo">268</span><a id="line.268"></a> |
| <span class="sourceLineNo">269</span><a id="line.269"> /**</a> |
| <span class="sourceLineNo">270</span><a id="line.270"> * Return the keys that match the given prefix.</a> |
| <span class="sourceLineNo">271</span><a id="line.271"> *</a> |
| <span class="sourceLineNo">272</span><a id="line.272"> * @param prefix The prefix</a> |
| <span class="sourceLineNo">273</span><a id="line.273"> * @return A collection of keys</a> |
| <span class="sourceLineNo">274</span><a id="line.274"> */</a> |
| <span class="sourceLineNo">275</span><a id="line.275"> Collection<String> getKeys( String prefix);</a> |
| <span class="sourceLineNo">276</span><a id="line.276"></a> |
| <span class="sourceLineNo">277</span><a id="line.277"> /**</a> |
| <span class="sourceLineNo">278</span><a id="line.278"> * Remove a keyed element from the registry.</a> |
| <span class="sourceLineNo">279</span><a id="line.279"> *</a> |
| <span class="sourceLineNo">280</span><a id="line.280"> * @param key the key to remove</a> |
| <span class="sourceLineNo">281</span><a id="line.281"> */</a> |
| <span class="sourceLineNo">282</span><a id="line.282"> void remove( String key );</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"> * Remove a keyed subset of the registry.</a> |
| <span class="sourceLineNo">286</span><a id="line.286"> *</a> |
| <span class="sourceLineNo">287</span><a id="line.287"> * @param key the subset to remove</a> |
| <span class="sourceLineNo">288</span><a id="line.288"> */</a> |
| <span class="sourceLineNo">289</span><a id="line.289"> void removeSubset( String key );</a> |
| <span class="sourceLineNo">290</span><a id="line.290"></a> |
| <span class="sourceLineNo">291</span><a id="line.291"> /**</a> |
| <span class="sourceLineNo">292</span><a id="line.292"> * Initializes the given registry. The definition for the configuration sources is</a> |
| <span class="sourceLineNo">293</span><a id="line.293"> * implementation specific. Implementations should provide methods and/or constructors</a> |
| <span class="sourceLineNo">294</span><a id="line.294"> * that allows to define the configuration source.</a> |
| <span class="sourceLineNo">295</span><a id="line.295"> *</a> |
| <span class="sourceLineNo">296</span><a id="line.296"> * @throws RegistryException if the initialization was not successful</a> |
| <span class="sourceLineNo">297</span><a id="line.297"> */</a> |
| <span class="sourceLineNo">298</span><a id="line.298"> void initialize( ) throws RegistryException;</a> |
| <span class="sourceLineNo">299</span><a id="line.299">}</a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </main> |
| </body> |
| </html> |
