Google Git
Sign in
apache / shiro-site / 01016f43374d9b054f3ea1e568b015d5d69428f9 / . / src / site / assets / static / 1.3.2 / apidocs / src-html / org / apache / shiro / realm / SimpleAccountRealm.html
blob: 242aaf169a6171b684bfe29c22ed2f4749f8ec19 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="en">
<head>
<title>Source code</title>
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
</head>
<body>
<div class="sourceContainer">
<pre><span class="sourceLineNo">001</span>/*<a name="line.1"></a>
<span class="sourceLineNo">002</span> * Licensed to the Apache Software Foundation (ASF) under one<a name="line.2"></a>
<span class="sourceLineNo">003</span> * or more contributor license agreements. See the NOTICE file<a name="line.3"></a>
<span class="sourceLineNo">004</span> * distributed with this work for additional information<a name="line.4"></a>
<span class="sourceLineNo">005</span> * regarding copyright ownership. The ASF licenses this file<a name="line.5"></a>
<span class="sourceLineNo">006</span> * to you under the Apache License, Version 2.0 (the<a name="line.6"></a>
<span class="sourceLineNo">007</span> * "License"); you may not use this file except in compliance<a name="line.7"></a>
<span class="sourceLineNo">008</span> * with the License. You may obtain a copy of the License at<a name="line.8"></a>
<span class="sourceLineNo">009</span> *<a name="line.9"></a>
<span class="sourceLineNo">010</span> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.10"></a>
<span class="sourceLineNo">011</span> *<a name="line.11"></a>
<span class="sourceLineNo">012</span> * Unless required by applicable law or agreed to in writing,<a name="line.12"></a>
<span class="sourceLineNo">013</span> * software distributed under the License is distributed on an<a name="line.13"></a>
<span class="sourceLineNo">014</span> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY<a name="line.14"></a>
<span class="sourceLineNo">015</span> * KIND, either express or implied. See the License for the<a name="line.15"></a>
<span class="sourceLineNo">016</span> * specific language governing permissions and limitations<a name="line.16"></a>
<span class="sourceLineNo">017</span> * under the License.<a name="line.17"></a>
<span class="sourceLineNo">018</span> */<a name="line.18"></a>
<span class="sourceLineNo">019</span>package org.apache.shiro.realm;<a name="line.19"></a>
<span class="sourceLineNo">020</span><a name="line.20"></a>
<span class="sourceLineNo">021</span>import org.apache.shiro.authc.*;<a name="line.21"></a>
<span class="sourceLineNo">022</span>import org.apache.shiro.authz.AuthorizationInfo;<a name="line.22"></a>
<span class="sourceLineNo">023</span>import org.apache.shiro.authz.SimpleRole;<a name="line.23"></a>
<span class="sourceLineNo">024</span>import org.apache.shiro.subject.PrincipalCollection;<a name="line.24"></a>
<span class="sourceLineNo">025</span>import org.apache.shiro.util.CollectionUtils;<a name="line.25"></a>
<span class="sourceLineNo">026</span><a name="line.26"></a>
<span class="sourceLineNo">027</span>import java.util.HashSet;<a name="line.27"></a>
<span class="sourceLineNo">028</span>import java.util.LinkedHashMap;<a name="line.28"></a>
<span class="sourceLineNo">029</span>import java.util.Map;<a name="line.29"></a>
<span class="sourceLineNo">030</span>import java.util.Set;<a name="line.30"></a>
<span class="sourceLineNo">031</span>import java.util.concurrent.locks.Lock;<a name="line.31"></a>
<span class="sourceLineNo">032</span>import java.util.concurrent.locks.ReadWriteLock;<a name="line.32"></a>
<span class="sourceLineNo">033</span>import java.util.concurrent.locks.ReentrantReadWriteLock;<a name="line.33"></a>
<span class="sourceLineNo">034</span><a name="line.34"></a>
<span class="sourceLineNo">035</span>/**<a name="line.35"></a>
<span class="sourceLineNo">036</span> * A simple implementation of the {@link Realm Realm} interface that<a name="line.36"></a>
<span class="sourceLineNo">037</span> * uses a set of configured user accounts and roles to support authentication and authorization. Each account entry<a name="line.37"></a>
<span class="sourceLineNo">038</span> * specifies the username, password, and roles for a user. Roles can also be mapped<a name="line.38"></a>
<span class="sourceLineNo">039</span> * to permissions and associated with users.<a name="line.39"></a>
<span class="sourceLineNo">040</span> * &lt;p/&gt;<a name="line.40"></a>
<span class="sourceLineNo">041</span> * User accounts and roles are stored in two {@code Map}s in memory, so it is expected that the total number of either<a name="line.41"></a>
<span class="sourceLineNo">042</span> * is not sufficiently large.<a name="line.42"></a>
<span class="sourceLineNo">043</span> *<a name="line.43"></a>
<span class="sourceLineNo">044</span> * @since 0.1<a name="line.44"></a>
<span class="sourceLineNo">045</span> */<a name="line.45"></a>
<span class="sourceLineNo">046</span>public class SimpleAccountRealm extends AuthorizingRealm {<a name="line.46"></a>
<span class="sourceLineNo">047</span><a name="line.47"></a>
<span class="sourceLineNo">048</span> //TODO - complete JavaDoc<a name="line.48"></a>
<span class="sourceLineNo">049</span> protected final Map&lt;String, SimpleAccount&gt; users; //username-to-SimpleAccount<a name="line.49"></a>
<span class="sourceLineNo">050</span> protected final Map&lt;String, SimpleRole&gt; roles; //roleName-to-SimpleRole<a name="line.50"></a>
<span class="sourceLineNo">051</span> protected final ReadWriteLock USERS_LOCK;<a name="line.51"></a>
<span class="sourceLineNo">052</span> protected final ReadWriteLock ROLES_LOCK;<a name="line.52"></a>
<span class="sourceLineNo">053</span><a name="line.53"></a>
<span class="sourceLineNo">054</span> public SimpleAccountRealm() {<a name="line.54"></a>
<span class="sourceLineNo">055</span> this.users = new LinkedHashMap&lt;String, SimpleAccount&gt;();<a name="line.55"></a>
<span class="sourceLineNo">056</span> this.roles = new LinkedHashMap&lt;String, SimpleRole&gt;();<a name="line.56"></a>
<span class="sourceLineNo">057</span> USERS_LOCK = new ReentrantReadWriteLock();<a name="line.57"></a>
<span class="sourceLineNo">058</span> ROLES_LOCK = new ReentrantReadWriteLock();<a name="line.58"></a>
<span class="sourceLineNo">059</span> //SimpleAccountRealms are memory-only realms - no need for an additional cache mechanism since we're<a name="line.59"></a>
<span class="sourceLineNo">060</span> //already as memory-efficient as we can be:<a name="line.60"></a>
<span class="sourceLineNo">061</span> setCachingEnabled(false);<a name="line.61"></a>
<span class="sourceLineNo">062</span> }<a name="line.62"></a>
<span class="sourceLineNo">063</span><a name="line.63"></a>
<span class="sourceLineNo">064</span> public SimpleAccountRealm(String name) {<a name="line.64"></a>
<span class="sourceLineNo">065</span> this();<a name="line.65"></a>
<span class="sourceLineNo">066</span> setName(name);<a name="line.66"></a>
<span class="sourceLineNo">067</span> }<a name="line.67"></a>
<span class="sourceLineNo">068</span><a name="line.68"></a>
<span class="sourceLineNo">069</span> protected SimpleAccount getUser(String username) {<a name="line.69"></a>
<span class="sourceLineNo">070</span> USERS_LOCK.readLock().lock();<a name="line.70"></a>
<span class="sourceLineNo">071</span> try {<a name="line.71"></a>
<span class="sourceLineNo">072</span> return this.users.get(username);<a name="line.72"></a>
<span class="sourceLineNo">073</span> } finally {<a name="line.73"></a>
<span class="sourceLineNo">074</span> USERS_LOCK.readLock().unlock();<a name="line.74"></a>
<span class="sourceLineNo">075</span> }<a name="line.75"></a>
<span class="sourceLineNo">076</span> }<a name="line.76"></a>
<span class="sourceLineNo">077</span><a name="line.77"></a>
<span class="sourceLineNo">078</span> public boolean accountExists(String username) {<a name="line.78"></a>
<span class="sourceLineNo">079</span> return getUser(username) != null;<a name="line.79"></a>
<span class="sourceLineNo">080</span> }<a name="line.80"></a>
<span class="sourceLineNo">081</span><a name="line.81"></a>
<span class="sourceLineNo">082</span> public void addAccount(String username, String password) {<a name="line.82"></a>
<span class="sourceLineNo">083</span> addAccount(username, password, (String[]) null);<a name="line.83"></a>
<span class="sourceLineNo">084</span> }<a name="line.84"></a>
<span class="sourceLineNo">085</span><a name="line.85"></a>
<span class="sourceLineNo">086</span> public void addAccount(String username, String password, String... roles) {<a name="line.86"></a>
<span class="sourceLineNo">087</span> Set&lt;String&gt; roleNames = CollectionUtils.asSet(roles);<a name="line.87"></a>
<span class="sourceLineNo">088</span> SimpleAccount account = new SimpleAccount(username, password, getName(), roleNames, null);<a name="line.88"></a>
<span class="sourceLineNo">089</span> add(account);<a name="line.89"></a>
<span class="sourceLineNo">090</span> }<a name="line.90"></a>
<span class="sourceLineNo">091</span><a name="line.91"></a>
<span class="sourceLineNo">092</span> protected String getUsername(SimpleAccount account) {<a name="line.92"></a>
<span class="sourceLineNo">093</span> return getUsername(account.getPrincipals());<a name="line.93"></a>
<span class="sourceLineNo">094</span> }<a name="line.94"></a>
<span class="sourceLineNo">095</span><a name="line.95"></a>
<span class="sourceLineNo">096</span> protected String getUsername(PrincipalCollection principals) {<a name="line.96"></a>
<span class="sourceLineNo">097</span> return getAvailablePrincipal(principals).toString();<a name="line.97"></a>
<span class="sourceLineNo">098</span> }<a name="line.98"></a>
<span class="sourceLineNo">099</span><a name="line.99"></a>
<span class="sourceLineNo">100</span> protected void add(SimpleAccount account) {<a name="line.100"></a>
<span class="sourceLineNo">101</span> String username = getUsername(account);<a name="line.101"></a>
<span class="sourceLineNo">102</span> USERS_LOCK.writeLock().lock();<a name="line.102"></a>
<span class="sourceLineNo">103</span> try {<a name="line.103"></a>
<span class="sourceLineNo">104</span> this.users.put(username, account);<a name="line.104"></a>
<span class="sourceLineNo">105</span> } finally {<a name="line.105"></a>
<span class="sourceLineNo">106</span> USERS_LOCK.writeLock().unlock();<a name="line.106"></a>
<span class="sourceLineNo">107</span> }<a name="line.107"></a>
<span class="sourceLineNo">108</span> }<a name="line.108"></a>
<span class="sourceLineNo">109</span><a name="line.109"></a>
<span class="sourceLineNo">110</span> protected SimpleRole getRole(String rolename) {<a name="line.110"></a>
<span class="sourceLineNo">111</span> ROLES_LOCK.readLock().lock();<a name="line.111"></a>
<span class="sourceLineNo">112</span> try {<a name="line.112"></a>
<span class="sourceLineNo">113</span> return roles.get(rolename);<a name="line.113"></a>
<span class="sourceLineNo">114</span> } finally {<a name="line.114"></a>
<span class="sourceLineNo">115</span> ROLES_LOCK.readLock().unlock();<a name="line.115"></a>
<span class="sourceLineNo">116</span> }<a name="line.116"></a>
<span class="sourceLineNo">117</span> }<a name="line.117"></a>
<span class="sourceLineNo">118</span><a name="line.118"></a>
<span class="sourceLineNo">119</span> public boolean roleExists(String name) {<a name="line.119"></a>
<span class="sourceLineNo">120</span> return getRole(name) != null;<a name="line.120"></a>
<span class="sourceLineNo">121</span> }<a name="line.121"></a>
<span class="sourceLineNo">122</span><a name="line.122"></a>
<span class="sourceLineNo">123</span> public void addRole(String name) {<a name="line.123"></a>
<span class="sourceLineNo">124</span> add(new SimpleRole(name));<a name="line.124"></a>
<span class="sourceLineNo">125</span> }<a name="line.125"></a>
<span class="sourceLineNo">126</span><a name="line.126"></a>
<span class="sourceLineNo">127</span> protected void add(SimpleRole role) {<a name="line.127"></a>
<span class="sourceLineNo">128</span> ROLES_LOCK.writeLock().lock();<a name="line.128"></a>
<span class="sourceLineNo">129</span> try {<a name="line.129"></a>
<span class="sourceLineNo">130</span> roles.put(role.getName(), role);<a name="line.130"></a>
<span class="sourceLineNo">131</span> } finally {<a name="line.131"></a>
<span class="sourceLineNo">132</span> ROLES_LOCK.writeLock().unlock();<a name="line.132"></a>
<span class="sourceLineNo">133</span> }<a name="line.133"></a>
<span class="sourceLineNo">134</span> }<a name="line.134"></a>
<span class="sourceLineNo">135</span><a name="line.135"></a>
<span class="sourceLineNo">136</span> protected static Set&lt;String&gt; toSet(String delimited, String delimiter) {<a name="line.136"></a>
<span class="sourceLineNo">137</span> if (delimited == null || delimited.trim().equals("")) {<a name="line.137"></a>
<span class="sourceLineNo">138</span> return null;<a name="line.138"></a>
<span class="sourceLineNo">139</span> }<a name="line.139"></a>
<span class="sourceLineNo">140</span><a name="line.140"></a>
<span class="sourceLineNo">141</span> Set&lt;String&gt; values = new HashSet&lt;String&gt;();<a name="line.141"></a>
<span class="sourceLineNo">142</span> String[] rolenamesArray = delimited.split(delimiter);<a name="line.142"></a>
<span class="sourceLineNo">143</span> for (String s : rolenamesArray) {<a name="line.143"></a>
<span class="sourceLineNo">144</span> String trimmed = s.trim();<a name="line.144"></a>
<span class="sourceLineNo">145</span> if (trimmed.length() &gt; 0) {<a name="line.145"></a>
<span class="sourceLineNo">146</span> values.add(trimmed);<a name="line.146"></a>
<span class="sourceLineNo">147</span> }<a name="line.147"></a>
<span class="sourceLineNo">148</span> }<a name="line.148"></a>
<span class="sourceLineNo">149</span><a name="line.149"></a>
<span class="sourceLineNo">150</span> return values;<a name="line.150"></a>
<span class="sourceLineNo">151</span> }<a name="line.151"></a>
<span class="sourceLineNo">152</span><a name="line.152"></a>
<span class="sourceLineNo">153</span> protected AuthenticationInfo doGetAuthenticationInfo(AuthenticationToken token) throws AuthenticationException {<a name="line.153"></a>
<span class="sourceLineNo">154</span> UsernamePasswordToken upToken = (UsernamePasswordToken) token;<a name="line.154"></a>
<span class="sourceLineNo">155</span> SimpleAccount account = getUser(upToken.getUsername());<a name="line.155"></a>
<span class="sourceLineNo">156</span><a name="line.156"></a>
<span class="sourceLineNo">157</span> if (account != null) {<a name="line.157"></a>
<span class="sourceLineNo">158</span><a name="line.158"></a>
<span class="sourceLineNo">159</span> if (account.isLocked()) {<a name="line.159"></a>
<span class="sourceLineNo">160</span> throw new LockedAccountException("Account [" + account + "] is locked.");<a name="line.160"></a>
<span class="sourceLineNo">161</span> }<a name="line.161"></a>
<span class="sourceLineNo">162</span> if (account.isCredentialsExpired()) {<a name="line.162"></a>
<span class="sourceLineNo">163</span> String msg = "The credentials for account [" + account + "] are expired";<a name="line.163"></a>
<span class="sourceLineNo">164</span> throw new ExpiredCredentialsException(msg);<a name="line.164"></a>
<span class="sourceLineNo">165</span> }<a name="line.165"></a>
<span class="sourceLineNo">166</span><a name="line.166"></a>
<span class="sourceLineNo">167</span> }<a name="line.167"></a>
<span class="sourceLineNo">168</span><a name="line.168"></a>
<span class="sourceLineNo">169</span> return account;<a name="line.169"></a>
<span class="sourceLineNo">170</span> }<a name="line.170"></a>
<span class="sourceLineNo">171</span><a name="line.171"></a>
<span class="sourceLineNo">172</span> protected AuthorizationInfo doGetAuthorizationInfo(PrincipalCollection principals) {<a name="line.172"></a>
<span class="sourceLineNo">173</span> String username = getUsername(principals);<a name="line.173"></a>
<span class="sourceLineNo">174</span> USERS_LOCK.readLock().lock();<a name="line.174"></a>
<span class="sourceLineNo">175</span> try {<a name="line.175"></a>
<span class="sourceLineNo">176</span> return this.users.get(username);<a name="line.176"></a>
<span class="sourceLineNo">177</span> } finally {<a name="line.177"></a>
<span class="sourceLineNo">178</span> USERS_LOCK.readLock().unlock();<a name="line.178"></a>
<span class="sourceLineNo">179</span> }<a name="line.179"></a>
<span class="sourceLineNo">180</span> }<a name="line.180"></a>
<span class="sourceLineNo">181</span>}<a name="line.181"></a>
</pre>
</div>
</body>
</html>