blob: 40f8ba8380aed725c2839f85e61b105af715f26a [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">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.users.User;</a>
<span class="sourceLineNo">023</span><a id="line.23"></a>
<span class="sourceLineNo">024</span><a id="line.24">import java.io.Serializable;</a>
<span class="sourceLineNo">025</span><a id="line.25">import java.util.ArrayList;</a>
<span class="sourceLineNo">026</span><a id="line.26">import java.util.HashMap;</a>
<span class="sourceLineNo">027</span><a id="line.27">import java.util.List;</a>
<span class="sourceLineNo">028</span><a id="line.28">import java.util.Map;</a>
<span class="sourceLineNo">029</span><a id="line.29"></a>
<span class="sourceLineNo">030</span><a id="line.30">/**</a>
<span class="sourceLineNo">031</span><a id="line.31"> * AuthenticationResult: wrapper object for information that comes back from the authentication system</a>
<span class="sourceLineNo">032</span><a id="line.32"> *</a>
<span class="sourceLineNo">033</span><a id="line.33"> * @author Jesse McConnell</a>
<span class="sourceLineNo">034</span><a id="line.34"> */</a>
<span class="sourceLineNo">035</span><a id="line.35">public class AuthenticationResult</a>
<span class="sourceLineNo">036</span><a id="line.36"> implements Serializable</a>
<span class="sourceLineNo">037</span><a id="line.37">{</a>
<span class="sourceLineNo">038</span><a id="line.38"></a>
<span class="sourceLineNo">039</span><a id="line.39"> private static final long serialVersionUID = 354054054054L;</a>
<span class="sourceLineNo">040</span><a id="line.40"></a>
<span class="sourceLineNo">041</span><a id="line.41"> private boolean isAuthenticated;</a>
<span class="sourceLineNo">042</span><a id="line.42"></a>
<span class="sourceLineNo">043</span><a id="line.43"> private String principal;</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"> * as we can search the User store it here for reuse.</a>
<span class="sourceLineNo">047</span><a id="line.47"> *</a>
<span class="sourceLineNo">048</span><a id="line.48"> * @since 2.1</a>
<span class="sourceLineNo">049</span><a id="line.49"> */</a>
<span class="sourceLineNo">050</span><a id="line.50"> private User user;</a>
<span class="sourceLineNo">051</span><a id="line.51"></a>
<span class="sourceLineNo">052</span><a id="line.52"> // TODO: why aren't these just thrown from the authenticate() method?</a>
<span class="sourceLineNo">053</span><a id="line.53"> private Exception exception;</a>
<span class="sourceLineNo">054</span><a id="line.54"></a>
<span class="sourceLineNo">055</span><a id="line.55"> private List&lt;AuthenticationFailureCause&gt; authenticationFailureCauses;</a>
<span class="sourceLineNo">056</span><a id="line.56"></a>
<span class="sourceLineNo">057</span><a id="line.57"> public AuthenticationResult()</a>
<span class="sourceLineNo">058</span><a id="line.58"> {</a>
<span class="sourceLineNo">059</span><a id="line.59"> this.isAuthenticated = false;</a>
<span class="sourceLineNo">060</span><a id="line.60"> this.principal = null;</a>
<span class="sourceLineNo">061</span><a id="line.61"> this.exception = null;</a>
<span class="sourceLineNo">062</span><a id="line.62"> }</a>
<span class="sourceLineNo">063</span><a id="line.63"></a>
<span class="sourceLineNo">064</span><a id="line.64"> public AuthenticationResult( boolean authenticated, String principal, Exception exception )</a>
<span class="sourceLineNo">065</span><a id="line.65"> {</a>
<span class="sourceLineNo">066</span><a id="line.66"> isAuthenticated = authenticated;</a>
<span class="sourceLineNo">067</span><a id="line.67"> this.principal = principal;</a>
<span class="sourceLineNo">068</span><a id="line.68"> this.exception = exception;</a>
<span class="sourceLineNo">069</span><a id="line.69"> }</a>
<span class="sourceLineNo">070</span><a id="line.70"></a>
<span class="sourceLineNo">071</span><a id="line.71"> public AuthenticationResult( boolean authenticated, String principal, Exception exception,</a>
<span class="sourceLineNo">072</span><a id="line.72"> List&lt;AuthenticationFailureCause&gt; authenticationFailureCauses )</a>
<span class="sourceLineNo">073</span><a id="line.73"> {</a>
<span class="sourceLineNo">074</span><a id="line.74"> isAuthenticated = authenticated;</a>
<span class="sourceLineNo">075</span><a id="line.75"> this.principal = principal;</a>
<span class="sourceLineNo">076</span><a id="line.76"> this.exception = exception;</a>
<span class="sourceLineNo">077</span><a id="line.77"> this.authenticationFailureCauses = authenticationFailureCauses;</a>
<span class="sourceLineNo">078</span><a id="line.78"> }</a>
<span class="sourceLineNo">079</span><a id="line.79"></a>
<span class="sourceLineNo">080</span><a id="line.80"> public boolean isAuthenticated()</a>
<span class="sourceLineNo">081</span><a id="line.81"> {</a>
<span class="sourceLineNo">082</span><a id="line.82"> return isAuthenticated;</a>
<span class="sourceLineNo">083</span><a id="line.83"> }</a>
<span class="sourceLineNo">084</span><a id="line.84"></a>
<span class="sourceLineNo">085</span><a id="line.85"> public String getPrincipal()</a>
<span class="sourceLineNo">086</span><a id="line.86"> {</a>
<span class="sourceLineNo">087</span><a id="line.87"> return principal;</a>
<span class="sourceLineNo">088</span><a id="line.88"> }</a>
<span class="sourceLineNo">089</span><a id="line.89"></a>
<span class="sourceLineNo">090</span><a id="line.90"> public Exception getException()</a>
<span class="sourceLineNo">091</span><a id="line.91"> {</a>
<span class="sourceLineNo">092</span><a id="line.92"> return exception;</a>
<span class="sourceLineNo">093</span><a id="line.93"> }</a>
<span class="sourceLineNo">094</span><a id="line.94"></a>
<span class="sourceLineNo">095</span><a id="line.95"> public List&lt;AuthenticationFailureCause&gt; getAuthenticationFailureCauses()</a>
<span class="sourceLineNo">096</span><a id="line.96"> {</a>
<span class="sourceLineNo">097</span><a id="line.97"> if ( authenticationFailureCauses == null )</a>
<span class="sourceLineNo">098</span><a id="line.98"> {</a>
<span class="sourceLineNo">099</span><a id="line.99"> this.authenticationFailureCauses = new ArrayList&lt;&gt;( );</a>
<span class="sourceLineNo">100</span><a id="line.100"> }</a>
<span class="sourceLineNo">101</span><a id="line.101"> return authenticationFailureCauses;</a>
<span class="sourceLineNo">102</span><a id="line.102"> }</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"> * &lt;b&gt;can be &lt;code&gt;null&lt;/code&gt;&lt;/b&gt;</a>
<span class="sourceLineNo">106</span><a id="line.106"> */</a>
<span class="sourceLineNo">107</span><a id="line.107"> public User getUser()</a>
<span class="sourceLineNo">108</span><a id="line.108"> {</a>
<span class="sourceLineNo">109</span><a id="line.109"> return user;</a>
<span class="sourceLineNo">110</span><a id="line.110"> }</a>
<span class="sourceLineNo">111</span><a id="line.111"></a>
<span class="sourceLineNo">112</span><a id="line.112"> public void setUser( User user )</a>
<span class="sourceLineNo">113</span><a id="line.113"> {</a>
<span class="sourceLineNo">114</span><a id="line.114"> this.user = user;</a>
<span class="sourceLineNo">115</span><a id="line.115"> }</a>
<span class="sourceLineNo">116</span><a id="line.116"></a>
<span class="sourceLineNo">117</span><a id="line.117"> public AuthenticationResult user( User user )</a>
<span class="sourceLineNo">118</span><a id="line.118"> {</a>
<span class="sourceLineNo">119</span><a id="line.119"> this.setUser( user );</a>
<span class="sourceLineNo">120</span><a id="line.120"> return this;</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"> public String toString()</a>
<span class="sourceLineNo">124</span><a id="line.124"> {</a>
<span class="sourceLineNo">125</span><a id="line.125"> StringBuilder sb = new StringBuilder();</a>
<span class="sourceLineNo">126</span><a id="line.126"> sb.append( "AuthenticationResult[" );</a>
<span class="sourceLineNo">127</span><a id="line.127"> sb.append( "principal=" ).append( principal );</a>
<span class="sourceLineNo">128</span><a id="line.128"> sb.append( ",isAuthenticated=" ).append( Boolean.toString( isAuthenticated ) );</a>
<span class="sourceLineNo">129</span><a id="line.129"> sb.append( ",exception=" );</a>
<span class="sourceLineNo">130</span><a id="line.130"> if ( exception != null )</a>
<span class="sourceLineNo">131</span><a id="line.131"> {</a>
<span class="sourceLineNo">132</span><a id="line.132"> sb.append( exception.getClass().getName() );</a>
<span class="sourceLineNo">133</span><a id="line.133"> sb.append( " : " ).append( exception.getMessage() );</a>
<span class="sourceLineNo">134</span><a id="line.134"> }</a>
<span class="sourceLineNo">135</span><a id="line.135"> else</a>
<span class="sourceLineNo">136</span><a id="line.136"> {</a>
<span class="sourceLineNo">137</span><a id="line.137"> sb.append( "&lt;null&gt;" );</a>
<span class="sourceLineNo">138</span><a id="line.138"> }</a>
<span class="sourceLineNo">139</span><a id="line.139"> sb.append( ']' );</a>
<span class="sourceLineNo">140</span><a id="line.140"> return sb.toString();</a>
<span class="sourceLineNo">141</span><a id="line.141"> }</a>
<span class="sourceLineNo">142</span><a id="line.142">}</a>
</pre>
</div>
</main>
</body>
</html>