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