| <!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">package org.apache.archiva.redback.authentication;</a> |
| <span class="sourceLineNo">002</span><a id="line.2"></a> |
| <span class="sourceLineNo">003</span><a id="line.3">/*</a> |
| <span class="sourceLineNo">004</span><a id="line.4"> * Licensed to the Apache Software Foundation (ASF) under one</a> |
| <span class="sourceLineNo">005</span><a id="line.5"> * or more contributor license agreements. See the NOTICE file</a> |
| <span class="sourceLineNo">006</span><a id="line.6"> * distributed with this work for additional information</a> |
| <span class="sourceLineNo">007</span><a id="line.7"> * regarding copyright ownership. The ASF licenses this file</a> |
| <span class="sourceLineNo">008</span><a id="line.8"> * to you under the Apache License, Version 2.0 (the</a> |
| <span class="sourceLineNo">009</span><a id="line.9"> * "License"); you may not use this file except in compliance</a> |
| <span class="sourceLineNo">010</span><a id="line.10"> * with the License. You may obtain a copy of the License at</a> |
| <span class="sourceLineNo">011</span><a id="line.11"> *</a> |
| <span class="sourceLineNo">012</span><a id="line.12"> * http://www.apache.org/licenses/LICENSE-2.0</a> |
| <span class="sourceLineNo">013</span><a id="line.13"> *</a> |
| <span class="sourceLineNo">014</span><a id="line.14"> * Unless required by applicable law or agreed to in writing,</a> |
| <span class="sourceLineNo">015</span><a id="line.15"> * software distributed under the License is distributed on an</a> |
| <span class="sourceLineNo">016</span><a id="line.16"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</a> |
| <span class="sourceLineNo">017</span><a id="line.17"> * KIND, either express or implied. See the License for the</a> |
| <span class="sourceLineNo">018</span><a id="line.18"> * specific language governing permissions and limitations</a> |
| <span class="sourceLineNo">019</span><a id="line.19"> * under the License.</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">import org.apache.archiva.redback.policy.AccountLockedException;</a> |
| <span class="sourceLineNo">023</span><a id="line.23">import org.apache.archiva.redback.policy.MustChangePasswordException;</a> |
| <span class="sourceLineNo">024</span><a id="line.24"></a> |
| <span class="sourceLineNo">025</span><a id="line.25">import java.util.List;</a> |
| <span class="sourceLineNo">026</span><a id="line.26"></a> |
| <span class="sourceLineNo">027</span><a id="line.27">/**</a> |
| <span class="sourceLineNo">028</span><a id="line.28"> * AuthenticationManager:</a> |
| <span class="sourceLineNo">029</span><a id="line.29"> *</a> |
| <span class="sourceLineNo">030</span><a id="line.30"> * @author Jesse McConnell</a> |
| <span class="sourceLineNo">031</span><a id="line.31"> * @author Martin Stockhammer</a> |
| <span class="sourceLineNo">032</span><a id="line.32"> */</a> |
| <span class="sourceLineNo">033</span><a id="line.33">public interface AuthenticationManager</a> |
| <span class="sourceLineNo">034</span><a id="line.34">{</a> |
| <span class="sourceLineNo">035</span><a id="line.35"> /**</a> |
| <span class="sourceLineNo">036</span><a id="line.36"> * Returns the identifier of this authentication manager</a> |
| <span class="sourceLineNo">037</span><a id="line.37"> * @return the identifier string</a> |
| <span class="sourceLineNo">038</span><a id="line.38"> */</a> |
| <span class="sourceLineNo">039</span><a id="line.39"> String getId();</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"> * Returns the list of authenticators in the same order as they are called for authentication</a> |
| <span class="sourceLineNo">043</span><a id="line.43"> * @return the list of authenticators.</a> |
| <span class="sourceLineNo">044</span><a id="line.44"> */</a> |
| <span class="sourceLineNo">045</span><a id="line.45"> List<Authenticator> getAuthenticators();</a> |
| <span class="sourceLineNo">046</span><a id="line.46"></a> |
| <span class="sourceLineNo">047</span><a id="line.47"> /**</a> |
| <span class="sourceLineNo">048</span><a id="line.48"> * Authenticates by calling all authenticators in the defined order.</a> |
| <span class="sourceLineNo">049</span><a id="line.49"> *</a> |
| <span class="sourceLineNo">050</span><a id="line.50"> * @param source the authentication data</a> |
| <span class="sourceLineNo">051</span><a id="line.51"> * @return the result that gives information, if the authentication was successful</a> |
| <span class="sourceLineNo">052</span><a id="line.52"> * @throws AccountLockedException if the account is locked</a> |
| <span class="sourceLineNo">053</span><a id="line.53"> * @throws AuthenticationException if something unexpected happend during authentication</a> |
| <span class="sourceLineNo">054</span><a id="line.54"> * @throws MustChangePasswordException if the user has to change his password</a> |
| <span class="sourceLineNo">055</span><a id="line.55"> */</a> |
| <span class="sourceLineNo">056</span><a id="line.56"> AuthenticationResult authenticate( AuthenticationDataSource source )</a> |
| <span class="sourceLineNo">057</span><a id="line.57"> throws AccountLockedException, AuthenticationException, MustChangePasswordException;</a> |
| <span class="sourceLineNo">058</span><a id="line.58"></a> |
| <span class="sourceLineNo">059</span><a id="line.59"> /**</a> |
| <span class="sourceLineNo">060</span><a id="line.60"> * Returns the authenticator controls that are used to control the order and actions during authentication.</a> |
| <span class="sourceLineNo">061</span><a id="line.61"> * @return the list of controls</a> |
| <span class="sourceLineNo">062</span><a id="line.62"> */</a> |
| <span class="sourceLineNo">063</span><a id="line.63"> List<AuthenticatorControl> getControls();</a> |
| <span class="sourceLineNo">064</span><a id="line.64"></a> |
| <span class="sourceLineNo">065</span><a id="line.65"> /**</a> |
| <span class="sourceLineNo">066</span><a id="line.66"> * Sets the list of authenticator controls</a> |
| <span class="sourceLineNo">067</span><a id="line.67"> * @param controlList the list of control instances</a> |
| <span class="sourceLineNo">068</span><a id="line.68"> */</a> |
| <span class="sourceLineNo">069</span><a id="line.69"> void setControls( List<AuthenticatorControl> controlList);</a> |
| <span class="sourceLineNo">070</span><a id="line.70"></a> |
| <span class="sourceLineNo">071</span><a id="line.71"> /**</a> |
| <span class="sourceLineNo">072</span><a id="line.72"> * Modifies the control for a single authenticator</a> |
| <span class="sourceLineNo">073</span><a id="line.73"> * @param control the authenticator control</a> |
| <span class="sourceLineNo">074</span><a id="line.74"> */</a> |
| <span class="sourceLineNo">075</span><a id="line.75"> void modifyControl(AuthenticatorControl control);</a> |
| <span class="sourceLineNo">076</span><a id="line.76">}</a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </main> |
| </body> |
| </html> |
