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