blob: bb400744479e2129d7c153a37f814039fc29bcf6 [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" />
<title>Account xref</title>
<link type="text/css" rel="stylesheet" href="../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../apidocs/org/apache/shiro/authc/Account.html">View Javadoc</a></div><pre>
<a name="1" href="#1">1</a> <em class="jxr_comment">/*</em>
<a name="2" href="#2">2</a> <em class="jxr_comment"> * Licensed to the Apache Software Foundation (ASF) under one</em>
<a name="3" href="#3">3</a> <em class="jxr_comment"> * or more contributor license agreements. See the NOTICE file</em>
<a name="4" href="#4">4</a> <em class="jxr_comment"> * distributed with this work for additional information</em>
<a name="5" href="#5">5</a> <em class="jxr_comment"> * regarding copyright ownership. The ASF licenses this file</em>
<a name="6" href="#6">6</a> <em class="jxr_comment"> * to you under the Apache License, Version 2.0 (the</em>
<a name="7" href="#7">7</a> <em class="jxr_comment"> * "License"); you may not use this file except in compliance</em>
<a name="8" href="#8">8</a> <em class="jxr_comment"> * with the License. You may obtain a copy of the License at</em>
<a name="9" href="#9">9</a> <em class="jxr_comment"> *</em>
<a name="10" href="#10">10</a> <em class="jxr_comment"> * <a href="http://www.apache.org/licenses/LICENSE-2.0" target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a></em>
<a name="11" href="#11">11</a> <em class="jxr_comment"> *</em>
<a name="12" href="#12">12</a> <em class="jxr_comment"> * Unless required by applicable law or agreed to in writing,</em>
<a name="13" href="#13">13</a> <em class="jxr_comment"> * software distributed under the License is distributed on an</em>
<a name="14" href="#14">14</a> <em class="jxr_comment"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</em>
<a name="15" href="#15">15</a> <em class="jxr_comment"> * KIND, either express or implied. See the License for the</em>
<a name="16" href="#16">16</a> <em class="jxr_comment"> * specific language governing permissions and limitations</em>
<a name="17" href="#17">17</a> <em class="jxr_comment"> * under the License.</em>
<a name="18" href="#18">18</a> <em class="jxr_comment"> */</em>
<a name="19" href="#19">19</a> <strong class="jxr_keyword">package</strong> org.apache.shiro.authc;
<a name="20" href="#20">20</a>
<a name="21" href="#21">21</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.authz.AuthorizationInfo;
<a name="22" href="#22">22</a>
<a name="23" href="#23">23</a> <em class="jxr_javadoccomment">/**</em>
<a name="24" href="#24">24</a> <em class="jxr_javadoccomment"> * An &lt;tt&gt;Account&lt;/tt&gt; is a convenience interface that extends both {@link AuthenticationInfo} and</em>
<a name="25" href="#25">25</a> <em class="jxr_javadoccomment"> * {@link AuthorizationInfo} and represents authentication and authorization for a &lt;em&gt;single account&lt;/em&gt; in a</em>
<a name="26" href="#26">26</a> <em class="jxr_javadoccomment"> * &lt;em&gt;single Realm&lt;/em&gt;.</em>
<a name="27" href="#27">27</a> <em class="jxr_javadoccomment"> * &lt;p/&gt;</em>
<a name="28" href="#28">28</a> <em class="jxr_javadoccomment"> * This interface can be useful when a Realm implementation finds it more convenient to use a single object to</em>
<a name="29" href="#29">29</a> <em class="jxr_javadoccomment"> * encapsulate both the authentication and authorization information used by both authc and authz operations.</em>
<a name="30" href="#30">30</a> <em class="jxr_javadoccomment"> * &lt;p/&gt;</em>
<a name="31" href="#31">31</a> <em class="jxr_javadoccomment"> * &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;</em>
<a name="32" href="#32">32</a> <em class="jxr_javadoccomment"> * implementation does &lt;em&gt;not&lt;/em&gt; print out account credentials (password, etc), as these might be viewable to</em>
<a name="33" href="#33">33</a> <em class="jxr_javadoccomment"> * someone reading your logs. This is good practice anyway, and account principals should rarely (if ever) be printed</em>
<a name="34" href="#34">34</a> <em class="jxr_javadoccomment"> * out for any reason. If you're using Shiro's default implementations of this interface, they only ever print the</em>
<a name="35" href="#35">35</a> <em class="jxr_javadoccomment"> * account {@link #getPrincipals() principals}, so you do not need to do anything additional.</em>
<a name="36" href="#36">36</a> <em class="jxr_javadoccomment"> *</em>
<a name="37" href="#37">37</a> <em class="jxr_javadoccomment"> * @see SimpleAccount</em>
<a name="38" href="#38">38</a> <em class="jxr_javadoccomment"> * @since 0.9</em>
<a name="39" href="#39">39</a> <em class="jxr_javadoccomment"> */</em>
<a name="40" href="#40">40</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">interface</strong> <a href="../../../../org/apache/shiro/authc/Account.html">Account</a> <strong class="jxr_keyword">extends</strong> AuthenticationInfo, <a href="../../../../org/apache/shiro/authz/AuthorizationInfo.html">AuthorizationInfo</a> {
<a name="41" href="#41">41</a>
<a name="42" href="#42">42</a> }
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>