| <!DOCTYPE HTML> |
| <html lang="fr"> |
| <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.authc;</a> |
| <span class="sourceLineNo">020</span><a id="line.20"></a> |
| <span class="sourceLineNo">021</span><a id="line.21">/**</a> |
| <span class="sourceLineNo">022</span><a id="line.22"> * An Authenticator is responsible for authenticating accounts in an application. It</a> |
| <span class="sourceLineNo">023</span><a id="line.23"> * is one of the primary entry points into the Shiro API.</a> |
| <span class="sourceLineNo">024</span><a id="line.24"> * <p/></a> |
| <span class="sourceLineNo">025</span><a id="line.25"> * Although not a requirement, there is usually a single 'master' Authenticator configured for</a> |
| <span class="sourceLineNo">026</span><a id="line.26"> * an application. Enabling Pluggable Authentication Module (PAM) behavior</a> |
| <span class="sourceLineNo">027</span><a id="line.27"> * (Two Phase Commit, etc.) is usually achieved by the single {@code Authenticator} coordinating</a> |
| <span class="sourceLineNo">028</span><a id="line.28"> * and interacting with an application-configured set of {@link org.apache.shiro.realm.Realm Realm}s.</a> |
| <span class="sourceLineNo">029</span><a id="line.29"> * <p/></a> |
| <span class="sourceLineNo">030</span><a id="line.30"> * Note that most Shiro users will not interact with an {@code Authenticator} instance directly.</a> |
| <span class="sourceLineNo">031</span><a id="line.31"> * Shiro's default architecture is based on an overall {@code SecurityManager} which typically</a> |
| <span class="sourceLineNo">032</span><a id="line.32"> * wraps an {@code Authenticator} instance.</a> |
| <span class="sourceLineNo">033</span><a id="line.33"> *</a> |
| <span class="sourceLineNo">034</span><a id="line.34"> * @see org.apache.shiro.mgt.SecurityManager</a> |
| <span class="sourceLineNo">035</span><a id="line.35"> * @see AbstractAuthenticator AbstractAuthenticator</a> |
| <span class="sourceLineNo">036</span><a id="line.36"> * @see org.apache.shiro.authc.pam.ModularRealmAuthenticator ModularRealmAuthenticator</a> |
| <span class="sourceLineNo">037</span><a id="line.37"> * @since 0.1</a> |
| <span class="sourceLineNo">038</span><a id="line.38"> */</a> |
| <span class="sourceLineNo">039</span><a id="line.39">public interface Authenticator {</a> |
| <span class="sourceLineNo">040</span><a id="line.40"></a> |
| <span class="sourceLineNo">041</span><a id="line.41"> /**</a> |
| <span class="sourceLineNo">042</span><a id="line.42"> * Authenticates a user based on the submitted {@code AuthenticationToken}.</a> |
| <span class="sourceLineNo">043</span><a id="line.43"> * <p/></a> |
| <span class="sourceLineNo">044</span><a id="line.44"> * If the authentication is successful, an {@link AuthenticationInfo} instance is returned that represents the</a> |
| <span class="sourceLineNo">045</span><a id="line.45"> * user's account data relevant to Shiro. This returned object is generally used in turn to construct a</a> |
| <span class="sourceLineNo">046</span><a id="line.46"> * {@code Subject} representing a more complete security-specific 'view' of an account that also allows access to</a> |
| <span class="sourceLineNo">047</span><a id="line.47"> * a {@code Session}.</a> |
| <span class="sourceLineNo">048</span><a id="line.48"> *</a> |
| <span class="sourceLineNo">049</span><a id="line.49"> * @param authenticationToken any representation of a user's principals and credentials submitted during an</a> |
| <span class="sourceLineNo">050</span><a id="line.50"> * authentication attempt.</a> |
| <span class="sourceLineNo">051</span><a id="line.51"> * @return the AuthenticationInfo representing the authenticating user's account data.</a> |
| <span class="sourceLineNo">052</span><a id="line.52"> * @throws AuthenticationException if there is any problem during the authentication process.</a> |
| <span class="sourceLineNo">053</span><a id="line.53"> * See the specific exceptions listed below to as examples of what could happen</a> |
| <span class="sourceLineNo">054</span><a id="line.54"> * in order to accurately handle these problems and to notify the user in an</a> |
| <span class="sourceLineNo">055</span><a id="line.55"> * appropriate manner why the authentication attempt failed. Realize an</a> |
| <span class="sourceLineNo">056</span><a id="line.56"> * implementation of this interface may or may not throw those listed or may</a> |
| <span class="sourceLineNo">057</span><a id="line.57"> * throw other AuthenticationExceptions, but the list shows the most common ones.</a> |
| <span class="sourceLineNo">058</span><a id="line.58"> * @see ExpiredCredentialsException</a> |
| <span class="sourceLineNo">059</span><a id="line.59"> * @see IncorrectCredentialsException</a> |
| <span class="sourceLineNo">060</span><a id="line.60"> * @see ExcessiveAttemptsException</a> |
| <span class="sourceLineNo">061</span><a id="line.61"> * @see LockedAccountException</a> |
| <span class="sourceLineNo">062</span><a id="line.62"> * @see ConcurrentAccessException</a> |
| <span class="sourceLineNo">063</span><a id="line.63"> * @see UnknownAccountException</a> |
| <span class="sourceLineNo">064</span><a id="line.64"> */</a> |
| <span class="sourceLineNo">065</span><a id="line.65"> public AuthenticationInfo authenticate(AuthenticationToken authenticationToken)</a> |
| <span class="sourceLineNo">066</span><a id="line.66"> throws AuthenticationException;</a> |
| <span class="sourceLineNo">067</span><a id="line.67">}</a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </main> |
| </body> |
| </html> |
