blob: a832ae040efbf2e13679c93657d0c2d885a0728b [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=ISO-8859-1" />
<title>User xref</title>
<link type="text/css" rel="stylesheet" href="../../../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../../../apidocs/org/apache/shiro/samples/sprhib/model/User.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.samples.sprhib.model;
<a name="20" href="#20">20</a>
<a name="21" href="#21">21</a> <strong class="jxr_keyword">import</strong> org.hibernate.annotations.Cache;
<a name="22" href="#22">22</a> <strong class="jxr_keyword">import</strong> org.hibernate.annotations.CacheConcurrencyStrategy;
<a name="23" href="#23">23</a> <strong class="jxr_keyword">import</strong> org.hibernate.annotations.Index;
<a name="24" href="#24">24</a>
<a name="25" href="#25">25</a> <strong class="jxr_keyword">import</strong> javax.persistence.*;
<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.Set;
<a name="28" href="#28">28</a>
<a name="29" href="#29">29</a> <em class="jxr_javadoccomment">/**</em>
<a name="30" href="#30">30</a> <em class="jxr_javadoccomment"> * Simple class that represents any User domain entity in any application.</em>
<a name="31" href="#31">31</a> <em class="jxr_javadoccomment"> *</em>
<a name="32" href="#32">32</a> <em class="jxr_javadoccomment"> * &lt;p&gt;Because this class performs its own Realm and Permission checks, and these can happen frequently enough in a</em>
<a name="33" href="#33">33</a> <em class="jxr_javadoccomment"> * production application, it is highly recommended that the internal User {@link #getRoles} collection be cached</em>
<a name="34" href="#34">34</a> <em class="jxr_javadoccomment"> * in a 2nd-level cache when using JPA and/or Hibernate. The hibernate xml configuration for this sample application</em>
<a name="35" href="#35">35</a> <em class="jxr_javadoccomment"> * does in fact do this for your reference (see User.hbm.xml - the 'roles' declaration).&lt;/p&gt;</em>
<a name="36" href="#36">36</a> <em class="jxr_javadoccomment"> */</em>
<a name="37" href="#37">37</a> @Entity
<a name="38" href="#38">38</a> @Table(name=<span class="jxr_string">"users"</span>)
<a name="39" href="#39">39</a> @Cache(usage= CacheConcurrencyStrategy.READ_WRITE)
<a name="40" href="#40">40</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../../org/apache/shiro/samples/sprhib/model/User.html">User</a> {
<a name="41" href="#41">41</a>
<a name="42" href="#42">42</a> <strong class="jxr_keyword">private</strong> Long id;
<a name="43" href="#43">43</a> <strong class="jxr_keyword">private</strong> String username;
<a name="44" href="#44">44</a> <strong class="jxr_keyword">private</strong> String email;
<a name="45" href="#45">45</a> <strong class="jxr_keyword">private</strong> String password;
<a name="46" href="#46">46</a> <strong class="jxr_keyword">private</strong> Set&lt;Role&gt; roles = <strong class="jxr_keyword">new</strong> HashSet&lt;Role&gt;();
<a name="47" href="#47">47</a>
<a name="48" href="#48">48</a>
<a name="49" href="#49">49</a> @Id
<a name="50" href="#50">50</a> @GeneratedValue
<a name="51" href="#51">51</a> <strong class="jxr_keyword">public</strong> Long getId() {
<a name="52" href="#52">52</a> <strong class="jxr_keyword">return</strong> id;
<a name="53" href="#53">53</a> }
<a name="54" href="#54">54</a>
<a name="55" href="#55">55</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setId(Long id) {
<a name="56" href="#56">56</a> <strong class="jxr_keyword">this</strong>.id = id;
<a name="57" href="#57">57</a> }
<a name="58" href="#58">58</a>
<a name="59" href="#59">59</a> <em class="jxr_javadoccomment">/**</em>
<a name="60" href="#60">60</a> <em class="jxr_javadoccomment"> * Returns the username associated with this user account;</em>
<a name="61" href="#61">61</a> <em class="jxr_javadoccomment"> *</em>
<a name="62" href="#62">62</a> <em class="jxr_javadoccomment"> * @return the username associated with this user account;</em>
<a name="63" href="#63">63</a> <em class="jxr_javadoccomment"> */</em>
<a name="64" href="#64">64</a> @Basic(optional=false)
<a name="65" href="#65">65</a> @Column(length=100)
<a name="66" href="#66">66</a> @Index(name=<span class="jxr_string">"idx_users_username"</span>)
<a name="67" href="#67">67</a> <strong class="jxr_keyword">public</strong> String getUsername() {
<a name="68" href="#68">68</a> <strong class="jxr_keyword">return</strong> username;
<a name="69" href="#69">69</a> }
<a name="70" href="#70">70</a>
<a name="71" href="#71">71</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setUsername(String username) {
<a name="72" href="#72">72</a> <strong class="jxr_keyword">this</strong>.username = username;
<a name="73" href="#73">73</a> }
<a name="74" href="#74">74</a>
<a name="75" href="#75">75</a> @Basic(optional=false)
<a name="76" href="#76">76</a> @Index(name=<span class="jxr_string">"idx_users_email"</span>)
<a name="77" href="#77">77</a> <strong class="jxr_keyword">public</strong> String getEmail() {
<a name="78" href="#78">78</a> <strong class="jxr_keyword">return</strong> email;
<a name="79" href="#79">79</a> }
<a name="80" href="#80">80</a>
<a name="81" href="#81">81</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setEmail(String email) {
<a name="82" href="#82">82</a> <strong class="jxr_keyword">this</strong>.email = email;
<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 the password for this user.</em>
<a name="87" href="#87">87</a> <em class="jxr_javadoccomment"> *</em>
<a name="88" href="#88">88</a> <em class="jxr_javadoccomment"> * @return this user's password</em>
<a name="89" href="#89">89</a> <em class="jxr_javadoccomment"> */</em>
<a name="90" href="#90">90</a> @Basic(optional=false)
<a name="91" href="#91">91</a> @Column(length=255)
<a name="92" href="#92">92</a> <strong class="jxr_keyword">public</strong> String getPassword() {
<a name="93" href="#93">93</a> <strong class="jxr_keyword">return</strong> password;
<a name="94" href="#94">94</a> }
<a name="95" href="#95">95</a>
<a name="96" href="#96">96</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setPassword(String password) {
<a name="97" href="#97">97</a> <strong class="jxr_keyword">this</strong>.password = password;
<a name="98" href="#98">98</a> }
<a name="99" href="#99">99</a>
<a name="100" href="#100">100</a>
<a name="101" href="#101">101</a> @ManyToMany
<a name="102" href="#102">102</a> @JoinTable(name=<span class="jxr_string">"users_roles"</span>)
<a name="103" href="#103">103</a> @Cache(usage=CacheConcurrencyStrategy.READ_WRITE)
<a name="104" href="#104">104</a> <strong class="jxr_keyword">public</strong> Set&lt;Role&gt; getRoles() {
<a name="105" href="#105">105</a> <strong class="jxr_keyword">return</strong> roles;
<a name="106" href="#106">106</a> }
<a name="107" href="#107">107</a>
<a name="108" href="#108">108</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setRoles(Set&lt;Role&gt; roles) {
<a name="109" href="#109">109</a> <strong class="jxr_keyword">this</strong>.roles = roles;
<a name="110" href="#110">110</a> }
<a name="111" href="#111">111</a>
<a name="112" href="#112">112</a> }
<a name="113" href="#113">113</a>
<a name="114" href="#114">114</a>
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>