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