blob: 229486ad2984204ee3686ed2d59719121e9365b5 [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">/*</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">import org.apache.shiro.authz.AuthorizationInfo;</a>
<span class="sourceLineNo">022</span><a id="line.22"></a>
<span class="sourceLineNo">023</span><a id="line.23">/**</a>
<span class="sourceLineNo">024</span><a id="line.24"> * An &lt;tt&gt;Account&lt;/tt&gt; is a convenience interface that extends both {@link AuthenticationInfo} and</a>
<span class="sourceLineNo">025</span><a id="line.25"> * {@link AuthorizationInfo} and represents authentication and authorization for a &lt;em&gt;single account&lt;/em&gt; in a</a>
<span class="sourceLineNo">026</span><a id="line.26"> * &lt;em&gt;single Realm&lt;/em&gt;.</a>
<span class="sourceLineNo">027</span><a id="line.27"> * &lt;p/&gt;</a>
<span class="sourceLineNo">028</span><a id="line.28"> * This interface can be useful when a Realm implementation finds it more convenient to use a single object to</a>
<span class="sourceLineNo">029</span><a id="line.29"> * encapsulate both the authentication and authorization information used by both authc and authz operations.</a>
<span class="sourceLineNo">030</span><a id="line.30"> * &lt;p/&gt;</a>
<span class="sourceLineNo">031</span><a id="line.31"> * &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>
<span class="sourceLineNo">032</span><a id="line.32"> * implementation does &lt;em&gt;not&lt;/em&gt; print out account credentials (password, etc), as these might be viewable to</a>
<span class="sourceLineNo">033</span><a id="line.33"> * someone reading your logs. This is good practice anyway, and account principals should rarely (if ever) be printed</a>
<span class="sourceLineNo">034</span><a id="line.34"> * out for any reason. If you're using Shiro's default implementations of this interface, they only ever print the</a>
<span class="sourceLineNo">035</span><a id="line.35"> * account {@link #getPrincipals() principals}, so you do not need to do anything additional.</a>
<span class="sourceLineNo">036</span><a id="line.36"> *</a>
<span class="sourceLineNo">037</span><a id="line.37"> * @see SimpleAccount</a>
<span class="sourceLineNo">038</span><a id="line.38"> * @since 0.9</a>
<span class="sourceLineNo">039</span><a id="line.39"> */</a>
<span class="sourceLineNo">040</span><a id="line.40">public interface Account extends AuthenticationInfo, AuthorizationInfo {</a>
<span class="sourceLineNo">041</span><a id="line.41"></a>
<span class="sourceLineNo">042</span><a id="line.42">}</a>
</pre>
</div>
</main>
</body>
</html>