blob: 52505ef37164152cad3c8017b75c7f4d1d027da9 [file] [log] [blame]
<!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>
<div class="sourceContainer">
<pre><span class="sourceLineNo">001</span>/*<a name="line.1"></a>
<span class="sourceLineNo">002</span> * Licensed to the Apache Software Foundation (ASF) under one or more<a name="line.2"></a>
<span class="sourceLineNo">003</span> * contributor license agreements. See the NOTICE file distributed with<a name="line.3"></a>
<span class="sourceLineNo">004</span> * this work for additional information regarding copyright ownership.<a name="line.4"></a>
<span class="sourceLineNo">005</span> * The ASF licenses this file to You under the Apache license, Version 2.0<a name="line.5"></a>
<span class="sourceLineNo">006</span> * (the "License"); you may not use this file except in compliance with<a name="line.6"></a>
<span class="sourceLineNo">007</span> * the License. You may obtain a copy of the License at<a name="line.7"></a>
<span class="sourceLineNo">008</span> *<a name="line.8"></a>
<span class="sourceLineNo">009</span> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.9"></a>
<span class="sourceLineNo">010</span> *<a name="line.10"></a>
<span class="sourceLineNo">011</span> * Unless required by applicable law or agreed to in writing, software<a name="line.11"></a>
<span class="sourceLineNo">012</span> * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.12"></a>
<span class="sourceLineNo">013</span> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.13"></a>
<span class="sourceLineNo">014</span> * See the license for the specific language governing permissions and<a name="line.14"></a>
<span class="sourceLineNo">015</span> * limitations under the license.<a name="line.15"></a>
<span class="sourceLineNo">016</span> */<a name="line.16"></a>
<span class="sourceLineNo">017</span>package org.apache.logging.log4j.message;<a name="line.17"></a>
<span class="sourceLineNo">018</span><a name="line.18"></a>
<span class="sourceLineNo">019</span>import java.io.Serializable;<a name="line.19"></a>
<span class="sourceLineNo">020</span><a name="line.20"></a>
<span class="sourceLineNo">021</span>import org.apache.logging.log4j.util.StringBuilderFormattable;<a name="line.21"></a>
<span class="sourceLineNo">022</span>import org.apache.logging.log4j.util.Strings;<a name="line.22"></a>
<span class="sourceLineNo">023</span><a name="line.23"></a>
<span class="sourceLineNo">024</span>/**<a name="line.24"></a>
<span class="sourceLineNo">025</span> * The StructuredData identifier.<a name="line.25"></a>
<span class="sourceLineNo">026</span> */<a name="line.26"></a>
<span class="sourceLineNo">027</span>public class StructuredDataId implements Serializable, StringBuilderFormattable {<a name="line.27"></a>
<span class="sourceLineNo">028</span><a name="line.28"></a>
<span class="sourceLineNo">029</span> /**<a name="line.29"></a>
<span class="sourceLineNo">030</span> * RFC 5424 Time Quality.<a name="line.30"></a>
<span class="sourceLineNo">031</span> */<a name="line.31"></a>
<span class="sourceLineNo">032</span> public static final StructuredDataId TIME_QUALITY = new StructuredDataId("timeQuality", null, new String[] {<a name="line.32"></a>
<span class="sourceLineNo">033</span> "tzKnown", "isSynced", "syncAccuracy"});<a name="line.33"></a>
<span class="sourceLineNo">034</span><a name="line.34"></a>
<span class="sourceLineNo">035</span> /**<a name="line.35"></a>
<span class="sourceLineNo">036</span> * RFC 5424 Origin.<a name="line.36"></a>
<span class="sourceLineNo">037</span> */<a name="line.37"></a>
<span class="sourceLineNo">038</span> public static final StructuredDataId ORIGIN = new StructuredDataId("origin", null, new String[] {"ip",<a name="line.38"></a>
<span class="sourceLineNo">039</span> "enterpriseId", "software", "swVersion"});<a name="line.39"></a>
<span class="sourceLineNo">040</span><a name="line.40"></a>
<span class="sourceLineNo">041</span> /**<a name="line.41"></a>
<span class="sourceLineNo">042</span> * RFC 5424 Meta.<a name="line.42"></a>
<span class="sourceLineNo">043</span> */<a name="line.43"></a>
<span class="sourceLineNo">044</span> public static final StructuredDataId META = new StructuredDataId("meta", null, new String[] {"sequenceId",<a name="line.44"></a>
<span class="sourceLineNo">045</span> "sysUpTime", "language"});<a name="line.45"></a>
<span class="sourceLineNo">046</span><a name="line.46"></a>
<span class="sourceLineNo">047</span> /**<a name="line.47"></a>
<span class="sourceLineNo">048</span> * Reserved enterprise number.<a name="line.48"></a>
<span class="sourceLineNo">049</span> */<a name="line.49"></a>
<span class="sourceLineNo">050</span> public static final int RESERVED = -1;<a name="line.50"></a>
<span class="sourceLineNo">051</span><a name="line.51"></a>
<span class="sourceLineNo">052</span> private static final long serialVersionUID = 9031746276396249990L;<a name="line.52"></a>
<span class="sourceLineNo">053</span> private static final int MAX_LENGTH = 32;<a name="line.53"></a>
<span class="sourceLineNo">054</span> private static final String AT_SIGN = "@";<a name="line.54"></a>
<span class="sourceLineNo">055</span><a name="line.55"></a>
<span class="sourceLineNo">056</span> private final String name;<a name="line.56"></a>
<span class="sourceLineNo">057</span> private final int enterpriseNumber;<a name="line.57"></a>
<span class="sourceLineNo">058</span> private final String[] required;<a name="line.58"></a>
<span class="sourceLineNo">059</span> private final String[] optional;<a name="line.59"></a>
<span class="sourceLineNo">060</span><a name="line.60"></a>
<span class="sourceLineNo">061</span> /**<a name="line.61"></a>
<span class="sourceLineNo">062</span> * Creates a StructuredDataId based on the name.<a name="line.62"></a>
<span class="sourceLineNo">063</span> * @param name The Structured Data Element name (maximum length is 32)<a name="line.63"></a>
<span class="sourceLineNo">064</span> * @since 2.9<a name="line.64"></a>
<span class="sourceLineNo">065</span> */<a name="line.65"></a>
<span class="sourceLineNo">066</span> public StructuredDataId(final String name) {<a name="line.66"></a>
<span class="sourceLineNo">067</span> this(name, null, null, MAX_LENGTH);<a name="line.67"></a>
<span class="sourceLineNo">068</span> }<a name="line.68"></a>
<span class="sourceLineNo">069</span><a name="line.69"></a>
<span class="sourceLineNo">070</span> /**<a name="line.70"></a>
<span class="sourceLineNo">071</span> * Creates a StructuredDataId based on the name.<a name="line.71"></a>
<span class="sourceLineNo">072</span> * @param name The Structured Data Element name.<a name="line.72"></a>
<span class="sourceLineNo">073</span> * @param maxLength The maximum length of the name.<a name="line.73"></a>
<span class="sourceLineNo">074</span> * @since 2.9<a name="line.74"></a>
<span class="sourceLineNo">075</span> */<a name="line.75"></a>
<span class="sourceLineNo">076</span> public StructuredDataId(final String name, final int maxLength) {<a name="line.76"></a>
<span class="sourceLineNo">077</span> this(name, null, null, maxLength);<a name="line.77"></a>
<span class="sourceLineNo">078</span> }<a name="line.78"></a>
<span class="sourceLineNo">079</span><a name="line.79"></a>
<span class="sourceLineNo">080</span> /**<a name="line.80"></a>
<span class="sourceLineNo">081</span> *<a name="line.81"></a>
<span class="sourceLineNo">082</span> * @param name<a name="line.82"></a>
<span class="sourceLineNo">083</span> * @param required<a name="line.83"></a>
<span class="sourceLineNo">084</span> * @param optional<a name="line.84"></a>
<span class="sourceLineNo">085</span> */<a name="line.85"></a>
<span class="sourceLineNo">086</span> public StructuredDataId(final String name, final String[] required, final String[] optional) {<a name="line.86"></a>
<span class="sourceLineNo">087</span> this(name, required, optional, MAX_LENGTH);<a name="line.87"></a>
<span class="sourceLineNo">088</span> }<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> * A Constructor that helps conformance to RFC 5424.<a name="line.91"></a>
<span class="sourceLineNo">092</span> *<a name="line.92"></a>
<span class="sourceLineNo">093</span> * @param name The name portion of the id.<a name="line.93"></a>
<span class="sourceLineNo">094</span> * @param required The list of keys that are required for this id.<a name="line.94"></a>
<span class="sourceLineNo">095</span> * @param optional The list of keys that are optional for this id.<a name="line.95"></a>
<span class="sourceLineNo">096</span> * @since 2.9<a name="line.96"></a>
<span class="sourceLineNo">097</span> */<a name="line.97"></a>
<span class="sourceLineNo">098</span> public StructuredDataId(final String name, final String[] required, final String[] optional, int maxLength) {<a name="line.98"></a>
<span class="sourceLineNo">099</span> int index = -1;<a name="line.99"></a>
<span class="sourceLineNo">100</span> if (name != null) {<a name="line.100"></a>
<span class="sourceLineNo">101</span> if (maxLength &lt;= 0) {<a name="line.101"></a>
<span class="sourceLineNo">102</span> maxLength = MAX_LENGTH;<a name="line.102"></a>
<span class="sourceLineNo">103</span> }<a name="line.103"></a>
<span class="sourceLineNo">104</span> if (name.length() &gt; maxLength) {<a name="line.104"></a>
<span class="sourceLineNo">105</span> throw new IllegalArgumentException(String.format("Length of id %s exceeds maximum of %d characters",<a name="line.105"></a>
<span class="sourceLineNo">106</span> name, maxLength));<a name="line.106"></a>
<span class="sourceLineNo">107</span> }<a name="line.107"></a>
<span class="sourceLineNo">108</span> index = name.indexOf(AT_SIGN);<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> if (index &gt; 0) {<a name="line.111"></a>
<span class="sourceLineNo">112</span> this.name = name.substring(0, index);<a name="line.112"></a>
<span class="sourceLineNo">113</span> this.enterpriseNumber = Integer.parseInt(name.substring(index + 1));<a name="line.113"></a>
<span class="sourceLineNo">114</span> } else {<a name="line.114"></a>
<span class="sourceLineNo">115</span> this.name = name;<a name="line.115"></a>
<span class="sourceLineNo">116</span> this.enterpriseNumber = RESERVED;<a name="line.116"></a>
<span class="sourceLineNo">117</span> }<a name="line.117"></a>
<span class="sourceLineNo">118</span> this.required = required;<a name="line.118"></a>
<span class="sourceLineNo">119</span> this.optional = optional;<a name="line.119"></a>
<span class="sourceLineNo">120</span> }<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> * A Constructor that helps conformance to RFC 5424.<a name="line.123"></a>
<span class="sourceLineNo">124</span> *<a name="line.124"></a>
<span class="sourceLineNo">125</span> * @param name The name portion of the id.<a name="line.125"></a>
<span class="sourceLineNo">126</span> * @param enterpriseNumber The enterprise number.<a name="line.126"></a>
<span class="sourceLineNo">127</span> * @param required The list of keys that are required for this id.<a name="line.127"></a>
<span class="sourceLineNo">128</span> * @param optional The list of keys that are optional for this id.<a name="line.128"></a>
<span class="sourceLineNo">129</span> */<a name="line.129"></a>
<span class="sourceLineNo">130</span> public StructuredDataId(final String name, final int enterpriseNumber, final String[] required,<a name="line.130"></a>
<span class="sourceLineNo">131</span> final String[] optional) {<a name="line.131"></a>
<span class="sourceLineNo">132</span> this(name, enterpriseNumber, required, optional, MAX_LENGTH);<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> /**<a name="line.135"></a>
<span class="sourceLineNo">136</span> * A Constructor that helps conformance to RFC 5424.<a name="line.136"></a>
<span class="sourceLineNo">137</span> *<a name="line.137"></a>
<span class="sourceLineNo">138</span> * @param name The name portion of the id.<a name="line.138"></a>
<span class="sourceLineNo">139</span> * @param enterpriseNumber The enterprise number.<a name="line.139"></a>
<span class="sourceLineNo">140</span> * @param required The list of keys that are required for this id.<a name="line.140"></a>
<span class="sourceLineNo">141</span> * @param optional The list of keys that are optional for this id.<a name="line.141"></a>
<span class="sourceLineNo">142</span> * @param maxLength The maximum length of the StructuredData Id key.<a name="line.142"></a>
<span class="sourceLineNo">143</span> * @since 2.9<a name="line.143"></a>
<span class="sourceLineNo">144</span> */<a name="line.144"></a>
<span class="sourceLineNo">145</span> public StructuredDataId(final String name, final int enterpriseNumber, final String[] required,<a name="line.145"></a>
<span class="sourceLineNo">146</span> final String[] optional, final int maxLength) {<a name="line.146"></a>
<span class="sourceLineNo">147</span> if (name == null) {<a name="line.147"></a>
<span class="sourceLineNo">148</span> throw new IllegalArgumentException("No structured id name was supplied");<a name="line.148"></a>
<span class="sourceLineNo">149</span> }<a name="line.149"></a>
<span class="sourceLineNo">150</span> if (name.contains(AT_SIGN)) {<a name="line.150"></a>
<span class="sourceLineNo">151</span> throw new IllegalArgumentException("Structured id name cannot contain an " + Strings.quote(AT_SIGN));<a name="line.151"></a>
<span class="sourceLineNo">152</span> }<a name="line.152"></a>
<span class="sourceLineNo">153</span> if (enterpriseNumber &lt;= 0) {<a name="line.153"></a>
<span class="sourceLineNo">154</span> throw new IllegalArgumentException("No enterprise number was supplied");<a name="line.154"></a>
<span class="sourceLineNo">155</span> }<a name="line.155"></a>
<span class="sourceLineNo">156</span> this.name = name;<a name="line.156"></a>
<span class="sourceLineNo">157</span> this.enterpriseNumber = enterpriseNumber;<a name="line.157"></a>
<span class="sourceLineNo">158</span> final String id = name + AT_SIGN + enterpriseNumber;<a name="line.158"></a>
<span class="sourceLineNo">159</span> if (maxLength &gt; 0 &amp;&amp; id.length() &gt; maxLength) {<a name="line.159"></a>
<span class="sourceLineNo">160</span> throw new IllegalArgumentException("Length of id exceeds maximum of " + maxLength + " characters: " + id);<a name="line.160"></a>
<span class="sourceLineNo">161</span> }<a name="line.161"></a>
<span class="sourceLineNo">162</span> this.required = required;<a name="line.162"></a>
<span class="sourceLineNo">163</span> this.optional = optional;<a name="line.163"></a>
<span class="sourceLineNo">164</span> }<a name="line.164"></a>
<span class="sourceLineNo">165</span><a name="line.165"></a>
<span class="sourceLineNo">166</span> /**<a name="line.166"></a>
<span class="sourceLineNo">167</span> * Creates an id using another id to supply default values.<a name="line.167"></a>
<span class="sourceLineNo">168</span> *<a name="line.168"></a>
<span class="sourceLineNo">169</span> * @param id The original StructuredDataId.<a name="line.169"></a>
<span class="sourceLineNo">170</span> * @return the new StructuredDataId.<a name="line.170"></a>
<span class="sourceLineNo">171</span> */<a name="line.171"></a>
<span class="sourceLineNo">172</span> public StructuredDataId makeId(final StructuredDataId id) {<a name="line.172"></a>
<span class="sourceLineNo">173</span> if (id == null) {<a name="line.173"></a>
<span class="sourceLineNo">174</span> return this;<a name="line.174"></a>
<span class="sourceLineNo">175</span> }<a name="line.175"></a>
<span class="sourceLineNo">176</span> return makeId(id.getName(), id.getEnterpriseNumber());<a name="line.176"></a>
<span class="sourceLineNo">177</span> }<a name="line.177"></a>
<span class="sourceLineNo">178</span><a name="line.178"></a>
<span class="sourceLineNo">179</span> /**<a name="line.179"></a>
<span class="sourceLineNo">180</span> * Creates an id based on the current id.<a name="line.180"></a>
<span class="sourceLineNo">181</span> *<a name="line.181"></a>
<span class="sourceLineNo">182</span> * @param defaultId The default id to use if this StructuredDataId doesn't have a name.<a name="line.182"></a>
<span class="sourceLineNo">183</span> * @param anEnterpriseNumber The enterprise number.<a name="line.183"></a>
<span class="sourceLineNo">184</span> * @return a StructuredDataId.<a name="line.184"></a>
<span class="sourceLineNo">185</span> */<a name="line.185"></a>
<span class="sourceLineNo">186</span> public StructuredDataId makeId(final String defaultId, final int anEnterpriseNumber) {<a name="line.186"></a>
<span class="sourceLineNo">187</span> String id;<a name="line.187"></a>
<span class="sourceLineNo">188</span> String[] req;<a name="line.188"></a>
<span class="sourceLineNo">189</span> String[] opt;<a name="line.189"></a>
<span class="sourceLineNo">190</span> if (anEnterpriseNumber &lt;= 0) {<a name="line.190"></a>
<span class="sourceLineNo">191</span> return this;<a name="line.191"></a>
<span class="sourceLineNo">192</span> }<a name="line.192"></a>
<span class="sourceLineNo">193</span> if (this.name != null) {<a name="line.193"></a>
<span class="sourceLineNo">194</span> id = this.name;<a name="line.194"></a>
<span class="sourceLineNo">195</span> req = this.required;<a name="line.195"></a>
<span class="sourceLineNo">196</span> opt = this.optional;<a name="line.196"></a>
<span class="sourceLineNo">197</span> } else {<a name="line.197"></a>
<span class="sourceLineNo">198</span> id = defaultId;<a name="line.198"></a>
<span class="sourceLineNo">199</span> req = null;<a name="line.199"></a>
<span class="sourceLineNo">200</span> opt = null;<a name="line.200"></a>
<span class="sourceLineNo">201</span> }<a name="line.201"></a>
<span class="sourceLineNo">202</span><a name="line.202"></a>
<span class="sourceLineNo">203</span> return new StructuredDataId(id, anEnterpriseNumber, req, opt);<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> * Returns a list of required keys.<a name="line.207"></a>
<span class="sourceLineNo">208</span> *<a name="line.208"></a>
<span class="sourceLineNo">209</span> * @return a List of required keys or null if none have been provided.<a name="line.209"></a>
<span class="sourceLineNo">210</span> */<a name="line.210"></a>
<span class="sourceLineNo">211</span> public String[] getRequired() {<a name="line.211"></a>
<span class="sourceLineNo">212</span> return required;<a name="line.212"></a>
<span class="sourceLineNo">213</span> }<a name="line.213"></a>
<span class="sourceLineNo">214</span><a name="line.214"></a>
<span class="sourceLineNo">215</span> /**<a name="line.215"></a>
<span class="sourceLineNo">216</span> * Returns a list of optional keys.<a name="line.216"></a>
<span class="sourceLineNo">217</span> *<a name="line.217"></a>
<span class="sourceLineNo">218</span> * @return a List of optional keys or null if none have been provided.<a name="line.218"></a>
<span class="sourceLineNo">219</span> */<a name="line.219"></a>
<span class="sourceLineNo">220</span> public String[] getOptional() {<a name="line.220"></a>
<span class="sourceLineNo">221</span> return optional;<a name="line.221"></a>
<span class="sourceLineNo">222</span> }<a name="line.222"></a>
<span class="sourceLineNo">223</span><a name="line.223"></a>
<span class="sourceLineNo">224</span> /**<a name="line.224"></a>
<span class="sourceLineNo">225</span> * Returns the StructuredDataId name.<a name="line.225"></a>
<span class="sourceLineNo">226</span> *<a name="line.226"></a>
<span class="sourceLineNo">227</span> * @return the StructuredDataId name.<a name="line.227"></a>
<span class="sourceLineNo">228</span> */<a name="line.228"></a>
<span class="sourceLineNo">229</span> public String getName() {<a name="line.229"></a>
<span class="sourceLineNo">230</span> return name;<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> /**<a name="line.233"></a>
<span class="sourceLineNo">234</span> * Returns the enterprise number.<a name="line.234"></a>
<span class="sourceLineNo">235</span> *<a name="line.235"></a>
<span class="sourceLineNo">236</span> * @return the enterprise number.<a name="line.236"></a>
<span class="sourceLineNo">237</span> */<a name="line.237"></a>
<span class="sourceLineNo">238</span> public int getEnterpriseNumber() {<a name="line.238"></a>
<span class="sourceLineNo">239</span> return enterpriseNumber;<a name="line.239"></a>
<span class="sourceLineNo">240</span> }<a name="line.240"></a>
<span class="sourceLineNo">241</span><a name="line.241"></a>
<span class="sourceLineNo">242</span> /**<a name="line.242"></a>
<span class="sourceLineNo">243</span> * Indicates if the id is reserved.<a name="line.243"></a>
<span class="sourceLineNo">244</span> *<a name="line.244"></a>
<span class="sourceLineNo">245</span> * @return true if the id uses the reserved enterprise number, false otherwise.<a name="line.245"></a>
<span class="sourceLineNo">246</span> */<a name="line.246"></a>
<span class="sourceLineNo">247</span> public boolean isReserved() {<a name="line.247"></a>
<span class="sourceLineNo">248</span> return enterpriseNumber &lt;= 0;<a name="line.248"></a>
<span class="sourceLineNo">249</span> }<a name="line.249"></a>
<span class="sourceLineNo">250</span><a name="line.250"></a>
<span class="sourceLineNo">251</span> @Override<a name="line.251"></a>
<span class="sourceLineNo">252</span> public String toString() {<a name="line.252"></a>
<span class="sourceLineNo">253</span> final StringBuilder sb = new StringBuilder(name.length() + 10);<a name="line.253"></a>
<span class="sourceLineNo">254</span> formatTo(sb);<a name="line.254"></a>
<span class="sourceLineNo">255</span> return sb.toString();<a name="line.255"></a>
<span class="sourceLineNo">256</span> }<a name="line.256"></a>
<span class="sourceLineNo">257</span><a name="line.257"></a>
<span class="sourceLineNo">258</span> @Override<a name="line.258"></a>
<span class="sourceLineNo">259</span> public void formatTo(final StringBuilder buffer) {<a name="line.259"></a>
<span class="sourceLineNo">260</span> if (isReserved()) {<a name="line.260"></a>
<span class="sourceLineNo">261</span> buffer.append(name);<a name="line.261"></a>
<span class="sourceLineNo">262</span> } else {<a name="line.262"></a>
<span class="sourceLineNo">263</span> buffer.append(name).append(AT_SIGN).append(enterpriseNumber);<a name="line.263"></a>
<span class="sourceLineNo">264</span> }<a name="line.264"></a>
<span class="sourceLineNo">265</span> }<a name="line.265"></a>
<span class="sourceLineNo">266</span>}<a name="line.266"></a>
</pre>
</div>
</body>
</html>