| <HTML> |
| <BODY BGCOLOR="white"> |
| <PRE> |
| <FONT color="green">001</FONT> /*<a name="line.1"></a> |
| <FONT color="green">002</FONT> * Licensed to the Apache Software Foundation (ASF) under one<a name="line.2"></a> |
| <FONT color="green">003</FONT> * or more contributor license agreements. See the NOTICE file<a name="line.3"></a> |
| <FONT color="green">004</FONT> * distributed with this work for additional information<a name="line.4"></a> |
| <FONT color="green">005</FONT> * regarding copyright ownership. The ASF licenses this file<a name="line.5"></a> |
| <FONT color="green">006</FONT> * to you under the Apache License, Version 2.0 (the<a name="line.6"></a> |
| <FONT color="green">007</FONT> * "License"); you may not use this file except in compliance<a name="line.7"></a> |
| <FONT color="green">008</FONT> * with the License. You may obtain a copy of the License at<a name="line.8"></a> |
| <FONT color="green">009</FONT> *<a name="line.9"></a> |
| <FONT color="green">010</FONT> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.10"></a> |
| <FONT color="green">011</FONT> *<a name="line.11"></a> |
| <FONT color="green">012</FONT> * Unless required by applicable law or agreed to in writing,<a name="line.12"></a> |
| <FONT color="green">013</FONT> * software distributed under the License is distributed on an<a name="line.13"></a> |
| <FONT color="green">014</FONT> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY<a name="line.14"></a> |
| <FONT color="green">015</FONT> * KIND, either express or implied. See the License for the<a name="line.15"></a> |
| <FONT color="green">016</FONT> * specific language governing permissions and limitations<a name="line.16"></a> |
| <FONT color="green">017</FONT> * under the License.<a name="line.17"></a> |
| <FONT color="green">018</FONT> */<a name="line.18"></a> |
| <FONT color="green">019</FONT> package org.apache.shiro.crypto.hash.format;<a name="line.19"></a> |
| <FONT color="green">020</FONT> <a name="line.20"></a> |
| <FONT color="green">021</FONT> import org.apache.shiro.util.ClassUtils;<a name="line.21"></a> |
| <FONT color="green">022</FONT> import org.apache.shiro.util.StringUtils;<a name="line.22"></a> |
| <FONT color="green">023</FONT> import org.apache.shiro.util.UnknownClassException;<a name="line.23"></a> |
| <FONT color="green">024</FONT> <a name="line.24"></a> |
| <FONT color="green">025</FONT> import java.util.HashMap;<a name="line.25"></a> |
| <FONT color="green">026</FONT> import java.util.HashSet;<a name="line.26"></a> |
| <FONT color="green">027</FONT> import java.util.Map;<a name="line.27"></a> |
| <FONT color="green">028</FONT> import java.util.Set;<a name="line.28"></a> |
| <FONT color="green">029</FONT> <a name="line.29"></a> |
| <FONT color="green">030</FONT> /**<a name="line.30"></a> |
| <FONT color="green">031</FONT> * This default {@code HashFormatFactory} implementation heuristically determines a {@code HashFormat} class to<a name="line.31"></a> |
| <FONT color="green">032</FONT> * instantiate based on the input argument and returns a new instance of the discovered class. The heuristics are<a name="line.32"></a> |
| <FONT color="green">033</FONT> * detailed in the {@link #getInstance(String) getInstance} method documentation.<a name="line.33"></a> |
| <FONT color="green">034</FONT> *<a name="line.34"></a> |
| <FONT color="green">035</FONT> * @since 1.2<a name="line.35"></a> |
| <FONT color="green">036</FONT> */<a name="line.36"></a> |
| <FONT color="green">037</FONT> public class DefaultHashFormatFactory implements HashFormatFactory {<a name="line.37"></a> |
| <FONT color="green">038</FONT> <a name="line.38"></a> |
| <FONT color="green">039</FONT> private Map<String, String> formatClassNames; //id - to - fully qualified class name<a name="line.39"></a> |
| <FONT color="green">040</FONT> <a name="line.40"></a> |
| <FONT color="green">041</FONT> private Set<String> searchPackages; //packages to search for HashFormat implementations<a name="line.41"></a> |
| <FONT color="green">042</FONT> <a name="line.42"></a> |
| <FONT color="green">043</FONT> public DefaultHashFormatFactory() {<a name="line.43"></a> |
| <FONT color="green">044</FONT> this.searchPackages = new HashSet<String>();<a name="line.44"></a> |
| <FONT color="green">045</FONT> this.formatClassNames = new HashMap<String, String>();<a name="line.45"></a> |
| <FONT color="green">046</FONT> }<a name="line.46"></a> |
| <FONT color="green">047</FONT> <a name="line.47"></a> |
| <FONT color="green">048</FONT> /**<a name="line.48"></a> |
| <FONT color="green">049</FONT> * Returns a {@code hashFormatAlias}-to-<code>fullyQualifiedHashFormatClassNameImplementation</code> map.<a name="line.49"></a> |
| <FONT color="green">050</FONT> * <p/><a name="line.50"></a> |
| <FONT color="green">051</FONT> * This map will be used by the {@link #getInstance(String) getInstance} implementation: that method's argument<a name="line.51"></a> |
| <FONT color="green">052</FONT> * will be used as a lookup key to this map. If the map returns a value, that value will be used to instantiate<a name="line.52"></a> |
| <FONT color="green">053</FONT> * and return a new {@code HashFormat} instance.<a name="line.53"></a> |
| <FONT color="green">054</FONT> * <h3>Defaults</h3><a name="line.54"></a> |
| <FONT color="green">055</FONT> * Shiro's default HashFormat implementations (as listed by the {@link ProvidedHashFormat} enum) will<a name="line.55"></a> |
| <FONT color="green">056</FONT> * be searched automatically independently of this map. You only need to populate this map with custom<a name="line.56"></a> |
| <FONT color="green">057</FONT> * {@code HashFormat} implementations that are <em>not</em> already represented by a {@code ProvidedHashFormat}.<a name="line.57"></a> |
| <FONT color="green">058</FONT> * <h3>Efficiency</h3><a name="line.58"></a> |
| <FONT color="green">059</FONT> * Populating this map will be more efficient than configuring {@link #getSearchPackages() searchPackages},<a name="line.59"></a> |
| <FONT color="green">060</FONT> * but search packages may be more convenient depending on the number of {@code HashFormat} implementations that<a name="line.60"></a> |
| <FONT color="green">061</FONT> * need to be supported by this factory.<a name="line.61"></a> |
| <FONT color="green">062</FONT> *<a name="line.62"></a> |
| <FONT color="green">063</FONT> * @return a {@code hashFormatAlias}-to-<code>fullyQualifiedHashFormatClassNameImplementation</code> map.<a name="line.63"></a> |
| <FONT color="green">064</FONT> */<a name="line.64"></a> |
| <FONT color="green">065</FONT> public Map<String, String> getFormatClassNames() {<a name="line.65"></a> |
| <FONT color="green">066</FONT> return formatClassNames;<a name="line.66"></a> |
| <FONT color="green">067</FONT> }<a name="line.67"></a> |
| <FONT color="green">068</FONT> <a name="line.68"></a> |
| <FONT color="green">069</FONT> /**<a name="line.69"></a> |
| <FONT color="green">070</FONT> * Sets the {@code hash-format-alias}-to-{@code fullyQualifiedHashFormatClassNameImplementation} map to be used in<a name="line.70"></a> |
| <FONT color="green">071</FONT> * the {@link #getInstance(String)} implementation. See the {@link #getFormatClassNames()} JavaDoc for more<a name="line.71"></a> |
| <FONT color="green">072</FONT> * information.<a name="line.72"></a> |
| <FONT color="green">073</FONT> * <h3>Efficiency</h3><a name="line.73"></a> |
| <FONT color="green">074</FONT> * Populating this map will be more efficient than configuring {@link #getSearchPackages() searchPackages},<a name="line.74"></a> |
| <FONT color="green">075</FONT> * but search packages may be more convenient depending on the number of {@code HashFormat} implementations that<a name="line.75"></a> |
| <FONT color="green">076</FONT> * need to be supported by this factory.<a name="line.76"></a> |
| <FONT color="green">077</FONT> *<a name="line.77"></a> |
| <FONT color="green">078</FONT> * @param formatClassNames the {@code hash-format-alias}-to-{@code fullyQualifiedHashFormatClassNameImplementation}<a name="line.78"></a> |
| <FONT color="green">079</FONT> * map to be used in the {@link #getInstance(String)} implementation.<a name="line.79"></a> |
| <FONT color="green">080</FONT> */<a name="line.80"></a> |
| <FONT color="green">081</FONT> public void setFormatClassNames(Map<String, String> formatClassNames) {<a name="line.81"></a> |
| <FONT color="green">082</FONT> this.formatClassNames = formatClassNames;<a name="line.82"></a> |
| <FONT color="green">083</FONT> }<a name="line.83"></a> |
| <FONT color="green">084</FONT> <a name="line.84"></a> |
| <FONT color="green">085</FONT> /**<a name="line.85"></a> |
| <FONT color="green">086</FONT> * Returns a set of package names that can be searched for {@link HashFormat} implementations according to<a name="line.86"></a> |
| <FONT color="green">087</FONT> * heuristics defined in the {@link #getHashFormatClass(String, String) getHashFormat(packageName, token)} JavaDoc.<a name="line.87"></a> |
| <FONT color="green">088</FONT> * <h3>Efficiency</h3><a name="line.88"></a> |
| <FONT color="green">089</FONT> * Configuring this property is not as efficient as configuring a {@link #getFormatClassNames() formatClassNames}<a name="line.89"></a> |
| <FONT color="green">090</FONT> * map, but it may be more convenient depending on the number of {@code HashFormat} implementations that<a name="line.90"></a> |
| <FONT color="green">091</FONT> * need to be supported by this factory.<a name="line.91"></a> |
| <FONT color="green">092</FONT> *<a name="line.92"></a> |
| <FONT color="green">093</FONT> * @return a set of package names that can be searched for {@link HashFormat} implementations<a name="line.93"></a> |
| <FONT color="green">094</FONT> * @see #getHashFormatClass(String, String)<a name="line.94"></a> |
| <FONT color="green">095</FONT> */<a name="line.95"></a> |
| <FONT color="green">096</FONT> public Set<String> getSearchPackages() {<a name="line.96"></a> |
| <FONT color="green">097</FONT> return searchPackages;<a name="line.97"></a> |
| <FONT color="green">098</FONT> }<a name="line.98"></a> |
| <FONT color="green">099</FONT> <a name="line.99"></a> |
| <FONT color="green">100</FONT> /**<a name="line.100"></a> |
| <FONT color="green">101</FONT> * Sets a set of package names that can be searched for {@link HashFormat} implementations according to<a name="line.101"></a> |
| <FONT color="green">102</FONT> * heuristics defined in the {@link #getHashFormatClass(String, String) getHashFormat(packageName, token)} JavaDoc.<a name="line.102"></a> |
| <FONT color="green">103</FONT> * <h3>Efficiency</h3><a name="line.103"></a> |
| <FONT color="green">104</FONT> * Configuring this property is not as efficient as configuring a {@link #getFormatClassNames() formatClassNames}<a name="line.104"></a> |
| <FONT color="green">105</FONT> * map, but it may be more convenient depending on the number of {@code HashFormat} implementations that<a name="line.105"></a> |
| <FONT color="green">106</FONT> * need to be supported by this factory.<a name="line.106"></a> |
| <FONT color="green">107</FONT> *<a name="line.107"></a> |
| <FONT color="green">108</FONT> * @param searchPackages a set of package names that can be searched for {@link HashFormat} implementations<a name="line.108"></a> |
| <FONT color="green">109</FONT> */<a name="line.109"></a> |
| <FONT color="green">110</FONT> public void setSearchPackages(Set<String> searchPackages) {<a name="line.110"></a> |
| <FONT color="green">111</FONT> this.searchPackages = searchPackages;<a name="line.111"></a> |
| <FONT color="green">112</FONT> }<a name="line.112"></a> |
| <FONT color="green">113</FONT> <a name="line.113"></a> |
| <FONT color="green">114</FONT> public HashFormat getInstance(String in) {<a name="line.114"></a> |
| <FONT color="green">115</FONT> if (in == null) {<a name="line.115"></a> |
| <FONT color="green">116</FONT> return null;<a name="line.116"></a> |
| <FONT color="green">117</FONT> }<a name="line.117"></a> |
| <FONT color="green">118</FONT> <a name="line.118"></a> |
| <FONT color="green">119</FONT> HashFormat hashFormat = null;<a name="line.119"></a> |
| <FONT color="green">120</FONT> Class clazz = null;<a name="line.120"></a> |
| <FONT color="green">121</FONT> <a name="line.121"></a> |
| <FONT color="green">122</FONT> //NOTE: this code block occurs BEFORE calling getHashFormatClass(in) on purpose as a performance<a name="line.122"></a> |
| <FONT color="green">123</FONT> //optimization. If the input arg is an MCF-formatted string, there will be many unnecessary ClassLoader<a name="line.123"></a> |
| <FONT color="green">124</FONT> //misses which can be slow. By checking the MCF-formatted option, we can significantly improve performance<a name="line.124"></a> |
| <FONT color="green">125</FONT> if (in.startsWith(ModularCryptFormat.TOKEN_DELIMITER)) {<a name="line.125"></a> |
| <FONT color="green">126</FONT> //odds are high that the input argument is not a fully qualified class name or a format key (e.g. 'hex',<a name="line.126"></a> |
| <FONT color="green">127</FONT> //base64' or 'shiro1'). Try to find the key and lookup via that:<a name="line.127"></a> |
| <FONT color="green">128</FONT> String test = in.substring(ModularCryptFormat.TOKEN_DELIMITER.length());<a name="line.128"></a> |
| <FONT color="green">129</FONT> String[] tokens = test.split("\\" + ModularCryptFormat.TOKEN_DELIMITER);<a name="line.129"></a> |
| <FONT color="green">130</FONT> //the MCF ID is always the first token in the delimited string:<a name="line.130"></a> |
| <FONT color="green">131</FONT> String possibleMcfId = (tokens != null && tokens.length > 0) ? tokens[0] : null;<a name="line.131"></a> |
| <FONT color="green">132</FONT> if (possibleMcfId != null) {<a name="line.132"></a> |
| <FONT color="green">133</FONT> //found a possible MCF ID - test it using our heuristics to see if we can find a corresponding class:<a name="line.133"></a> |
| <FONT color="green">134</FONT> clazz = getHashFormatClass(possibleMcfId);<a name="line.134"></a> |
| <FONT color="green">135</FONT> }<a name="line.135"></a> |
| <FONT color="green">136</FONT> }<a name="line.136"></a> |
| <FONT color="green">137</FONT> <a name="line.137"></a> |
| <FONT color="green">138</FONT> if (clazz == null) {<a name="line.138"></a> |
| <FONT color="green">139</FONT> //not an MCF-formatted string - use the unaltered input arg and go through our heuristics:<a name="line.139"></a> |
| <FONT color="green">140</FONT> clazz = getHashFormatClass(in);<a name="line.140"></a> |
| <FONT color="green">141</FONT> }<a name="line.141"></a> |
| <FONT color="green">142</FONT> <a name="line.142"></a> |
| <FONT color="green">143</FONT> if (clazz != null) {<a name="line.143"></a> |
| <FONT color="green">144</FONT> //we found a HashFormat class - instantiate it:<a name="line.144"></a> |
| <FONT color="green">145</FONT> hashFormat = newHashFormatInstance(clazz);<a name="line.145"></a> |
| <FONT color="green">146</FONT> }<a name="line.146"></a> |
| <FONT color="green">147</FONT> <a name="line.147"></a> |
| <FONT color="green">148</FONT> return hashFormat;<a name="line.148"></a> |
| <FONT color="green">149</FONT> }<a name="line.149"></a> |
| <FONT color="green">150</FONT> <a name="line.150"></a> |
| <FONT color="green">151</FONT> /**<a name="line.151"></a> |
| <FONT color="green">152</FONT> * Heuristically determine the fully qualified HashFormat implementation class name based on the specified<a name="line.152"></a> |
| <FONT color="green">153</FONT> * token.<a name="line.153"></a> |
| <FONT color="green">154</FONT> * <p/><a name="line.154"></a> |
| <FONT color="green">155</FONT> * This implementation functions as follows (in order):<a name="line.155"></a> |
| <FONT color="green">156</FONT> * <ol><a name="line.156"></a> |
| <FONT color="green">157</FONT> * <li>See if the argument can be used as a lookup key in the {@link #getFormatClassNames() formatClassNames}<a name="line.157"></a> |
| <FONT color="green">158</FONT> * map. If a value (a fully qualified class name {@link HashFormat HashFormat} implementation) is found,<a name="line.158"></a> |
| <FONT color="green">159</FONT> * {@link ClassUtils#forName(String) lookup} the class and return it.</li><a name="line.159"></a> |
| <FONT color="green">160</FONT> * <li><a name="line.160"></a> |
| <FONT color="green">161</FONT> * Check to see if the token argument is a<a name="line.161"></a> |
| <FONT color="green">162</FONT> * {@link ProvidedHashFormat} enum value. If so, acquire the corresponding {@code HashFormat} class and<a name="line.162"></a> |
| <FONT color="green">163</FONT> * return it.<a name="line.163"></a> |
| <FONT color="green">164</FONT> * </li><a name="line.164"></a> |
| <FONT color="green">165</FONT> * <li><a name="line.165"></a> |
| <FONT color="green">166</FONT> * Check to see if the token argument is itself a fully qualified class name. If so, try to load the class<a name="line.166"></a> |
| <FONT color="green">167</FONT> * and return it.<a name="line.167"></a> |
| <FONT color="green">168</FONT> * </li><a name="line.168"></a> |
| <FONT color="green">169</FONT> * <li>If the above options do not result in a discovered class, search all all configured<a name="line.169"></a> |
| <FONT color="green">170</FONT> * {@link #getSearchPackages() searchPackages} using heuristics defined in the<a name="line.170"></a> |
| <FONT color="green">171</FONT> * {@link #getHashFormatClass(String, String) getHashFormatClass(packageName, token)} method documentation<a name="line.171"></a> |
| <FONT color="green">172</FONT> * (relaying the {@code token} argument to that method for each configured package).<a name="line.172"></a> |
| <FONT color="green">173</FONT> * </li><a name="line.173"></a> |
| <FONT color="green">174</FONT> * </ol><a name="line.174"></a> |
| <FONT color="green">175</FONT> * <p/><a name="line.175"></a> |
| <FONT color="green">176</FONT> * If a class is not discovered via any of the above means, {@code null} is returned to indicate the class<a name="line.176"></a> |
| <FONT color="green">177</FONT> * could not be found.<a name="line.177"></a> |
| <FONT color="green">178</FONT> *<a name="line.178"></a> |
| <FONT color="green">179</FONT> * @param token the string token from which a class name will be heuristically determined.<a name="line.179"></a> |
| <FONT color="green">180</FONT> * @return the discovered HashFormat class implementation or {@code null} if no class could be heuristically determined.<a name="line.180"></a> |
| <FONT color="green">181</FONT> */<a name="line.181"></a> |
| <FONT color="green">182</FONT> protected Class getHashFormatClass(String token) {<a name="line.182"></a> |
| <FONT color="green">183</FONT> <a name="line.183"></a> |
| <FONT color="green">184</FONT> Class clazz = null;<a name="line.184"></a> |
| <FONT color="green">185</FONT> <a name="line.185"></a> |
| <FONT color="green">186</FONT> //check to see if the token is a configured FQCN alias. This is faster than searching packages,<a name="line.186"></a> |
| <FONT color="green">187</FONT> //so we try this first:<a name="line.187"></a> |
| <FONT color="green">188</FONT> if (this.formatClassNames != null) {<a name="line.188"></a> |
| <FONT color="green">189</FONT> String value = this.formatClassNames.get(token);<a name="line.189"></a> |
| <FONT color="green">190</FONT> if (value != null) {<a name="line.190"></a> |
| <FONT color="green">191</FONT> //found an alias - see if the value is a class:<a name="line.191"></a> |
| <FONT color="green">192</FONT> clazz = lookupHashFormatClass(value);<a name="line.192"></a> |
| <FONT color="green">193</FONT> }<a name="line.193"></a> |
| <FONT color="green">194</FONT> }<a name="line.194"></a> |
| <FONT color="green">195</FONT> <a name="line.195"></a> |
| <FONT color="green">196</FONT> //check to see if the token is one of Shiro's provided FQCN aliases (again, faster than searching):<a name="line.196"></a> |
| <FONT color="green">197</FONT> if (clazz == null) {<a name="line.197"></a> |
| <FONT color="green">198</FONT> ProvidedHashFormat provided = ProvidedHashFormat.byId(token);<a name="line.198"></a> |
| <FONT color="green">199</FONT> if (provided != null) {<a name="line.199"></a> |
| <FONT color="green">200</FONT> clazz = provided.getHashFormatClass();<a name="line.200"></a> |
| <FONT color="green">201</FONT> }<a name="line.201"></a> |
| <FONT color="green">202</FONT> }<a name="line.202"></a> |
| <FONT color="green">203</FONT> <a name="line.203"></a> |
| <FONT color="green">204</FONT> if (clazz == null) {<a name="line.204"></a> |
| <FONT color="green">205</FONT> //check to see if 'token' was a FQCN itself:<a name="line.205"></a> |
| <FONT color="green">206</FONT> clazz = lookupHashFormatClass(token);<a name="line.206"></a> |
| <FONT color="green">207</FONT> }<a name="line.207"></a> |
| <FONT color="green">208</FONT> <a name="line.208"></a> |
| <FONT color="green">209</FONT> if (clazz == null) {<a name="line.209"></a> |
| <FONT color="green">210</FONT> //token wasn't a FQCN or a FQCN alias - try searching in configured packages:<a name="line.210"></a> |
| <FONT color="green">211</FONT> if (this.searchPackages != null) {<a name="line.211"></a> |
| <FONT color="green">212</FONT> for (String packageName : this.searchPackages) {<a name="line.212"></a> |
| <FONT color="green">213</FONT> clazz = getHashFormatClass(packageName, token);<a name="line.213"></a> |
| <FONT color="green">214</FONT> if (clazz != null) {<a name="line.214"></a> |
| <FONT color="green">215</FONT> //found it:<a name="line.215"></a> |
| <FONT color="green">216</FONT> break;<a name="line.216"></a> |
| <FONT color="green">217</FONT> }<a name="line.217"></a> |
| <FONT color="green">218</FONT> }<a name="line.218"></a> |
| <FONT color="green">219</FONT> }<a name="line.219"></a> |
| <FONT color="green">220</FONT> }<a name="line.220"></a> |
| <FONT color="green">221</FONT> <a name="line.221"></a> |
| <FONT color="green">222</FONT> if (clazz != null) {<a name="line.222"></a> |
| <FONT color="green">223</FONT> assertHashFormatImpl(clazz);<a name="line.223"></a> |
| <FONT color="green">224</FONT> }<a name="line.224"></a> |
| <FONT color="green">225</FONT> <a name="line.225"></a> |
| <FONT color="green">226</FONT> return clazz;<a name="line.226"></a> |
| <FONT color="green">227</FONT> }<a name="line.227"></a> |
| <FONT color="green">228</FONT> <a name="line.228"></a> |
| <FONT color="green">229</FONT> /**<a name="line.229"></a> |
| <FONT color="green">230</FONT> * Heuristically determine the fully qualified {@code HashFormat} implementation class name in the specified<a name="line.230"></a> |
| <FONT color="green">231</FONT> * package based on the provided token.<a name="line.231"></a> |
| <FONT color="green">232</FONT> * <p/><a name="line.232"></a> |
| <FONT color="green">233</FONT> * The token is expected to be a relevant fragment of an unqualified class name in the specified package.<a name="line.233"></a> |
| <FONT color="green">234</FONT> * A 'relevant fragment' can be one of the following:<a name="line.234"></a> |
| <FONT color="green">235</FONT> * <ul><a name="line.235"></a> |
| <FONT color="green">236</FONT> * <li>The {@code HashFormat} implementation unqualified class name</li><a name="line.236"></a> |
| <FONT color="green">237</FONT> * <li>The prefix of an unqualified class name ending with the text {@code Format}. The first character of<a name="line.237"></a> |
| <FONT color="green">238</FONT> * this prefix can be upper or lower case and both options will be tried.</li><a name="line.238"></a> |
| <FONT color="green">239</FONT> * <li>The prefix of an unqualified class name ending with the text {@code HashFormat}. The first character of<a name="line.239"></a> |
| <FONT color="green">240</FONT> * this prefix can be upper or lower case and both options will be tried.</li><a name="line.240"></a> |
| <FONT color="green">241</FONT> * <li>The prefix of an unqualified class name ending with the text {@code CryptoFormat}. The first character<a name="line.241"></a> |
| <FONT color="green">242</FONT> * of this prefix can be upper or lower case and both options will be tried.</li><a name="line.242"></a> |
| <FONT color="green">243</FONT> * </ul><a name="line.243"></a> |
| <FONT color="green">244</FONT> * <p/><a name="line.244"></a> |
| <FONT color="green">245</FONT> * Some examples:<a name="line.245"></a> |
| <FONT color="green">246</FONT> * <table><a name="line.246"></a> |
| <FONT color="green">247</FONT> * <tr><a name="line.247"></a> |
| <FONT color="green">248</FONT> * <th>Package Name</th><a name="line.248"></a> |
| <FONT color="green">249</FONT> * <th>Token</th><a name="line.249"></a> |
| <FONT color="green">250</FONT> * <th>Expected Output Class</th><a name="line.250"></a> |
| <FONT color="green">251</FONT> * <th>Notes</th><a name="line.251"></a> |
| <FONT color="green">252</FONT> * </tr><a name="line.252"></a> |
| <FONT color="green">253</FONT> * <tr><a name="line.253"></a> |
| <FONT color="green">254</FONT> * <td>{@code com.foo.whatever}</td><a name="line.254"></a> |
| <FONT color="green">255</FONT> * <td>{@code MyBarFormat}</td><a name="line.255"></a> |
| <FONT color="green">256</FONT> * <td>{@code com.foo.whatever.MyBarFormat}</td><a name="line.256"></a> |
| <FONT color="green">257</FONT> * <td>Token is a complete unqualified class name</td><a name="line.257"></a> |
| <FONT color="green">258</FONT> * </tr><a name="line.258"></a> |
| <FONT color="green">259</FONT> * <tr><a name="line.259"></a> |
| <FONT color="green">260</FONT> * <td>{@code com.foo.whatever}</td><a name="line.260"></a> |
| <FONT color="green">261</FONT> * <td>{@code Bar}</td><a name="line.261"></a> |
| <FONT color="green">262</FONT> * <td>{@code com.foo.whatever.BarFormat} <em>or</em> {@code com.foo.whatever.BarHashFormat} <em>or</em><a name="line.262"></a> |
| <FONT color="green">263</FONT> * {@code com.foo.whatever.BarCryptFormat}</td><a name="line.263"></a> |
| <FONT color="green">264</FONT> * <td>The token is only part of the unqualified class name - i.e. all characters in front of the {@code *Format}<a name="line.264"></a> |
| <FONT color="green">265</FONT> * {@code *HashFormat} or {@code *CryptFormat} suffix. Note that the {@code *Format} variant will be tried before<a name="line.265"></a> |
| <FONT color="green">266</FONT> * {@code *HashFormat} and then finally {@code *CryptFormat}</td><a name="line.266"></a> |
| <FONT color="green">267</FONT> * </tr><a name="line.267"></a> |
| <FONT color="green">268</FONT> * <tr><a name="line.268"></a> |
| <FONT color="green">269</FONT> * <td>{@code com.foo.whatever}</td><a name="line.269"></a> |
| <FONT color="green">270</FONT> * <td>{@code bar}</td><a name="line.270"></a> |
| <FONT color="green">271</FONT> * <td>{@code com.foo.whatever.BarFormat} <em>or</em> {@code com.foo.whatever.BarHashFormat} <em>or</em><a name="line.271"></a> |
| <FONT color="green">272</FONT> * {@code com.foo.whatever.BarCryptFormat}</td><a name="line.272"></a> |
| <FONT color="green">273</FONT> * <td>Exact same output as the above {@code Bar} input example. (The token differs only by the first character)</td><a name="line.273"></a> |
| <FONT color="green">274</FONT> * </tr><a name="line.274"></a> |
| <FONT color="green">275</FONT> * </table><a name="line.275"></a> |
| <FONT color="green">276</FONT> *<a name="line.276"></a> |
| <FONT color="green">277</FONT> * @param packageName the package to search for matching {@code HashFormat} implementations.<a name="line.277"></a> |
| <FONT color="green">278</FONT> * @param token the string token from which a class name will be heuristically determined.<a name="line.278"></a> |
| <FONT color="green">279</FONT> * @return the discovered HashFormat class implementation or {@code null} if no class could be heuristically determined.<a name="line.279"></a> |
| <FONT color="green">280</FONT> */<a name="line.280"></a> |
| <FONT color="green">281</FONT> protected Class getHashFormatClass(String packageName, String token) {<a name="line.281"></a> |
| <FONT color="green">282</FONT> String test = token;<a name="line.282"></a> |
| <FONT color="green">283</FONT> Class clazz = null;<a name="line.283"></a> |
| <FONT color="green">284</FONT> String pkg = packageName == null ? "" : packageName;<a name="line.284"></a> |
| <FONT color="green">285</FONT> <a name="line.285"></a> |
| <FONT color="green">286</FONT> //1. Assume the arg is a fully qualified class name in the classpath:<a name="line.286"></a> |
| <FONT color="green">287</FONT> clazz = lookupHashFormatClass(test);<a name="line.287"></a> |
| <FONT color="green">288</FONT> <a name="line.288"></a> |
| <FONT color="green">289</FONT> if (clazz == null) {<a name="line.289"></a> |
| <FONT color="green">290</FONT> test = pkg + "." + token;<a name="line.290"></a> |
| <FONT color="green">291</FONT> clazz = lookupHashFormatClass(test);<a name="line.291"></a> |
| <FONT color="green">292</FONT> }<a name="line.292"></a> |
| <FONT color="green">293</FONT> <a name="line.293"></a> |
| <FONT color="green">294</FONT> if (clazz == null) {<a name="line.294"></a> |
| <FONT color="green">295</FONT> test = pkg + "." + StringUtils.uppercaseFirstChar(token) + "Format";<a name="line.295"></a> |
| <FONT color="green">296</FONT> clazz = lookupHashFormatClass(test);<a name="line.296"></a> |
| <FONT color="green">297</FONT> }<a name="line.297"></a> |
| <FONT color="green">298</FONT> <a name="line.298"></a> |
| <FONT color="green">299</FONT> if (clazz == null) {<a name="line.299"></a> |
| <FONT color="green">300</FONT> test = pkg + "." + token + "Format";<a name="line.300"></a> |
| <FONT color="green">301</FONT> clazz = lookupHashFormatClass(test);<a name="line.301"></a> |
| <FONT color="green">302</FONT> }<a name="line.302"></a> |
| <FONT color="green">303</FONT> <a name="line.303"></a> |
| <FONT color="green">304</FONT> if (clazz == null) {<a name="line.304"></a> |
| <FONT color="green">305</FONT> test = pkg + "." + StringUtils.uppercaseFirstChar(token) + "HashFormat";<a name="line.305"></a> |
| <FONT color="green">306</FONT> clazz = lookupHashFormatClass(test);<a name="line.306"></a> |
| <FONT color="green">307</FONT> }<a name="line.307"></a> |
| <FONT color="green">308</FONT> <a name="line.308"></a> |
| <FONT color="green">309</FONT> if (clazz == null) {<a name="line.309"></a> |
| <FONT color="green">310</FONT> test = pkg + "." + token + "HashFormat";<a name="line.310"></a> |
| <FONT color="green">311</FONT> clazz = lookupHashFormatClass(test);<a name="line.311"></a> |
| <FONT color="green">312</FONT> }<a name="line.312"></a> |
| <FONT color="green">313</FONT> <a name="line.313"></a> |
| <FONT color="green">314</FONT> if (clazz == null) {<a name="line.314"></a> |
| <FONT color="green">315</FONT> test = pkg + "." + StringUtils.uppercaseFirstChar(token) + "CryptFormat";<a name="line.315"></a> |
| <FONT color="green">316</FONT> clazz = lookupHashFormatClass(test);<a name="line.316"></a> |
| <FONT color="green">317</FONT> }<a name="line.317"></a> |
| <FONT color="green">318</FONT> <a name="line.318"></a> |
| <FONT color="green">319</FONT> if (clazz == null) {<a name="line.319"></a> |
| <FONT color="green">320</FONT> test = pkg + "." + token + "CryptFormat";<a name="line.320"></a> |
| <FONT color="green">321</FONT> clazz = lookupHashFormatClass(test);<a name="line.321"></a> |
| <FONT color="green">322</FONT> }<a name="line.322"></a> |
| <FONT color="green">323</FONT> <a name="line.323"></a> |
| <FONT color="green">324</FONT> if (clazz == null) {<a name="line.324"></a> |
| <FONT color="green">325</FONT> return null; //ran out of options<a name="line.325"></a> |
| <FONT color="green">326</FONT> }<a name="line.326"></a> |
| <FONT color="green">327</FONT> <a name="line.327"></a> |
| <FONT color="green">328</FONT> assertHashFormatImpl(clazz);<a name="line.328"></a> |
| <FONT color="green">329</FONT> <a name="line.329"></a> |
| <FONT color="green">330</FONT> return clazz;<a name="line.330"></a> |
| <FONT color="green">331</FONT> }<a name="line.331"></a> |
| <FONT color="green">332</FONT> <a name="line.332"></a> |
| <FONT color="green">333</FONT> protected Class lookupHashFormatClass(String name) {<a name="line.333"></a> |
| <FONT color="green">334</FONT> try {<a name="line.334"></a> |
| <FONT color="green">335</FONT> return ClassUtils.forName(name);<a name="line.335"></a> |
| <FONT color="green">336</FONT> } catch (UnknownClassException ignored) {<a name="line.336"></a> |
| <FONT color="green">337</FONT> }<a name="line.337"></a> |
| <FONT color="green">338</FONT> <a name="line.338"></a> |
| <FONT color="green">339</FONT> return null;<a name="line.339"></a> |
| <FONT color="green">340</FONT> }<a name="line.340"></a> |
| <FONT color="green">341</FONT> <a name="line.341"></a> |
| <FONT color="green">342</FONT> protected final void assertHashFormatImpl(Class clazz) {<a name="line.342"></a> |
| <FONT color="green">343</FONT> if (!HashFormat.class.isAssignableFrom(clazz) || clazz.isInterface()) {<a name="line.343"></a> |
| <FONT color="green">344</FONT> throw new IllegalArgumentException("Discovered class [" + clazz.getName() + "] is not a " +<a name="line.344"></a> |
| <FONT color="green">345</FONT> HashFormat.class.getName() + " implementation.");<a name="line.345"></a> |
| <FONT color="green">346</FONT> }<a name="line.346"></a> |
| <FONT color="green">347</FONT> <a name="line.347"></a> |
| <FONT color="green">348</FONT> }<a name="line.348"></a> |
| <FONT color="green">349</FONT> <a name="line.349"></a> |
| <FONT color="green">350</FONT> protected final HashFormat newHashFormatInstance(Class clazz) {<a name="line.350"></a> |
| <FONT color="green">351</FONT> assertHashFormatImpl(clazz);<a name="line.351"></a> |
| <FONT color="green">352</FONT> return (HashFormat) ClassUtils.newInstance(clazz);<a name="line.352"></a> |
| <FONT color="green">353</FONT> }<a name="line.353"></a> |
| <FONT color="green">354</FONT> }<a name="line.354"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </PRE> |
| </BODY> |
| </HTML> |
