blob: 248ff0995f721983786a0a0d46fd27feaf049432 [file] [log] [blame]
<HTML>
<BODY BGCOLOR="white">
<PRE>
<FONT color="green">001</FONT> /*<a name="line.1"></a>
<FONT color="green">002</FONT> * Licensed to the Apache Software Foundation (ASF) under one<a name="line.2"></a>
<FONT color="green">003</FONT> * or more contributor license agreements. See the NOTICE file<a name="line.3"></a>
<FONT color="green">004</FONT> * distributed with this work for additional information<a name="line.4"></a>
<FONT color="green">005</FONT> * regarding copyright ownership. The ASF licenses this file<a name="line.5"></a>
<FONT color="green">006</FONT> * to you under the Apache License, Version 2.0 (the<a name="line.6"></a>
<FONT color="green">007</FONT> * "License"); you may not use this file except in compliance<a name="line.7"></a>
<FONT color="green">008</FONT> * with the License. You may obtain a copy of the License at<a name="line.8"></a>
<FONT color="green">009</FONT> *<a name="line.9"></a>
<FONT color="green">010</FONT> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.10"></a>
<FONT color="green">011</FONT> *<a name="line.11"></a>
<FONT color="green">012</FONT> * Unless required by applicable law or agreed to in writing,<a name="line.12"></a>
<FONT color="green">013</FONT> * software distributed under the License is distributed on an<a name="line.13"></a>
<FONT color="green">014</FONT> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY<a name="line.14"></a>
<FONT color="green">015</FONT> * KIND, either express or implied. See the License for the<a name="line.15"></a>
<FONT color="green">016</FONT> * specific language governing permissions and limitations<a name="line.16"></a>
<FONT color="green">017</FONT> * under the License.<a name="line.17"></a>
<FONT color="green">018</FONT> */<a name="line.18"></a>
<FONT color="green">019</FONT> package org.apache.shiro.authc;<a name="line.19"></a>
<FONT color="green">020</FONT> <a name="line.20"></a>
<FONT color="green">021</FONT> /**<a name="line.21"></a>
<FONT color="green">022</FONT> * &lt;p&gt;An extension of the {@link AuthenticationInfo} interface to be implemented by<a name="line.22"></a>
<FONT color="green">023</FONT> * classes that support merging with other {@link AuthenticationInfo} instances.&lt;/p&gt;<a name="line.23"></a>
<FONT color="green">024</FONT> *<a name="line.24"></a>
<FONT color="green">025</FONT> * &lt;p&gt;This allows an instance of this class to be an &lt;em&gt;aggregation&lt;/em&gt;, or &lt;em&gt;composition&lt;/em&gt; of account data<a name="line.25"></a>
<FONT color="green">026</FONT> * from across multiple &lt;code&gt;Realm&lt;/code&gt;s &lt;tt&gt;Realm&lt;/tt&gt;s, not just one realm.&lt;/p&gt;<a name="line.26"></a>
<FONT color="green">027</FONT> *<a name="line.27"></a>
<FONT color="green">028</FONT> * &lt;p&gt;This is useful in a multi-realm authentication configuration - the individual &lt;tt&gt;AuthenticationInfo&lt;/tt&gt;<a name="line.28"></a>
<FONT color="green">029</FONT> * objects obtained from each realm can be {@link #merge merged} into a single instance. This instance can then be<a name="line.29"></a>
<FONT color="green">030</FONT> * returned at the end of the authentication process, giving the impression of a single underlying<a name="line.30"></a>
<FONT color="green">031</FONT> * realm/data source.<a name="line.31"></a>
<FONT color="green">032</FONT> *<a name="line.32"></a>
<FONT color="green">033</FONT> * @since 0.9<a name="line.33"></a>
<FONT color="green">034</FONT> */<a name="line.34"></a>
<FONT color="green">035</FONT> public interface MergableAuthenticationInfo extends AuthenticationInfo {<a name="line.35"></a>
<FONT color="green">036</FONT> <a name="line.36"></a>
<FONT color="green">037</FONT> /**<a name="line.37"></a>
<FONT color="green">038</FONT> * Merges the given {@link AuthenticationInfo} into this instance. The specific way<a name="line.38"></a>
<FONT color="green">039</FONT> * that the merge occurs is up to the implementation, but typically it involves combining<a name="line.39"></a>
<FONT color="green">040</FONT> * the principals and credentials together in this instance. The &lt;code&gt;info&lt;/code&gt; argument should<a name="line.40"></a>
<FONT color="green">041</FONT> * not be modified in any way.<a name="line.41"></a>
<FONT color="green">042</FONT> *<a name="line.42"></a>
<FONT color="green">043</FONT> * @param info the info that should be merged into this instance.<a name="line.43"></a>
<FONT color="green">044</FONT> */<a name="line.44"></a>
<FONT color="green">045</FONT> void merge(AuthenticationInfo info);<a name="line.45"></a>
<FONT color="green">046</FONT> <a name="line.46"></a>
<FONT color="green">047</FONT> }<a name="line.47"></a>
</PRE>
</BODY>
</HTML>