blob: db45e367e5e59960cc0ecc03a9e79e3f559ae52a [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="en">
<head>
<title>Source code</title>
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
</head>
<body>
<div class="sourceContainer">
<pre><span class="sourceLineNo">001</span>/*<a name="line.1"></a>
<span class="sourceLineNo">002</span> * Licensed to the Apache Software Foundation (ASF) under one<a name="line.2"></a>
<span class="sourceLineNo">003</span> * or more contributor license agreements. See the NOTICE file<a name="line.3"></a>
<span class="sourceLineNo">004</span> * distributed with this work for additional information<a name="line.4"></a>
<span class="sourceLineNo">005</span> * regarding copyright ownership. The ASF licenses this file<a name="line.5"></a>
<span class="sourceLineNo">006</span> * to you under the Apache License, Version 2.0 (the<a name="line.6"></a>
<span class="sourceLineNo">007</span> * "License"); you may not use this file except in compliance<a name="line.7"></a>
<span class="sourceLineNo">008</span> * with the License. You may obtain a copy of the License at<a name="line.8"></a>
<span class="sourceLineNo">009</span> *<a name="line.9"></a>
<span class="sourceLineNo">010</span> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.10"></a>
<span class="sourceLineNo">011</span> *<a name="line.11"></a>
<span class="sourceLineNo">012</span> * Unless required by applicable law or agreed to in writing,<a name="line.12"></a>
<span class="sourceLineNo">013</span> * software distributed under the License is distributed on an<a name="line.13"></a>
<span class="sourceLineNo">014</span> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY<a name="line.14"></a>
<span class="sourceLineNo">015</span> * KIND, either express or implied. See the License for the<a name="line.15"></a>
<span class="sourceLineNo">016</span> * specific language governing permissions and limitations<a name="line.16"></a>
<span class="sourceLineNo">017</span> * under the License.<a name="line.17"></a>
<span class="sourceLineNo">018</span> */<a name="line.18"></a>
<span class="sourceLineNo">019</span>package org.apache.shiro.authc;<a name="line.19"></a>
<span class="sourceLineNo">020</span><a name="line.20"></a>
<span class="sourceLineNo">021</span>import org.apache.shiro.authz.AuthorizationInfo;<a name="line.21"></a>
<span class="sourceLineNo">022</span><a name="line.22"></a>
<span class="sourceLineNo">023</span>/**<a name="line.23"></a>
<span class="sourceLineNo">024</span> * An &lt;tt&gt;Account&lt;/tt&gt; is a convenience interface that extends both {@link AuthenticationInfo} and<a name="line.24"></a>
<span class="sourceLineNo">025</span> * {@link AuthorizationInfo} and represents authentication and authorization for a &lt;em&gt;single account&lt;/em&gt; in a<a name="line.25"></a>
<span class="sourceLineNo">026</span> * &lt;em&gt;single Realm&lt;/em&gt;.<a name="line.26"></a>
<span class="sourceLineNo">027</span> * &lt;p/&gt;<a name="line.27"></a>
<span class="sourceLineNo">028</span> * This interface can be useful when a Realm implementation finds it more convenient to use a single object to<a name="line.28"></a>
<span class="sourceLineNo">029</span> * encapsulate both the authentication and authorization information used by both authc and authz operations.<a name="line.29"></a>
<span class="sourceLineNo">030</span> * &lt;p/&gt;<a name="line.30"></a>
<span class="sourceLineNo">031</span> * &lt;b&gt;Please Note&lt;/b&gt;: Since Shiro sometimes logs account operations, please ensure your Account's &lt;code&gt;toString()&lt;/code&gt;<a name="line.31"></a>
<span class="sourceLineNo">032</span> * implementation does &lt;em&gt;not&lt;/em&gt; print out account credentials (password, etc), as these might be viewable to<a name="line.32"></a>
<span class="sourceLineNo">033</span> * someone reading your logs. This is good practice anyway, and account principals should rarely (if ever) be printed<a name="line.33"></a>
<span class="sourceLineNo">034</span> * out for any reason. If you're using Shiro's default implementations of this interface, they only ever print the<a name="line.34"></a>
<span class="sourceLineNo">035</span> * account {@link #getPrincipals() principals}, so you do not need to do anything additional.<a name="line.35"></a>
<span class="sourceLineNo">036</span> *<a name="line.36"></a>
<span class="sourceLineNo">037</span> * @see SimpleAccount<a name="line.37"></a>
<span class="sourceLineNo">038</span> * @since 0.9<a name="line.38"></a>
<span class="sourceLineNo">039</span> */<a name="line.39"></a>
<span class="sourceLineNo">040</span>public interface Account extends AuthenticationInfo, AuthorizationInfo {<a name="line.40"></a>
<span class="sourceLineNo">041</span><a name="line.41"></a>
<span class="sourceLineNo">042</span>}<a name="line.42"></a>
</pre>
</div>
</body>
</html>