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