Google Git
Sign in
apache / shiro-site / 01016f43374d9b054f3ea1e568b015d5d69428f9 / . / src / site / assets / static / 1.4.0-RC2 / xref / org / apache / shiro / realm / jdbc / JdbcRealm.html
blob: ca6173c667799c40a4bc382f7ff3e0096dffe723 [file] [log] [blame]
<!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=UTF-8" />
<title>JdbcRealm xref</title>
<link type="text/css" rel="stylesheet" href="../../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../../apidocs/org/apache/shiro/realm/jdbc/JdbcRealm.html">View Javadoc</a></div><pre>
<a class="jxr_linenumber" name="L1" href="#L1">1</a> <em class="jxr_comment">/*</em>
<a class="jxr_linenumber" name="L2" href="#L2">2</a> <em class="jxr_comment"> * Licensed to the Apache Software Foundation (ASF) under one</em>
<a class="jxr_linenumber" name="L3" href="#L3">3</a> <em class="jxr_comment"> * or more contributor license agreements. See the NOTICE file</em>
<a class="jxr_linenumber" name="L4" href="#L4">4</a> <em class="jxr_comment"> * distributed with this work for additional information</em>
<a class="jxr_linenumber" name="L5" href="#L5">5</a> <em class="jxr_comment"> * regarding copyright ownership. The ASF licenses this file</em>
<a class="jxr_linenumber" name="L6" href="#L6">6</a> <em class="jxr_comment"> * to you under the Apache License, Version 2.0 (the</em>
<a class="jxr_linenumber" name="L7" href="#L7">7</a> <em class="jxr_comment"> * "License"); you may not use this file except in compliance</em>
<a class="jxr_linenumber" name="L8" href="#L8">8</a> <em class="jxr_comment"> * with the License. You may obtain a copy of the License at</em>
<a class="jxr_linenumber" name="L9" href="#L9">9</a> <em class="jxr_comment"> *</em>
<a class="jxr_linenumber" name="L10" href="#L10">10</a> <em class="jxr_comment"> * <a href="http://www.apache.org/licenses/LICENSE-2." target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.</a>0</em>
<a class="jxr_linenumber" name="L11" href="#L11">11</a> <em class="jxr_comment"> *</em>
<a class="jxr_linenumber" name="L12" href="#L12">12</a> <em class="jxr_comment"> * Unless required by applicable law or agreed to in writing,</em>
<a class="jxr_linenumber" name="L13" href="#L13">13</a> <em class="jxr_comment"> * software distributed under the License is distributed on an</em>
<a class="jxr_linenumber" name="L14" href="#L14">14</a> <em class="jxr_comment"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</em>
<a class="jxr_linenumber" name="L15" href="#L15">15</a> <em class="jxr_comment"> * KIND, either express or implied. See the License for the</em>
<a class="jxr_linenumber" name="L16" href="#L16">16</a> <em class="jxr_comment"> * specific language governing permissions and limitations</em>
<a class="jxr_linenumber" name="L17" href="#L17">17</a> <em class="jxr_comment"> * under the License.</em>
<a class="jxr_linenumber" name="L18" href="#L18">18</a> <em class="jxr_comment"> */</em>
<a class="jxr_linenumber" name="L19" href="#L19">19</a> <strong class="jxr_keyword">package</strong> org.apache.shiro.realm.jdbc;
<a class="jxr_linenumber" name="L20" href="#L20">20</a>
<a class="jxr_linenumber" name="L21" href="#L21">21</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.authc.AccountException;
<a class="jxr_linenumber" name="L22" href="#L22">22</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.authc.AuthenticationException;
<a class="jxr_linenumber" name="L23" href="#L23">23</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.authc.AuthenticationInfo;
<a class="jxr_linenumber" name="L24" href="#L24">24</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.authc.AuthenticationToken;
<a class="jxr_linenumber" name="L25" href="#L25">25</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.authc.SimpleAuthenticationInfo;
<a class="jxr_linenumber" name="L26" href="#L26">26</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.authc.UnknownAccountException;
<a class="jxr_linenumber" name="L27" href="#L27">27</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.authc.UsernamePasswordToken;
<a class="jxr_linenumber" name="L28" href="#L28">28</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.authz.AuthorizationException;
<a class="jxr_linenumber" name="L29" href="#L29">29</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.authz.AuthorizationInfo;
<a class="jxr_linenumber" name="L30" href="#L30">30</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.authz.SimpleAuthorizationInfo;
<a class="jxr_linenumber" name="L31" href="#L31">31</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.config.ConfigurationException;
<a class="jxr_linenumber" name="L32" href="#L32">32</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.realm.AuthorizingRealm;
<a class="jxr_linenumber" name="L33" href="#L33">33</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.subject.PrincipalCollection;
<a class="jxr_linenumber" name="L34" href="#L34">34</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.util.ByteSource;
<a class="jxr_linenumber" name="L35" href="#L35">35</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.util.JdbcUtils;
<a class="jxr_linenumber" name="L36" href="#L36">36</a> <strong class="jxr_keyword">import</strong> org.slf4j.Logger;
<a class="jxr_linenumber" name="L37" href="#L37">37</a> <strong class="jxr_keyword">import</strong> org.slf4j.LoggerFactory;
<a class="jxr_linenumber" name="L38" href="#L38">38</a>
<a class="jxr_linenumber" name="L39" href="#L39">39</a> <strong class="jxr_keyword">import</strong> javax.sql.DataSource;
<a class="jxr_linenumber" name="L40" href="#L40">40</a> <strong class="jxr_keyword">import</strong> java.sql.Connection;
<a class="jxr_linenumber" name="L41" href="#L41">41</a> <strong class="jxr_keyword">import</strong> java.sql.PreparedStatement;
<a class="jxr_linenumber" name="L42" href="#L42">42</a> <strong class="jxr_keyword">import</strong> java.sql.ResultSet;
<a class="jxr_linenumber" name="L43" href="#L43">43</a> <strong class="jxr_keyword">import</strong> java.sql.SQLException;
<a class="jxr_linenumber" name="L44" href="#L44">44</a> <strong class="jxr_keyword">import</strong> java.util.Collection;
<a class="jxr_linenumber" name="L45" href="#L45">45</a> <strong class="jxr_keyword">import</strong> java.util.LinkedHashSet;
<a class="jxr_linenumber" name="L46" href="#L46">46</a> <strong class="jxr_keyword">import</strong> java.util.Set;
<a class="jxr_linenumber" name="L47" href="#L47">47</a>
<a class="jxr_linenumber" name="L48" href="#L48">48</a>
<a class="jxr_linenumber" name="L49" href="#L49">49</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L50" href="#L50">50</a> <em class="jxr_javadoccomment"> * Realm that allows authentication and authorization via JDBC calls. The default queries suggest a potential schema</em>
<a class="jxr_linenumber" name="L51" href="#L51">51</a> <em class="jxr_javadoccomment"> * for retrieving the user's password for authentication, and querying for a user's roles and permissions. The</em>
<a class="jxr_linenumber" name="L52" href="#L52">52</a> <em class="jxr_javadoccomment"> * default queries can be overridden by setting the query properties of the realm.</em>
<a class="jxr_linenumber" name="L53" href="#L53">53</a> <em class="jxr_javadoccomment"> * &lt;p/&gt;</em>
<a class="jxr_linenumber" name="L54" href="#L54">54</a> <em class="jxr_javadoccomment"> * If the default implementation</em>
<a class="jxr_linenumber" name="L55" href="#L55">55</a> <em class="jxr_javadoccomment"> * of authentication and authorization cannot handle your schema, this class can be subclassed and the</em>
<a class="jxr_linenumber" name="L56" href="#L56">56</a> <em class="jxr_javadoccomment"> * appropriate methods overridden. (usually {@link #doGetAuthenticationInfo(org.apache.shiro.authc.AuthenticationToken)},</em>
<a class="jxr_linenumber" name="L57" href="#L57">57</a> <em class="jxr_javadoccomment"> * {@link #getRoleNamesForUser(java.sql.Connection,String)}, and/or {@link #getPermissions(java.sql.Connection,String,java.util.Collection)}</em>
<a class="jxr_linenumber" name="L58" href="#L58">58</a> <em class="jxr_javadoccomment"> * &lt;p/&gt;</em>
<a class="jxr_linenumber" name="L59" href="#L59">59</a> <em class="jxr_javadoccomment"> * This realm supports caching by extending from {@link org.apache.shiro.realm.AuthorizingRealm}.</em>
<a class="jxr_linenumber" name="L60" href="#L60">60</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L61" href="#L61">61</a> <em class="jxr_javadoccomment"> * @since 0.2</em>
<a class="jxr_linenumber" name="L62" href="#L62">62</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L63" href="#L63">63</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../org/apache/shiro/realm/jdbc/JdbcRealm.html">JdbcRealm</a> <strong class="jxr_keyword">extends</strong> <a href="../../../../../org/apache/shiro/realm/AuthorizingRealm.html">AuthorizingRealm</a> {
<a class="jxr_linenumber" name="L64" href="#L64">64</a>
<a class="jxr_linenumber" name="L65" href="#L65">65</a> <em class="jxr_comment">//TODO - complete JavaDoc</em>
<a class="jxr_linenumber" name="L66" href="#L66">66</a>
<a class="jxr_linenumber" name="L67" href="#L67">67</a> <em class="jxr_comment">/*--------------------------------------------</em>
<a class="jxr_linenumber" name="L68" href="#L68">68</a> <em class="jxr_comment"> | C O N S T A N T S |</em>
<a class="jxr_linenumber" name="L69" href="#L69">69</a> <em class="jxr_comment"> ============================================*/</em>
<a class="jxr_linenumber" name="L70" href="#L70">70</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L71" href="#L71">71</a> <em class="jxr_javadoccomment"> * The default query used to retrieve account data for the user.</em>
<a class="jxr_linenumber" name="L72" href="#L72">72</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L73" href="#L73">73</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String DEFAULT_AUTHENTICATION_QUERY = <span class="jxr_string">"select password from users where username = ?"</span>;
<a class="jxr_linenumber" name="L74" href="#L74">74</a>
<a class="jxr_linenumber" name="L75" href="#L75">75</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L76" href="#L76">76</a> <em class="jxr_javadoccomment"> * The default query used to retrieve account data for the user when {@link #saltStyle} is COLUMN.</em>
<a class="jxr_linenumber" name="L77" href="#L77">77</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L78" href="#L78">78</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String DEFAULT_SALTED_AUTHENTICATION_QUERY = <span class="jxr_string">"select password, password_salt from users where username = ?"</span>;
<a class="jxr_linenumber" name="L79" href="#L79">79</a>
<a class="jxr_linenumber" name="L80" href="#L80">80</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L81" href="#L81">81</a> <em class="jxr_javadoccomment"> * The default query used to retrieve the roles that apply to a user.</em>
<a class="jxr_linenumber" name="L82" href="#L82">82</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L83" href="#L83">83</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String DEFAULT_USER_ROLES_QUERY = <span class="jxr_string">"select role_name from user_roles where username = ?"</span>;
<a class="jxr_linenumber" name="L84" href="#L84">84</a>
<a class="jxr_linenumber" name="L85" href="#L85">85</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L86" href="#L86">86</a> <em class="jxr_javadoccomment"> * The default query used to retrieve permissions that apply to a particular role.</em>
<a class="jxr_linenumber" name="L87" href="#L87">87</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L88" href="#L88">88</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String DEFAULT_PERMISSIONS_QUERY = <span class="jxr_string">"select permission from roles_permissions where role_name = ?"</span>;
<a class="jxr_linenumber" name="L89" href="#L89">89</a>
<a class="jxr_linenumber" name="L90" href="#L90">90</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> Logger log = LoggerFactory.getLogger(JdbcRealm.<strong class="jxr_keyword">class</strong>);
<a class="jxr_linenumber" name="L91" href="#L91">91</a>
<a class="jxr_linenumber" name="L92" href="#L92">92</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L93" href="#L93">93</a> <em class="jxr_javadoccomment"> * Password hash salt configuration. &lt;ul&gt;</em>
<a class="jxr_linenumber" name="L94" href="#L94">94</a> <em class="jxr_javadoccomment"> * &lt;li&gt;NO_SALT - password hashes are not salted.&lt;/li&gt;</em>
<a class="jxr_linenumber" name="L95" href="#L95">95</a> <em class="jxr_javadoccomment"> * &lt;li&gt;CRYPT - password hashes are stored in unix crypt format.&lt;/li&gt;</em>
<a class="jxr_linenumber" name="L96" href="#L96">96</a> <em class="jxr_javadoccomment"> * &lt;li&gt;COLUMN - salt is in a separate column in the database.&lt;/li&gt; </em>
<a class="jxr_linenumber" name="L97" href="#L97">97</a> <em class="jxr_javadoccomment"> * &lt;li&gt;EXTERNAL - salt is not stored in the database. {@link #getSaltForUser(String)} will be called</em>
<a class="jxr_linenumber" name="L98" href="#L98">98</a> <em class="jxr_javadoccomment"> * to get the salt&lt;/li&gt;&lt;/ul&gt;</em>
<a class="jxr_linenumber" name="L99" href="#L99">99</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L100" href="#L100">100</a> <strong class="jxr_keyword">public</strong> enum <a href="../../../../../org/apache/shiro/realm/jdbc/JdbcRealm.html">SaltStyle</a> {NO_SALT, CRYPT, COLUMN, EXTERNAL};
<a class="jxr_linenumber" name="L101" href="#L101">101</a>
<a class="jxr_linenumber" name="L102" href="#L102">102</a> <em class="jxr_comment">/*--------------------------------------------</em>
<a class="jxr_linenumber" name="L103" href="#L103">103</a> <em class="jxr_comment"> | I N S T A N C E V A R I A B L E S |</em>
<a class="jxr_linenumber" name="L104" href="#L104">104</a> <em class="jxr_comment"> ============================================*/</em>
<a class="jxr_linenumber" name="L105" href="#L105">105</a> <strong class="jxr_keyword">protected</strong> DataSource dataSource;
<a class="jxr_linenumber" name="L106" href="#L106">106</a>
<a class="jxr_linenumber" name="L107" href="#L107">107</a> <strong class="jxr_keyword">protected</strong> String authenticationQuery = DEFAULT_AUTHENTICATION_QUERY;
<a class="jxr_linenumber" name="L108" href="#L108">108</a>
<a class="jxr_linenumber" name="L109" href="#L109">109</a> <strong class="jxr_keyword">protected</strong> String userRolesQuery = DEFAULT_USER_ROLES_QUERY;
<a class="jxr_linenumber" name="L110" href="#L110">110</a>
<a class="jxr_linenumber" name="L111" href="#L111">111</a> <strong class="jxr_keyword">protected</strong> String permissionsQuery = DEFAULT_PERMISSIONS_QUERY;
<a class="jxr_linenumber" name="L112" href="#L112">112</a>
<a class="jxr_linenumber" name="L113" href="#L113">113</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">boolean</strong> permissionsLookupEnabled = false;
<a class="jxr_linenumber" name="L114" href="#L114">114</a>
<a class="jxr_linenumber" name="L115" href="#L115">115</a> <strong class="jxr_keyword">protected</strong> <a href="../../../../../org/apache/shiro/realm/jdbc/JdbcRealm.html">SaltStyle</a> saltStyle = SaltStyle.NO_SALT;
<a class="jxr_linenumber" name="L116" href="#L116">116</a>
<a class="jxr_linenumber" name="L117" href="#L117">117</a> <em class="jxr_comment">/*--------------------------------------------</em>
<a class="jxr_linenumber" name="L118" href="#L118">118</a> <em class="jxr_comment"> | C O N S T R U C T O R S |</em>
<a class="jxr_linenumber" name="L119" href="#L119">119</a> <em class="jxr_comment"> ============================================*/</em>
<a class="jxr_linenumber" name="L120" href="#L120">120</a>
<a class="jxr_linenumber" name="L121" href="#L121">121</a> <em class="jxr_comment">/*--------------------------------------------</em>
<a class="jxr_linenumber" name="L122" href="#L122">122</a> <em class="jxr_comment"> | A C C E S S O R S / M O D I F I E R S |</em>
<a class="jxr_linenumber" name="L123" href="#L123">123</a> <em class="jxr_comment"> ============================================*/</em>
<a class="jxr_linenumber" name="L124" href="#L124">124</a>
<a class="jxr_linenumber" name="L125" href="#L125">125</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L126" href="#L126">126</a> <em class="jxr_javadoccomment"> * Sets the datasource that should be used to retrieve connections used by this realm.</em>
<a class="jxr_linenumber" name="L127" href="#L127">127</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L128" href="#L128">128</a> <em class="jxr_javadoccomment"> * @param dataSource the SQL data source.</em>
<a class="jxr_linenumber" name="L129" href="#L129">129</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L130" href="#L130">130</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setDataSource(DataSource dataSource) {
<a class="jxr_linenumber" name="L131" href="#L131">131</a> <strong class="jxr_keyword">this</strong>.dataSource = dataSource;
<a class="jxr_linenumber" name="L132" href="#L132">132</a> }
<a class="jxr_linenumber" name="L133" href="#L133">133</a>
<a class="jxr_linenumber" name="L134" href="#L134">134</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L135" href="#L135">135</a> <em class="jxr_javadoccomment"> * Overrides the default query used to retrieve a user's password during authentication. When using the default</em>
<a class="jxr_linenumber" name="L136" href="#L136">136</a> <em class="jxr_javadoccomment"> * implementation, this query must take the user's username as a single parameter and return a single result</em>
<a class="jxr_linenumber" name="L137" href="#L137">137</a> <em class="jxr_javadoccomment"> * with the user's password as the first column. If you require a solution that does not match this query</em>
<a class="jxr_linenumber" name="L138" href="#L138">138</a> <em class="jxr_javadoccomment"> * structure, you can override {@link #doGetAuthenticationInfo(org.apache.shiro.authc.AuthenticationToken)} or</em>
<a class="jxr_linenumber" name="L139" href="#L139">139</a> <em class="jxr_javadoccomment"> * just {@link #getPasswordForUser(java.sql.Connection,String)}</em>
<a class="jxr_linenumber" name="L140" href="#L140">140</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L141" href="#L141">141</a> <em class="jxr_javadoccomment"> * @param authenticationQuery the query to use for authentication.</em>
<a class="jxr_linenumber" name="L142" href="#L142">142</a> <em class="jxr_javadoccomment"> * @see #DEFAULT_AUTHENTICATION_QUERY</em>
<a class="jxr_linenumber" name="L143" href="#L143">143</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L144" href="#L144">144</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setAuthenticationQuery(String authenticationQuery) {
<a class="jxr_linenumber" name="L145" href="#L145">145</a> <strong class="jxr_keyword">this</strong>.authenticationQuery = authenticationQuery;
<a class="jxr_linenumber" name="L146" href="#L146">146</a> }
<a class="jxr_linenumber" name="L147" href="#L147">147</a>
<a class="jxr_linenumber" name="L148" href="#L148">148</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L149" href="#L149">149</a> <em class="jxr_javadoccomment"> * Overrides the default query used to retrieve a user's roles during authorization. When using the default</em>
<a class="jxr_linenumber" name="L150" href="#L150">150</a> <em class="jxr_javadoccomment"> * implementation, this query must take the user's username as a single parameter and return a row</em>
<a class="jxr_linenumber" name="L151" href="#L151">151</a> <em class="jxr_javadoccomment"> * per role with a single column containing the role name. If you require a solution that does not match this query</em>
<a class="jxr_linenumber" name="L152" href="#L152">152</a> <em class="jxr_javadoccomment"> * structure, you can override {@link #doGetAuthorizationInfo(PrincipalCollection)} or just</em>
<a class="jxr_linenumber" name="L153" href="#L153">153</a> <em class="jxr_javadoccomment"> * {@link #getRoleNamesForUser(java.sql.Connection,String)}</em>
<a class="jxr_linenumber" name="L154" href="#L154">154</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L155" href="#L155">155</a> <em class="jxr_javadoccomment"> * @param userRolesQuery the query to use for retrieving a user's roles.</em>
<a class="jxr_linenumber" name="L156" href="#L156">156</a> <em class="jxr_javadoccomment"> * @see #DEFAULT_USER_ROLES_QUERY</em>
<a class="jxr_linenumber" name="L157" href="#L157">157</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L158" href="#L158">158</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setUserRolesQuery(String userRolesQuery) {
<a class="jxr_linenumber" name="L159" href="#L159">159</a> <strong class="jxr_keyword">this</strong>.userRolesQuery = userRolesQuery;
<a class="jxr_linenumber" name="L160" href="#L160">160</a> }
<a class="jxr_linenumber" name="L161" href="#L161">161</a>
<a class="jxr_linenumber" name="L162" href="#L162">162</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L163" href="#L163">163</a> <em class="jxr_javadoccomment"> * Overrides the default query used to retrieve a user's permissions during authorization. When using the default</em>
<a class="jxr_linenumber" name="L164" href="#L164">164</a> <em class="jxr_javadoccomment"> * implementation, this query must take a role name as the single parameter and return a row</em>
<a class="jxr_linenumber" name="L165" href="#L165">165</a> <em class="jxr_javadoccomment"> * per permission with three columns containing the fully qualified name of the permission class, the permission</em>
<a class="jxr_linenumber" name="L166" href="#L166">166</a> <em class="jxr_javadoccomment"> * name, and the permission actions (in that order). If you require a solution that does not match this query</em>
<a class="jxr_linenumber" name="L167" href="#L167">167</a> <em class="jxr_javadoccomment"> * structure, you can override {@link #doGetAuthorizationInfo(org.apache.shiro.subject.PrincipalCollection)} or just</em>
<a class="jxr_linenumber" name="L168" href="#L168">168</a> <em class="jxr_javadoccomment"> * {@link #getPermissions(java.sql.Connection,String,java.util.Collection)}&lt;/p&gt;</em>
<a class="jxr_linenumber" name="L169" href="#L169">169</a> <em class="jxr_javadoccomment"> * &lt;p/&gt;</em>
<a class="jxr_linenumber" name="L170" href="#L170">170</a> <em class="jxr_javadoccomment"> * &lt;b&gt;Permissions are only retrieved if you set {@link #permissionsLookupEnabled} to true. Otherwise,</em>
<a class="jxr_linenumber" name="L171" href="#L171">171</a> <em class="jxr_javadoccomment"> * this query is ignored.&lt;/b&gt;</em>
<a class="jxr_linenumber" name="L172" href="#L172">172</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L173" href="#L173">173</a> <em class="jxr_javadoccomment"> * @param permissionsQuery the query to use for retrieving permissions for a role.</em>
<a class="jxr_linenumber" name="L174" href="#L174">174</a> <em class="jxr_javadoccomment"> * @see #DEFAULT_PERMISSIONS_QUERY</em>
<a class="jxr_linenumber" name="L175" href="#L175">175</a> <em class="jxr_javadoccomment"> * @see #setPermissionsLookupEnabled(boolean)</em>
<a class="jxr_linenumber" name="L176" href="#L176">176</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L177" href="#L177">177</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setPermissionsQuery(String permissionsQuery) {
<a class="jxr_linenumber" name="L178" href="#L178">178</a> <strong class="jxr_keyword">this</strong>.permissionsQuery = permissionsQuery;
<a class="jxr_linenumber" name="L179" href="#L179">179</a> }
<a class="jxr_linenumber" name="L180" href="#L180">180</a>
<a class="jxr_linenumber" name="L181" href="#L181">181</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L182" href="#L182">182</a> <em class="jxr_javadoccomment"> * Enables lookup of permissions during authorization. The default is "false" - meaning that only roles</em>
<a class="jxr_linenumber" name="L183" href="#L183">183</a> <em class="jxr_javadoccomment"> * are associated with a user. Set this to true in order to lookup roles &lt;b&gt;and&lt;/b&gt; permissions.</em>
<a class="jxr_linenumber" name="L184" href="#L184">184</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L185" href="#L185">185</a> <em class="jxr_javadoccomment"> * @param permissionsLookupEnabled true if permissions should be looked up during authorization, or false if only</em>
<a class="jxr_linenumber" name="L186" href="#L186">186</a> <em class="jxr_javadoccomment"> * roles should be looked up.</em>
<a class="jxr_linenumber" name="L187" href="#L187">187</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L188" href="#L188">188</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setPermissionsLookupEnabled(<strong class="jxr_keyword">boolean</strong> permissionsLookupEnabled) {
<a class="jxr_linenumber" name="L189" href="#L189">189</a> <strong class="jxr_keyword">this</strong>.permissionsLookupEnabled = permissionsLookupEnabled;
<a class="jxr_linenumber" name="L190" href="#L190">190</a> }
<a class="jxr_linenumber" name="L191" href="#L191">191</a>
<a class="jxr_linenumber" name="L192" href="#L192">192</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L193" href="#L193">193</a> <em class="jxr_javadoccomment"> * Sets the salt style. See {@link #saltStyle}.</em>
<a class="jxr_linenumber" name="L194" href="#L194">194</a> <em class="jxr_javadoccomment"> * </em>
<a class="jxr_linenumber" name="L195" href="#L195">195</a> <em class="jxr_javadoccomment"> * @param saltStyle new SaltStyle to set.</em>
<a class="jxr_linenumber" name="L196" href="#L196">196</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L197" href="#L197">197</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setSaltStyle(<a href="../../../../../org/apache/shiro/realm/jdbc/JdbcRealm.html">SaltStyle</a> saltStyle) {
<a class="jxr_linenumber" name="L198" href="#L198">198</a> <strong class="jxr_keyword">this</strong>.saltStyle = saltStyle;
<a class="jxr_linenumber" name="L199" href="#L199">199</a> <strong class="jxr_keyword">if</strong> (saltStyle == SaltStyle.COLUMN &amp;&amp; authenticationQuery.equals(DEFAULT_AUTHENTICATION_QUERY)) {
<a class="jxr_linenumber" name="L200" href="#L200">200</a> authenticationQuery = DEFAULT_SALTED_AUTHENTICATION_QUERY;
<a class="jxr_linenumber" name="L201" href="#L201">201</a> }
<a class="jxr_linenumber" name="L202" href="#L202">202</a> }
<a class="jxr_linenumber" name="L203" href="#L203">203</a>
<a class="jxr_linenumber" name="L204" href="#L204">204</a> <em class="jxr_comment">/*--------------------------------------------</em>
<a class="jxr_linenumber" name="L205" href="#L205">205</a> <em class="jxr_comment"> | M E T H O D S |</em>
<a class="jxr_linenumber" name="L206" href="#L206">206</a> <em class="jxr_comment"> ============================================*/</em>
<a class="jxr_linenumber" name="L207" href="#L207">207</a>
<a class="jxr_linenumber" name="L208" href="#L208">208</a> <strong class="jxr_keyword">protected</strong> <a href="../../../../../org/apache/shiro/authc/AuthenticationInfo.html">AuthenticationInfo</a> doGetAuthenticationInfo(<a href="../../../../../org/apache/shiro/authc/AuthenticationToken.html">AuthenticationToken</a> token) <strong class="jxr_keyword">throws</strong> AuthenticationException {
<a class="jxr_linenumber" name="L209" href="#L209">209</a>
<a class="jxr_linenumber" name="L210" href="#L210">210</a> <a href="../../../../../org/apache/shiro/authc/UsernamePasswordToken.html">UsernamePasswordToken</a> upToken = (UsernamePasswordToken) token;
<a class="jxr_linenumber" name="L211" href="#L211">211</a> String username = upToken.getUsername();
<a class="jxr_linenumber" name="L212" href="#L212">212</a>
<a class="jxr_linenumber" name="L213" href="#L213">213</a> <em class="jxr_comment">// Null username is invalid</em>
<a class="jxr_linenumber" name="L214" href="#L214">214</a> <strong class="jxr_keyword">if</strong> (username == <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L215" href="#L215">215</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../org/apache/shiro/authc/AccountException.html">AccountException</a>(<span class="jxr_string">"Null usernames are not allowed by this realm."</span>);
<a class="jxr_linenumber" name="L216" href="#L216">216</a> }
<a class="jxr_linenumber" name="L217" href="#L217">217</a>
<a class="jxr_linenumber" name="L218" href="#L218">218</a> Connection conn = <strong class="jxr_keyword">null</strong>;
<a class="jxr_linenumber" name="L219" href="#L219">219</a> <a href="../../../../../org/apache/shiro/authc/SimpleAuthenticationInfo.html">SimpleAuthenticationInfo</a> info = <strong class="jxr_keyword">null</strong>;
<a class="jxr_linenumber" name="L220" href="#L220">220</a> <strong class="jxr_keyword">try</strong> {
<a class="jxr_linenumber" name="L221" href="#L221">221</a> conn = dataSource.getConnection();
<a class="jxr_linenumber" name="L222" href="#L222">222</a>
<a class="jxr_linenumber" name="L223" href="#L223">223</a> String password = <strong class="jxr_keyword">null</strong>;
<a class="jxr_linenumber" name="L224" href="#L224">224</a> String salt = <strong class="jxr_keyword">null</strong>;
<a class="jxr_linenumber" name="L225" href="#L225">225</a> <strong class="jxr_keyword">switch</strong> (saltStyle) {
<a class="jxr_linenumber" name="L226" href="#L226">226</a> <strong class="jxr_keyword">case</strong> NO_SALT:
<a class="jxr_linenumber" name="L227" href="#L227">227</a> password = getPasswordForUser(conn, username)[0];
<a class="jxr_linenumber" name="L228" href="#L228">228</a> <strong class="jxr_keyword">break</strong>;
<a class="jxr_linenumber" name="L229" href="#L229">229</a> <strong class="jxr_keyword">case</strong> CRYPT:
<a class="jxr_linenumber" name="L230" href="#L230">230</a> <em class="jxr_comment">// TODO: separate password and hash from getPasswordForUser[0]</em>
<a class="jxr_linenumber" name="L231" href="#L231">231</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../org/apache/shiro/config/ConfigurationException.html">ConfigurationException</a>(<span class="jxr_string">"Not implemented yet"</span>);
<a class="jxr_linenumber" name="L232" href="#L232">232</a> <em class="jxr_comment">//break;</em>
<a class="jxr_linenumber" name="L233" href="#L233">233</a> <strong class="jxr_keyword">case</strong> COLUMN:
<a class="jxr_linenumber" name="L234" href="#L234">234</a> String[] queryResults = getPasswordForUser(conn, username);
<a class="jxr_linenumber" name="L235" href="#L235">235</a> password = queryResults[0];
<a class="jxr_linenumber" name="L236" href="#L236">236</a> salt = queryResults[1];
<a class="jxr_linenumber" name="L237" href="#L237">237</a> <strong class="jxr_keyword">break</strong>;
<a class="jxr_linenumber" name="L238" href="#L238">238</a> <strong class="jxr_keyword">case</strong> EXTERNAL:
<a class="jxr_linenumber" name="L239" href="#L239">239</a> password = getPasswordForUser(conn, username)[0];
<a class="jxr_linenumber" name="L240" href="#L240">240</a> salt = getSaltForUser(username);
<a class="jxr_linenumber" name="L241" href="#L241">241</a> }
<a class="jxr_linenumber" name="L242" href="#L242">242</a>
<a class="jxr_linenumber" name="L243" href="#L243">243</a> <strong class="jxr_keyword">if</strong> (password == <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L244" href="#L244">244</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../org/apache/shiro/authc/UnknownAccountException.html">UnknownAccountException</a>(<span class="jxr_string">"No account found for user ["</span> + username + <span class="jxr_string">"]"</span>);
<a class="jxr_linenumber" name="L245" href="#L245">245</a> }
<a class="jxr_linenumber" name="L246" href="#L246">246</a>
<a class="jxr_linenumber" name="L247" href="#L247">247</a> info = <strong class="jxr_keyword">new</strong> <a href="../../../../../org/apache/shiro/authc/SimpleAuthenticationInfo.html">SimpleAuthenticationInfo</a>(username, password.toCharArray(), getName());
<a class="jxr_linenumber" name="L248" href="#L248">248</a>
<a class="jxr_linenumber" name="L249" href="#L249">249</a> <strong class="jxr_keyword">if</strong> (salt != <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L250" href="#L250">250</a> info.setCredentialsSalt(ByteSource.Util.bytes(salt));
<a class="jxr_linenumber" name="L251" href="#L251">251</a> }
<a class="jxr_linenumber" name="L252" href="#L252">252</a>
<a class="jxr_linenumber" name="L253" href="#L253">253</a> } <strong class="jxr_keyword">catch</strong> (SQLException e) {
<a class="jxr_linenumber" name="L254" href="#L254">254</a> <strong class="jxr_keyword">final</strong> String message = <span class="jxr_string">"There was a SQL error while authenticating user ["</span> + username + <span class="jxr_string">"]"</span>;
<a class="jxr_linenumber" name="L255" href="#L255">255</a> <strong class="jxr_keyword">if</strong> (log.isErrorEnabled()) {
<a class="jxr_linenumber" name="L256" href="#L256">256</a> log.error(message, e);
<a class="jxr_linenumber" name="L257" href="#L257">257</a> }
<a class="jxr_linenumber" name="L258" href="#L258">258</a>
<a class="jxr_linenumber" name="L259" href="#L259">259</a> <em class="jxr_comment">// Rethrow any SQL errors as an authentication exception</em>
<a class="jxr_linenumber" name="L260" href="#L260">260</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../org/apache/shiro/authc/AuthenticationException.html">AuthenticationException</a>(message, e);
<a class="jxr_linenumber" name="L261" href="#L261">261</a> } <strong class="jxr_keyword">finally</strong> {
<a class="jxr_linenumber" name="L262" href="#L262">262</a> JdbcUtils.closeConnection(conn);
<a class="jxr_linenumber" name="L263" href="#L263">263</a> }
<a class="jxr_linenumber" name="L264" href="#L264">264</a>
<a class="jxr_linenumber" name="L265" href="#L265">265</a> <strong class="jxr_keyword">return</strong> info;
<a class="jxr_linenumber" name="L266" href="#L266">266</a> }
<a class="jxr_linenumber" name="L267" href="#L267">267</a>
<a class="jxr_linenumber" name="L268" href="#L268">268</a> <strong class="jxr_keyword">private</strong> String[] getPasswordForUser(Connection conn, String username) <strong class="jxr_keyword">throws</strong> SQLException {
<a class="jxr_linenumber" name="L269" href="#L269">269</a>
<a class="jxr_linenumber" name="L270" href="#L270">270</a> String[] result;
<a class="jxr_linenumber" name="L271" href="#L271">271</a> <strong class="jxr_keyword">boolean</strong> returningSeparatedSalt = false;
<a class="jxr_linenumber" name="L272" href="#L272">272</a> <strong class="jxr_keyword">switch</strong> (saltStyle) {
<a class="jxr_linenumber" name="L273" href="#L273">273</a> <strong class="jxr_keyword">case</strong> NO_SALT:
<a class="jxr_linenumber" name="L274" href="#L274">274</a> <strong class="jxr_keyword">case</strong> CRYPT:
<a class="jxr_linenumber" name="L275" href="#L275">275</a> <strong class="jxr_keyword">case</strong> EXTERNAL:
<a class="jxr_linenumber" name="L276" href="#L276">276</a> result = <strong class="jxr_keyword">new</strong> String[1];
<a class="jxr_linenumber" name="L277" href="#L277">277</a> <strong class="jxr_keyword">break</strong>;
<a class="jxr_linenumber" name="L278" href="#L278">278</a> <strong class="jxr_keyword">default</strong>:
<a class="jxr_linenumber" name="L279" href="#L279">279</a> result = <strong class="jxr_keyword">new</strong> String[2];
<a class="jxr_linenumber" name="L280" href="#L280">280</a> returningSeparatedSalt = <strong class="jxr_keyword">true</strong>;
<a class="jxr_linenumber" name="L281" href="#L281">281</a> }
<a class="jxr_linenumber" name="L282" href="#L282">282</a>
<a class="jxr_linenumber" name="L283" href="#L283">283</a> PreparedStatement ps = <strong class="jxr_keyword">null</strong>;
<a class="jxr_linenumber" name="L284" href="#L284">284</a> ResultSet rs = <strong class="jxr_keyword">null</strong>;
<a class="jxr_linenumber" name="L285" href="#L285">285</a> <strong class="jxr_keyword">try</strong> {
<a class="jxr_linenumber" name="L286" href="#L286">286</a> ps = conn.prepareStatement(authenticationQuery);
<a class="jxr_linenumber" name="L287" href="#L287">287</a> ps.setString(1, username);
<a class="jxr_linenumber" name="L288" href="#L288">288</a>
<a class="jxr_linenumber" name="L289" href="#L289">289</a> <em class="jxr_comment">// Execute query</em>
<a class="jxr_linenumber" name="L290" href="#L290">290</a> rs = ps.executeQuery();
<a class="jxr_linenumber" name="L291" href="#L291">291</a>
<a class="jxr_linenumber" name="L292" href="#L292">292</a> <em class="jxr_comment">// Loop over results - although we are only expecting one result, since usernames should be unique</em>
<a class="jxr_linenumber" name="L293" href="#L293">293</a> <strong class="jxr_keyword">boolean</strong> foundResult = false;
<a class="jxr_linenumber" name="L294" href="#L294">294</a> <strong class="jxr_keyword">while</strong> (rs.next()) {
<a class="jxr_linenumber" name="L295" href="#L295">295</a>
<a class="jxr_linenumber" name="L296" href="#L296">296</a> <em class="jxr_comment">// Check to ensure only one row is processed</em>
<a class="jxr_linenumber" name="L297" href="#L297">297</a> <strong class="jxr_keyword">if</strong> (foundResult) {
<a class="jxr_linenumber" name="L298" href="#L298">298</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../org/apache/shiro/authc/AuthenticationException.html">AuthenticationException</a>(<span class="jxr_string">"More than one user row found for user ["</span> + username + <span class="jxr_string">"]. Usernames must be unique."</span>);
<a class="jxr_linenumber" name="L299" href="#L299">299</a> }
<a class="jxr_linenumber" name="L300" href="#L300">300</a>
<a class="jxr_linenumber" name="L301" href="#L301">301</a> result[0] = rs.getString(1);
<a class="jxr_linenumber" name="L302" href="#L302">302</a> <strong class="jxr_keyword">if</strong> (returningSeparatedSalt) {
<a class="jxr_linenumber" name="L303" href="#L303">303</a> result[1] = rs.getString(2);
<a class="jxr_linenumber" name="L304" href="#L304">304</a> }
<a class="jxr_linenumber" name="L305" href="#L305">305</a>
<a class="jxr_linenumber" name="L306" href="#L306">306</a> foundResult = <strong class="jxr_keyword">true</strong>;
<a class="jxr_linenumber" name="L307" href="#L307">307</a> }
<a class="jxr_linenumber" name="L308" href="#L308">308</a> } <strong class="jxr_keyword">finally</strong> {
<a class="jxr_linenumber" name="L309" href="#L309">309</a> JdbcUtils.closeResultSet(rs);
<a class="jxr_linenumber" name="L310" href="#L310">310</a> JdbcUtils.closeStatement(ps);
<a class="jxr_linenumber" name="L311" href="#L311">311</a> }
<a class="jxr_linenumber" name="L312" href="#L312">312</a>
<a class="jxr_linenumber" name="L313" href="#L313">313</a> <strong class="jxr_keyword">return</strong> result;
<a class="jxr_linenumber" name="L314" href="#L314">314</a> }
<a class="jxr_linenumber" name="L315" href="#L315">315</a>
<a class="jxr_linenumber" name="L316" href="#L316">316</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L317" href="#L317">317</a> <em class="jxr_javadoccomment"> * This implementation of the interface expects the principals collection to return a String username keyed off of</em>
<a class="jxr_linenumber" name="L318" href="#L318">318</a> <em class="jxr_javadoccomment"> * this realm's {@link #getName() name}</em>
<a class="jxr_linenumber" name="L319" href="#L319">319</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L320" href="#L320">320</a> <em class="jxr_javadoccomment"> * @see #getAuthorizationInfo(org.apache.shiro.subject.PrincipalCollection)</em>
<a class="jxr_linenumber" name="L321" href="#L321">321</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L322" href="#L322">322</a> @Override
<a class="jxr_linenumber" name="L323" href="#L323">323</a> <strong class="jxr_keyword">protected</strong> <a href="../../../../../org/apache/shiro/authz/AuthorizationInfo.html">AuthorizationInfo</a> doGetAuthorizationInfo(<a href="../../../../../org/apache/shiro/subject/PrincipalCollection.html">PrincipalCollection</a> principals) {
<a class="jxr_linenumber" name="L324" href="#L324">324</a>
<a class="jxr_linenumber" name="L325" href="#L325">325</a> <em class="jxr_comment">//null usernames are invalid</em>
<a class="jxr_linenumber" name="L326" href="#L326">326</a> <strong class="jxr_keyword">if</strong> (principals == <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L327" href="#L327">327</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../org/apache/shiro/authz/AuthorizationException.html">AuthorizationException</a>(<span class="jxr_string">"PrincipalCollection method argument cannot be null."</span>);
<a class="jxr_linenumber" name="L328" href="#L328">328</a> }
<a class="jxr_linenumber" name="L329" href="#L329">329</a>
<a class="jxr_linenumber" name="L330" href="#L330">330</a> String username = (String) getAvailablePrincipal(principals);
<a class="jxr_linenumber" name="L331" href="#L331">331</a>
<a class="jxr_linenumber" name="L332" href="#L332">332</a> Connection conn = <strong class="jxr_keyword">null</strong>;
<a class="jxr_linenumber" name="L333" href="#L333">333</a> Set&lt;String&gt; roleNames = <strong class="jxr_keyword">null</strong>;
<a class="jxr_linenumber" name="L334" href="#L334">334</a> Set&lt;String&gt; permissions = <strong class="jxr_keyword">null</strong>;
<a class="jxr_linenumber" name="L335" href="#L335">335</a> <strong class="jxr_keyword">try</strong> {
<a class="jxr_linenumber" name="L336" href="#L336">336</a> conn = dataSource.getConnection();
<a class="jxr_linenumber" name="L337" href="#L337">337</a>
<a class="jxr_linenumber" name="L338" href="#L338">338</a> <em class="jxr_comment">// Retrieve roles and permissions from database</em>
<a class="jxr_linenumber" name="L339" href="#L339">339</a> roleNames = getRoleNamesForUser(conn, username);
<a class="jxr_linenumber" name="L340" href="#L340">340</a> <strong class="jxr_keyword">if</strong> (permissionsLookupEnabled) {
<a class="jxr_linenumber" name="L341" href="#L341">341</a> permissions = getPermissions(conn, username, roleNames);
<a class="jxr_linenumber" name="L342" href="#L342">342</a> }
<a class="jxr_linenumber" name="L343" href="#L343">343</a>
<a class="jxr_linenumber" name="L344" href="#L344">344</a> } <strong class="jxr_keyword">catch</strong> (SQLException e) {
<a class="jxr_linenumber" name="L345" href="#L345">345</a> <strong class="jxr_keyword">final</strong> String message = <span class="jxr_string">"There was a SQL error while authorizing user ["</span> + username + <span class="jxr_string">"]"</span>;
<a class="jxr_linenumber" name="L346" href="#L346">346</a> <strong class="jxr_keyword">if</strong> (log.isErrorEnabled()) {
<a class="jxr_linenumber" name="L347" href="#L347">347</a> log.error(message, e);
<a class="jxr_linenumber" name="L348" href="#L348">348</a> }
<a class="jxr_linenumber" name="L349" href="#L349">349</a>
<a class="jxr_linenumber" name="L350" href="#L350">350</a> <em class="jxr_comment">// Rethrow any SQL errors as an authorization exception</em>
<a class="jxr_linenumber" name="L351" href="#L351">351</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../org/apache/shiro/authz/AuthorizationException.html">AuthorizationException</a>(message, e);
<a class="jxr_linenumber" name="L352" href="#L352">352</a> } <strong class="jxr_keyword">finally</strong> {
<a class="jxr_linenumber" name="L353" href="#L353">353</a> JdbcUtils.closeConnection(conn);
<a class="jxr_linenumber" name="L354" href="#L354">354</a> }
<a class="jxr_linenumber" name="L355" href="#L355">355</a>
<a class="jxr_linenumber" name="L356" href="#L356">356</a> <a href="../../../../../org/apache/shiro/authz/SimpleAuthorizationInfo.html">SimpleAuthorizationInfo</a> info = <strong class="jxr_keyword">new</strong> <a href="../../../../../org/apache/shiro/authz/SimpleAuthorizationInfo.html">SimpleAuthorizationInfo</a>(roleNames);
<a class="jxr_linenumber" name="L357" href="#L357">357</a> info.setStringPermissions(permissions);
<a class="jxr_linenumber" name="L358" href="#L358">358</a> <strong class="jxr_keyword">return</strong> info;
<a class="jxr_linenumber" name="L359" href="#L359">359</a>
<a class="jxr_linenumber" name="L360" href="#L360">360</a> }
<a class="jxr_linenumber" name="L361" href="#L361">361</a>
<a class="jxr_linenumber" name="L362" href="#L362">362</a> <strong class="jxr_keyword">protected</strong> Set&lt;String&gt; getRoleNamesForUser(Connection conn, String username) <strong class="jxr_keyword">throws</strong> SQLException {
<a class="jxr_linenumber" name="L363" href="#L363">363</a> PreparedStatement ps = <strong class="jxr_keyword">null</strong>;
<a class="jxr_linenumber" name="L364" href="#L364">364</a> ResultSet rs = <strong class="jxr_keyword">null</strong>;
<a class="jxr_linenumber" name="L365" href="#L365">365</a> Set&lt;String&gt; roleNames = <strong class="jxr_keyword">new</strong> LinkedHashSet&lt;String&gt;();
<a class="jxr_linenumber" name="L366" href="#L366">366</a> <strong class="jxr_keyword">try</strong> {
<a class="jxr_linenumber" name="L367" href="#L367">367</a> ps = conn.prepareStatement(userRolesQuery);
<a class="jxr_linenumber" name="L368" href="#L368">368</a> ps.setString(1, username);
<a class="jxr_linenumber" name="L369" href="#L369">369</a>
<a class="jxr_linenumber" name="L370" href="#L370">370</a> <em class="jxr_comment">// Execute query</em>
<a class="jxr_linenumber" name="L371" href="#L371">371</a> rs = ps.executeQuery();
<a class="jxr_linenumber" name="L372" href="#L372">372</a>
<a class="jxr_linenumber" name="L373" href="#L373">373</a> <em class="jxr_comment">// Loop over results and add each returned role to a set</em>
<a class="jxr_linenumber" name="L374" href="#L374">374</a> <strong class="jxr_keyword">while</strong> (rs.next()) {
<a class="jxr_linenumber" name="L375" href="#L375">375</a>
<a class="jxr_linenumber" name="L376" href="#L376">376</a> String roleName = rs.getString(1);
<a class="jxr_linenumber" name="L377" href="#L377">377</a>
<a class="jxr_linenumber" name="L378" href="#L378">378</a> <em class="jxr_comment">// Add the role to the list of names if it isn't null</em>
<a class="jxr_linenumber" name="L379" href="#L379">379</a> <strong class="jxr_keyword">if</strong> (roleName != <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L380" href="#L380">380</a> roleNames.add(roleName);
<a class="jxr_linenumber" name="L381" href="#L381">381</a> } <strong class="jxr_keyword">else</strong> {
<a class="jxr_linenumber" name="L382" href="#L382">382</a> <strong class="jxr_keyword">if</strong> (log.isWarnEnabled()) {
<a class="jxr_linenumber" name="L383" href="#L383">383</a> log.warn(<span class="jxr_string">"Null role name found while retrieving role names for user ["</span> + username + <span class="jxr_string">"]"</span>);
<a class="jxr_linenumber" name="L384" href="#L384">384</a> }
<a class="jxr_linenumber" name="L385" href="#L385">385</a> }
<a class="jxr_linenumber" name="L386" href="#L386">386</a> }
<a class="jxr_linenumber" name="L387" href="#L387">387</a> } <strong class="jxr_keyword">finally</strong> {
<a class="jxr_linenumber" name="L388" href="#L388">388</a> JdbcUtils.closeResultSet(rs);
<a class="jxr_linenumber" name="L389" href="#L389">389</a> JdbcUtils.closeStatement(ps);
<a class="jxr_linenumber" name="L390" href="#L390">390</a> }
<a class="jxr_linenumber" name="L391" href="#L391">391</a> <strong class="jxr_keyword">return</strong> roleNames;
<a class="jxr_linenumber" name="L392" href="#L392">392</a> }
<a class="jxr_linenumber" name="L393" href="#L393">393</a>
<a class="jxr_linenumber" name="L394" href="#L394">394</a> <strong class="jxr_keyword">protected</strong> Set&lt;String&gt; getPermissions(Connection conn, String username, Collection&lt;String&gt; roleNames) <strong class="jxr_keyword">throws</strong> SQLException {
<a class="jxr_linenumber" name="L395" href="#L395">395</a> PreparedStatement ps = <strong class="jxr_keyword">null</strong>;
<a class="jxr_linenumber" name="L396" href="#L396">396</a> Set&lt;String&gt; permissions = <strong class="jxr_keyword">new</strong> LinkedHashSet&lt;String&gt;();
<a class="jxr_linenumber" name="L397" href="#L397">397</a> <strong class="jxr_keyword">try</strong> {
<a class="jxr_linenumber" name="L398" href="#L398">398</a> ps = conn.prepareStatement(permissionsQuery);
<a class="jxr_linenumber" name="L399" href="#L399">399</a> <strong class="jxr_keyword">for</strong> (String roleName : roleNames) {
<a class="jxr_linenumber" name="L400" href="#L400">400</a>
<a class="jxr_linenumber" name="L401" href="#L401">401</a> ps.setString(1, roleName);
<a class="jxr_linenumber" name="L402" href="#L402">402</a>
<a class="jxr_linenumber" name="L403" href="#L403">403</a> ResultSet rs = <strong class="jxr_keyword">null</strong>;
<a class="jxr_linenumber" name="L404" href="#L404">404</a>
<a class="jxr_linenumber" name="L405" href="#L405">405</a> <strong class="jxr_keyword">try</strong> {
<a class="jxr_linenumber" name="L406" href="#L406">406</a> <em class="jxr_comment">// Execute query</em>
<a class="jxr_linenumber" name="L407" href="#L407">407</a> rs = ps.executeQuery();
<a class="jxr_linenumber" name="L408" href="#L408">408</a>
<a class="jxr_linenumber" name="L409" href="#L409">409</a> <em class="jxr_comment">// Loop over results and add each returned role to a set</em>
<a class="jxr_linenumber" name="L410" href="#L410">410</a> <strong class="jxr_keyword">while</strong> (rs.next()) {
<a class="jxr_linenumber" name="L411" href="#L411">411</a>
<a class="jxr_linenumber" name="L412" href="#L412">412</a> String permissionString = rs.getString(1);
<a class="jxr_linenumber" name="L413" href="#L413">413</a>
<a class="jxr_linenumber" name="L414" href="#L414">414</a> <em class="jxr_comment">// Add the permission to the set of permissions</em>
<a class="jxr_linenumber" name="L415" href="#L415">415</a> permissions.add(permissionString);
<a class="jxr_linenumber" name="L416" href="#L416">416</a> }
<a class="jxr_linenumber" name="L417" href="#L417">417</a> } <strong class="jxr_keyword">finally</strong> {
<a class="jxr_linenumber" name="L418" href="#L418">418</a> JdbcUtils.closeResultSet(rs);
<a class="jxr_linenumber" name="L419" href="#L419">419</a> }
<a class="jxr_linenumber" name="L420" href="#L420">420</a>
<a class="jxr_linenumber" name="L421" href="#L421">421</a> }
<a class="jxr_linenumber" name="L422" href="#L422">422</a> } <strong class="jxr_keyword">finally</strong> {
<a class="jxr_linenumber" name="L423" href="#L423">423</a> JdbcUtils.closeStatement(ps);
<a class="jxr_linenumber" name="L424" href="#L424">424</a> }
<a class="jxr_linenumber" name="L425" href="#L425">425</a>
<a class="jxr_linenumber" name="L426" href="#L426">426</a> <strong class="jxr_keyword">return</strong> permissions;
<a class="jxr_linenumber" name="L427" href="#L427">427</a> }
<a class="jxr_linenumber" name="L428" href="#L428">428</a>
<a class="jxr_linenumber" name="L429" href="#L429">429</a> <strong class="jxr_keyword">protected</strong> String getSaltForUser(String username) {
<a class="jxr_linenumber" name="L430" href="#L430">430</a> <strong class="jxr_keyword">return</strong> username;
<a class="jxr_linenumber" name="L431" href="#L431">431</a> }
<a class="jxr_linenumber" name="L432" href="#L432">432</a>
<a class="jxr_linenumber" name="L433" href="#L433">433</a> }
</pre>
<hr/>
<div id="footer">Copyright &#169; 2004&#x2013;2016 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</div>
</body>
</html>