blob: 36919698e61327305f965debdba9faa0e386158b [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="fr">
<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.mgt;<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.AuthenticationException;<a name="line.21"></a>
<span class="sourceLineNo">022</span>import org.apache.shiro.authc.AuthenticationInfo;<a name="line.22"></a>
<span class="sourceLineNo">023</span>import org.apache.shiro.authc.AuthenticationToken;<a name="line.23"></a>
<span class="sourceLineNo">024</span>import org.apache.shiro.authc.Authenticator;<a name="line.24"></a>
<span class="sourceLineNo">025</span>import org.apache.shiro.authc.pam.ModularRealmAuthenticator;<a name="line.25"></a>
<span class="sourceLineNo">026</span>import org.apache.shiro.util.LifecycleUtils;<a name="line.26"></a>
<span class="sourceLineNo">027</span><a name="line.27"></a>
<span class="sourceLineNo">028</span><a name="line.28"></a>
<span class="sourceLineNo">029</span>/**<a name="line.29"></a>
<span class="sourceLineNo">030</span> * Shiro support of a {@link SecurityManager} class hierarchy that delegates all<a name="line.30"></a>
<span class="sourceLineNo">031</span> * authentication operations to a wrapped {@link Authenticator Authenticator} instance. That is, this class<a name="line.31"></a>
<span class="sourceLineNo">032</span> * implements all the &lt;tt&gt;Authenticator&lt;/tt&gt; methods in the {@link SecurityManager SecurityManager}<a name="line.32"></a>
<span class="sourceLineNo">033</span> * interface, but in reality, those methods are merely passthrough calls to the underlying 'real'<a name="line.33"></a>
<span class="sourceLineNo">034</span> * &lt;tt&gt;Authenticator&lt;/tt&gt; instance.<a name="line.34"></a>
<span class="sourceLineNo">035</span> *<a name="line.35"></a>
<span class="sourceLineNo">036</span> * &lt;p&gt;All other &lt;tt&gt;SecurityManager&lt;/tt&gt; (authorization, session, etc) methods are left to be implemented by subclasses.<a name="line.36"></a>
<span class="sourceLineNo">037</span> *<a name="line.37"></a>
<span class="sourceLineNo">038</span> * &lt;p&gt;In keeping with the other classes in this hierarchy and Shiro's desire to minimize configuration whenever<a name="line.38"></a>
<span class="sourceLineNo">039</span> * possible, suitable default instances for all dependencies are created upon instantiation.<a name="line.39"></a>
<span class="sourceLineNo">040</span> *<a name="line.40"></a>
<span class="sourceLineNo">041</span> * @since 0.9<a name="line.41"></a>
<span class="sourceLineNo">042</span> */<a name="line.42"></a>
<span class="sourceLineNo">043</span>public abstract class AuthenticatingSecurityManager extends RealmSecurityManager {<a name="line.43"></a>
<span class="sourceLineNo">044</span><a name="line.44"></a>
<span class="sourceLineNo">045</span> /**<a name="line.45"></a>
<span class="sourceLineNo">046</span> * The internal &lt;code&gt;Authenticator&lt;/code&gt; delegate instance that this SecurityManager instance will use<a name="line.46"></a>
<span class="sourceLineNo">047</span> * to perform all authentication operations.<a name="line.47"></a>
<span class="sourceLineNo">048</span> */<a name="line.48"></a>
<span class="sourceLineNo">049</span> private Authenticator authenticator;<a name="line.49"></a>
<span class="sourceLineNo">050</span><a name="line.50"></a>
<span class="sourceLineNo">051</span> /**<a name="line.51"></a>
<span class="sourceLineNo">052</span> * Default no-arg constructor that initializes its internal<a name="line.52"></a>
<span class="sourceLineNo">053</span> * &lt;code&gt;authenticator&lt;/code&gt; instance to a<a name="line.53"></a>
<span class="sourceLineNo">054</span> * {@link org.apache.shiro.authc.pam.ModularRealmAuthenticator ModularRealmAuthenticator}.<a name="line.54"></a>
<span class="sourceLineNo">055</span> */<a name="line.55"></a>
<span class="sourceLineNo">056</span> public AuthenticatingSecurityManager() {<a name="line.56"></a>
<span class="sourceLineNo">057</span> super();<a name="line.57"></a>
<span class="sourceLineNo">058</span> this.authenticator = new ModularRealmAuthenticator();<a name="line.58"></a>
<span class="sourceLineNo">059</span> }<a name="line.59"></a>
<span class="sourceLineNo">060</span><a name="line.60"></a>
<span class="sourceLineNo">061</span> /**<a name="line.61"></a>
<span class="sourceLineNo">062</span> * Returns the delegate &lt;code&gt;Authenticator&lt;/code&gt; instance that this SecurityManager uses to perform all<a name="line.62"></a>
<span class="sourceLineNo">063</span> * authentication operations. Unless overridden by the<a name="line.63"></a>
<span class="sourceLineNo">064</span> * {@link #setAuthenticator(org.apache.shiro.authc.Authenticator) setAuthenticator}, the default instance is a<a name="line.64"></a>
<span class="sourceLineNo">065</span> * {@link org.apache.shiro.authc.pam.ModularRealmAuthenticator ModularRealmAuthenticator}.<a name="line.65"></a>
<span class="sourceLineNo">066</span> *<a name="line.66"></a>
<span class="sourceLineNo">067</span> * @return the delegate &lt;code&gt;Authenticator&lt;/code&gt; instance that this SecurityManager uses to perform all<a name="line.67"></a>
<span class="sourceLineNo">068</span> * authentication operations.<a name="line.68"></a>
<span class="sourceLineNo">069</span> */<a name="line.69"></a>
<span class="sourceLineNo">070</span> public Authenticator getAuthenticator() {<a name="line.70"></a>
<span class="sourceLineNo">071</span> return authenticator;<a name="line.71"></a>
<span class="sourceLineNo">072</span> }<a name="line.72"></a>
<span class="sourceLineNo">073</span><a name="line.73"></a>
<span class="sourceLineNo">074</span> /**<a name="line.74"></a>
<span class="sourceLineNo">075</span> * Sets the delegate &lt;code&gt;Authenticator&lt;/code&gt; instance that this SecurityManager uses to perform all<a name="line.75"></a>
<span class="sourceLineNo">076</span> * authentication operations. Unless overridden by this method, the default instance is a<a name="line.76"></a>
<span class="sourceLineNo">077</span> * {@link org.apache.shiro.authc.pam.ModularRealmAuthenticator ModularRealmAuthenticator}.<a name="line.77"></a>
<span class="sourceLineNo">078</span> *<a name="line.78"></a>
<span class="sourceLineNo">079</span> * @param authenticator the delegate &lt;code&gt;Authenticator&lt;/code&gt; instance that this SecurityManager will use to<a name="line.79"></a>
<span class="sourceLineNo">080</span> * perform all authentication operations.<a name="line.80"></a>
<span class="sourceLineNo">081</span> * @throws IllegalArgumentException if the argument is &lt;code&gt;null&lt;/code&gt;.<a name="line.81"></a>
<span class="sourceLineNo">082</span> */<a name="line.82"></a>
<span class="sourceLineNo">083</span> public void setAuthenticator(Authenticator authenticator) throws IllegalArgumentException {<a name="line.83"></a>
<span class="sourceLineNo">084</span> if (authenticator == null) {<a name="line.84"></a>
<span class="sourceLineNo">085</span> String msg = "Authenticator argument cannot be null.";<a name="line.85"></a>
<span class="sourceLineNo">086</span> throw new IllegalArgumentException(msg);<a name="line.86"></a>
<span class="sourceLineNo">087</span> }<a name="line.87"></a>
<span class="sourceLineNo">088</span> this.authenticator = authenticator;<a name="line.88"></a>
<span class="sourceLineNo">089</span> }<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> * Passes on the {@link #getRealms() realms} to the internal delegate &lt;code&gt;Authenticator&lt;/code&gt; instance so<a name="line.92"></a>
<span class="sourceLineNo">093</span> * that it may use them during authentication attempts.<a name="line.93"></a>
<span class="sourceLineNo">094</span> */<a name="line.94"></a>
<span class="sourceLineNo">095</span> protected void afterRealmsSet() {<a name="line.95"></a>
<span class="sourceLineNo">096</span> super.afterRealmsSet();<a name="line.96"></a>
<span class="sourceLineNo">097</span> if (this.authenticator instanceof ModularRealmAuthenticator) {<a name="line.97"></a>
<span class="sourceLineNo">098</span> ((ModularRealmAuthenticator) this.authenticator).setRealms(getRealms());<a name="line.98"></a>
<span class="sourceLineNo">099</span> }<a name="line.99"></a>
<span class="sourceLineNo">100</span> }<a name="line.100"></a>
<span class="sourceLineNo">101</span><a name="line.101"></a>
<span class="sourceLineNo">102</span> /**<a name="line.102"></a>
<span class="sourceLineNo">103</span> * Delegates to the wrapped {@link org.apache.shiro.authc.Authenticator Authenticator} for authentication.<a name="line.103"></a>
<span class="sourceLineNo">104</span> */<a name="line.104"></a>
<span class="sourceLineNo">105</span> public AuthenticationInfo authenticate(AuthenticationToken token) throws AuthenticationException {<a name="line.105"></a>
<span class="sourceLineNo">106</span> return this.authenticator.authenticate(token);<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> public void destroy() {<a name="line.109"></a>
<span class="sourceLineNo">110</span> LifecycleUtils.destroy(getAuthenticator());<a name="line.110"></a>
<span class="sourceLineNo">111</span> this.authenticator = null;<a name="line.111"></a>
<span class="sourceLineNo">112</span> super.destroy();<a name="line.112"></a>
<span class="sourceLineNo">113</span> }<a name="line.113"></a>
<span class="sourceLineNo">114</span>}<a name="line.114"></a>
</pre>
</div>
</body>
</html>