| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc --> |
| <title>SimpleAccount (Apache Shiro :: Core 1.11.0 API)</title> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../jquery/jquery-ui.css" title="Style"> |
| <script type="text/javascript" src="../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../jquery/jszip/dist/jszip.min.js"></script> |
| <script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script> |
| <!--[if IE]> |
| <script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script> |
| <![endif]--> |
| <script type="text/javascript" src="../../../../jquery/jquery-3.5.1.js"></script> |
| <script type="text/javascript" src="../../../../jquery/jquery-ui.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="SimpleAccount (Apache Shiro :: Core 1.11.0 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10,"i20":10,"i21":10,"i22":10,"i23":10,"i24":10,"i25":10}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| var pathtoroot = "../../../../"; |
| var useModuleDirectories = true; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <header role="banner"> |
| <nav role="navigation"> |
| <div class="fixedNav"><!-- Matomo --> <script> var _paq = window._paq = window._paq || []; /* tracker methods like "setCustomDimension" should be called before "trackPageView" */ /* We explicitly disable cookie tracking to avoid privacy issues */ _paq.push(['disableCookies']); _paq.push(['trackPageView']); _paq.push(['enableLinkTracking']); (function() { var u="//matomo.privacy.apache.org/"; _paq.push(['setTrackerUrl', u+'matomo.php']); _paq.push(['setSiteId', '2']); var d=document, g=d.createElement('script'), s=d.getElementsByTagName('script')[0]; g.async=true; g.src=u+'matomo.js'; s.parentNode.insertBefore(g,s); })(); </script> <!-- End Matomo Code --> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a id="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/SimpleAccount.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../allclasses.html">All Classes</a></li> |
| </ul> |
| <ul class="navListSearch"> |
| <li><label for="search">SEARCH:</label> |
| <input type="text" id="search" value="search" disabled="disabled"> |
| <input type="reset" id="reset" value="reset" disabled="disabled"> |
| </li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a id="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| </div> |
| <div class="navPadding"> </div> |
| <script type="text/javascript"><!-- |
| $('.navPadding').css('padding-top', $('.fixedNav').css("height")); |
| //--> |
| </script> |
| </nav> |
| </header> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <main role="main"> |
| <div class="header"> |
| <div class="subTitle"><span class="packageLabelInType">Package</span> <a href="package-summary.html">org.apache.shiro.authc</a></div> |
| <h2 title="Class SimpleAccount" class="title">Class SimpleAccount</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">java.lang.Object</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.shiro.authc.SimpleAccount</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io" class="externalLink">Serializable</a></code>, <code><a href="Account.html" title="interface in org.apache.shiro.authc">Account</a></code>, <code><a href="AuthenticationInfo.html" title="interface in org.apache.shiro.authc">AuthenticationInfo</a></code>, <code><a href="MergableAuthenticationInfo.html" title="interface in org.apache.shiro.authc">MergableAuthenticationInfo</a></code>, <code><a href="SaltedAuthenticationInfo.html" title="interface in org.apache.shiro.authc">SaltedAuthenticationInfo</a></code>, <code><a href="../authz/AuthorizationInfo.html" title="interface in org.apache.shiro.authz">AuthorizationInfo</a></code></dd> |
| </dl> |
| <hr> |
| <pre>public class <a href="../../../../src-html/org/apache/shiro/authc/SimpleAccount.html#line.39">SimpleAccount</a> |
| extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> |
| implements <a href="Account.html" title="interface in org.apache.shiro.authc">Account</a>, <a href="MergableAuthenticationInfo.html" title="interface in org.apache.shiro.authc">MergableAuthenticationInfo</a>, <a href="SaltedAuthenticationInfo.html" title="interface in org.apache.shiro.authc">SaltedAuthenticationInfo</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io" class="externalLink">Serializable</a></pre> |
| <div class="block">Simple implementation of the <a href="Account.html" title="interface in org.apache.shiro.authc"><code>Account</code></a> interface that |
| contains principal and credential and authorization information (roles and permissions) as instance variables and |
| exposes them via getters and setters using standard JavaBean notation.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>0.1</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../serialized-form.html#org.apache.shiro.authc.SimpleAccount">Serialized Form</a></dd> |
| </dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Constructor</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr class="altColor"> |
| <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E()">SimpleAccount</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Default no-argument constructor.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(java.lang.Object,java.lang.Object,java.lang.String)">SimpleAccount</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> principal, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> credentials, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> realmName)</code></th> |
| <td class="colLast"> |
| <div class="block">Constructs a SimpleAccount instance for the specified realm with the given principals and credentials.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(java.lang.Object,java.lang.Object,java.lang.String,java.util.Set,java.util.Set)">SimpleAccount</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> principal, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> credentials, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> realmName, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util" class="externalLink">Set</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>> roleNames, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util" class="externalLink">Set</a><<a href="../authz/Permission.html" title="interface in org.apache.shiro.authz">Permission</a>> permissions)</code></th> |
| <td class="colLast"> |
| <div class="block">Constructs a SimpleAccount instance for the specified realm with the given principal and credentials, with the |
| the assigned roles and permissions.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(java.lang.Object,java.lang.Object,org.apache.shiro.util.ByteSource,java.lang.String)">SimpleAccount</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> principal, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> hashedCredentials, |
| org.apache.shiro.util.ByteSource credentialsSalt, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> realmName)</code></th> |
| <td class="colLast"> |
| <div class="block">Constructs a SimpleAccount instance for the specified realm with the given principals, hashedCredentials and |
| credentials salt used when hashing the credentials.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(java.util.Collection,java.lang.Object,java.lang.String)">SimpleAccount</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util" class="externalLink">Collection</a> principals, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> credentials, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> realmName)</code></th> |
| <td class="colLast"> |
| <div class="block">Constructs a SimpleAccount instance for the specified realm with the given principals and credentials.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(java.util.Collection,java.lang.Object,java.lang.String,java.util.Set,java.util.Set)">SimpleAccount</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util" class="externalLink">Collection</a> principals, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> credentials, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> realmName, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util" class="externalLink">Set</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>> roleNames, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util" class="externalLink">Set</a><<a href="../authz/Permission.html" title="interface in org.apache.shiro.authz">Permission</a>> permissions)</code></th> |
| <td class="colLast"> |
| <div class="block">Constructs a SimpleAccount instance for the specified realm with the given principals and credentials, with the |
| the assigned roles and permissions.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(org.apache.shiro.subject.PrincipalCollection,java.lang.Object)">SimpleAccount</a></span>​(<a href="../subject/PrincipalCollection.html" title="interface in org.apache.shiro.subject">PrincipalCollection</a> principals, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> credentials)</code></th> |
| <td class="colLast"> |
| <div class="block">Constructs a SimpleAccount instance for the specified principals and credentials.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(org.apache.shiro.subject.PrincipalCollection,java.lang.Object,java.util.Set)">SimpleAccount</a></span>​(<a href="../subject/PrincipalCollection.html" title="interface in org.apache.shiro.subject">PrincipalCollection</a> principals, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> credentials, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util" class="externalLink">Set</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>> roles)</code></th> |
| <td class="colLast"> |
| <div class="block">Constructs a SimpleAccount instance for the specified principals and credentials, with the assigned roles.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(org.apache.shiro.subject.PrincipalCollection,java.lang.Object,java.util.Set,java.util.Set)">SimpleAccount</a></span>​(<a href="../subject/PrincipalCollection.html" title="interface in org.apache.shiro.subject">PrincipalCollection</a> principals, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> credentials, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util" class="externalLink">Set</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>> roleNames, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util" class="externalLink">Set</a><<a href="../authz/Permission.html" title="interface in org.apache.shiro.authz">Permission</a>> permissions)</code></th> |
| <td class="colLast"> |
| <div class="block">Constructs a SimpleAccount instance from the given principals and credentials, with the |
| the assigned roles and permissions.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(org.apache.shiro.subject.PrincipalCollection,java.lang.Object,org.apache.shiro.util.ByteSource)">SimpleAccount</a></span>​(<a href="../subject/PrincipalCollection.html" title="interface in org.apache.shiro.subject">PrincipalCollection</a> principals, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> hashedCredentials, |
| org.apache.shiro.util.ByteSource credentialsSalt)</code></th> |
| <td class="colLast"> |
| <div class="block">Constructs a SimpleAccount instance for the specified principals and credentials.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </section> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colSecond" scope="col">Method</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#addObjectPermission(org.apache.shiro.authz.Permission)">addObjectPermission</a></span>​(<a href="../authz/Permission.html" title="interface in org.apache.shiro.authz">Permission</a> permission)</code></th> |
| <td class="colLast"> |
| <div class="block">Assigns an object-based permission directly to this Account (not any of its realms).</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#addObjectPermissions(java.util.Collection)">addObjectPermissions</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util" class="externalLink">Collection</a><<a href="../authz/Permission.html" title="interface in org.apache.shiro.authz">Permission</a>> permissions)</code></th> |
| <td class="colLast"> |
| <div class="block">Assigns one or more object-based permissions directly to this Account (not any of its realms).</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#addRole(java.lang.String)">addRole</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> role)</code></th> |
| <td class="colLast"> |
| <div class="block">Adds a role to this Account's set of assigned roles.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#addRole(java.util.Collection)">addRole</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util" class="externalLink">Collection</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>> roles)</code></th> |
| <td class="colLast"> |
| <div class="block">Adds one or more roles to this Account's set of assigned roles.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#addStringPermission(java.lang.String)">addStringPermission</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> permission)</code></th> |
| <td class="colLast"> |
| <div class="block">Assigns a String-based permission directly to this Account (not to any of its realms).</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#addStringPermissions(java.util.Collection)">addStringPermissions</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util" class="externalLink">Collection</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>> permissions)</code></th> |
| <td class="colLast"> |
| <div class="block">Assigns one or more string-based permissions directly to this Account (not to any of its realms).</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#equals(java.lang.Object)">equals</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> o)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns <code>true</code> if the specified object is also a <a href="SimpleAccount.html" title="class in org.apache.shiro.authc"><code>SimpleAccount</code></a> and its |
| <a href="#getPrincipals()"><code>principals</code></a> are equal to this object's <code>principals</code>, <code>false</code> otherwise.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getCredentials()">getCredentials</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Simply returns <code>this.authcInfo.getCredentials</code>.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>org.apache.shiro.util.ByteSource</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getCredentialsSalt()">getCredentialsSalt</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the salt used to hash this Account's credentials (eg for password hashing), or <code>null</code> if no salt |
| was used or credentials were not hashed at all.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util" class="externalLink">Collection</a><<a href="../authz/Permission.html" title="interface in org.apache.shiro.authz">Permission</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getObjectPermissions()">getObjectPermissions</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns all object-based permissions assigned directly to this Account (not any of its realms).</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code><a href="../subject/PrincipalCollection.html" title="interface in org.apache.shiro.subject">PrincipalCollection</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getPrincipals()">getPrincipals</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the principals, aka the identifying attributes (username, user id, first name, last name, etc) of this |
| Account.</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util" class="externalLink">Collection</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getRoles()">getRoles</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns <code>this.authzInfo.getRoles();</code></div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util" class="externalLink">Collection</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getStringPermissions()">getStringPermissions</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns all String-based permissions assigned to this Account.</div> |
| </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#hashCode()">hashCode</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">If the <a href="#getPrincipals()"><code>principals</code></a> are not null, returns <code>principals.hashCode()</code>, otherwise |
| returns 0 (zero).</div> |
| </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isCredentialsExpired()">isCredentialsExpired</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns whether or not the Account's credentials are expired.</div> |
| </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isLocked()">isLocked</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns <code>true</code> if this Account is locked and thus cannot be used to login, <code>false</code> otherwise.</div> |
| </td> |
| </tr> |
| <tr id="i16" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#merge(org.apache.shiro.authc.AuthenticationInfo)">merge</a></span>​(<a href="AuthenticationInfo.html" title="interface in org.apache.shiro.authc">AuthenticationInfo</a> info)</code></th> |
| <td class="colLast"> |
| <div class="block">Merges the specified <code>AuthenticationInfo</code> into this <code>Account</code>.</div> |
| </td> |
| </tr> |
| <tr id="i17" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setCredentials(java.lang.Object)">setCredentials</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> credentials)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets this Account's credentials that verify one or more of the Account's |
| <a href="#getPrincipals()"><code>principals</code></a>, such as a password or private key.</div> |
| </td> |
| </tr> |
| <tr id="i18" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setCredentialsExpired(boolean)">setCredentialsExpired</a></span>​(boolean credentialsExpired)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets whether or not the Account's credentials are expired.</div> |
| </td> |
| </tr> |
| <tr id="i19" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setCredentialsSalt(org.apache.shiro.util.ByteSource)">setCredentialsSalt</a></span>​(org.apache.shiro.util.ByteSource salt)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets the salt to use to hash this Account's credentials (eg for password hashing), or <code>null</code> if no salt |
| is used or credentials are not hashed at all.</div> |
| </td> |
| </tr> |
| <tr id="i20" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setLocked(boolean)">setLocked</a></span>​(boolean locked)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets whether or not the account is locked and can be used to login.</div> |
| </td> |
| </tr> |
| <tr id="i21" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setObjectPermissions(java.util.Set)">setObjectPermissions</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util" class="externalLink">Set</a><<a href="../authz/Permission.html" title="interface in org.apache.shiro.authz">Permission</a>> permissions)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets all object-based permissions assigned directly to this Account (not any of its realms).</div> |
| </td> |
| </tr> |
| <tr id="i22" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setPrincipals(org.apache.shiro.subject.PrincipalCollection)">setPrincipals</a></span>​(<a href="../subject/PrincipalCollection.html" title="interface in org.apache.shiro.subject">PrincipalCollection</a> principals)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets the principals, aka the identifying attributes (username, user id, first name, last name, etc) of this |
| Account.</div> |
| </td> |
| </tr> |
| <tr id="i23" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setRoles(java.util.Set)">setRoles</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util" class="externalLink">Set</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>> roles)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets the Account's assigned roles.</div> |
| </td> |
| </tr> |
| <tr id="i24" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setStringPermissions(java.util.Set)">setStringPermissions</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util" class="externalLink">Set</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>> permissions)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets the String-based permissions assigned to this Account.</div> |
| </td> |
| </tr> |
| <tr id="i25" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#toString()">toString</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns <a href="#getPrincipals()"><code>principals</code></a>.toString() if they are not null, otherwise prints out the string |
| "empty"</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></h3> |
| <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang" class="externalLink">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang" class="externalLink">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang" class="externalLink">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang" class="externalLink">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang" class="externalLink">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait(long,int)" title="class or interface in java.lang" class="externalLink">wait</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a id="<init>()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>SimpleAccount</h4> |
| <pre>public <a href="../../../../src-html/org/apache/shiro/authc/SimpleAccount.html#line.73">SimpleAccount</a>()</pre> |
| <div class="block">Default no-argument constructor.</div> |
| </li> |
| </ul> |
| <a id="<init>(java.lang.Object,java.lang.Object,java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>SimpleAccount</h4> |
| <pre>public <a href="../../../../src-html/org/apache/shiro/authc/SimpleAccount.html#line.83">SimpleAccount</a>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> principal, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> credentials, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> realmName)</pre> |
| <div class="block">Constructs a SimpleAccount instance for the specified realm with the given principals and credentials.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>principal</code> - the 'primary' identifying attribute of the account, for example, a user id or username.</dd> |
| <dd><code>credentials</code> - the credentials that verify identity for the account</dd> |
| <dd><code>realmName</code> - the name of the realm that accesses this account data</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="<init>(java.lang.Object,java.lang.Object,org.apache.shiro.util.ByteSource,java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>SimpleAccount</h4> |
| <pre>public <a href="../../../../src-html/org/apache/shiro/authc/SimpleAccount.html#line.98">SimpleAccount</a>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> principal, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> hashedCredentials, |
| org.apache.shiro.util.ByteSource credentialsSalt, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> realmName)</pre> |
| <div class="block">Constructs a SimpleAccount instance for the specified realm with the given principals, hashedCredentials and |
| credentials salt used when hashing the credentials.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>principal</code> - the 'primary' identifying attribute of the account, for example, a user id or username.</dd> |
| <dd><code>hashedCredentials</code> - the credentials that verify identity for the account</dd> |
| <dd><code>credentialsSalt</code> - the salt used when hashing the credentials</dd> |
| <dd><code>realmName</code> - the name of the realm that accesses this account data</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.1</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="credential/HashedCredentialsMatcher.html" title="class in org.apache.shiro.authc.credential"><code>HashedCredentialsMatcher</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="<init>(java.util.Collection,java.lang.Object,java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>SimpleAccount</h4> |
| <pre>public <a href="../../../../src-html/org/apache/shiro/authc/SimpleAccount.html#line.111">SimpleAccount</a>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util" class="externalLink">Collection</a> principals, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> credentials, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> realmName)</pre> |
| <div class="block">Constructs a SimpleAccount instance for the specified realm with the given principals and credentials.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>principals</code> - the identifying attributes of the account, at least one of which should be considered the |
| account's 'primary' identifying attribute, for example, a user id or username.</dd> |
| <dd><code>credentials</code> - the credentials that verify identity for the account</dd> |
| <dd><code>realmName</code> - the name of the realm that accesses this account data</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="<init>(org.apache.shiro.subject.PrincipalCollection,java.lang.Object)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>SimpleAccount</h4> |
| <pre>public <a href="../../../../src-html/org/apache/shiro/authc/SimpleAccount.html#line.122">SimpleAccount</a>​(<a href="../subject/PrincipalCollection.html" title="interface in org.apache.shiro.subject">PrincipalCollection</a> principals, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> credentials)</pre> |
| <div class="block">Constructs a SimpleAccount instance for the specified principals and credentials.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>principals</code> - the identifying attributes of the account, at least one of which should be considered the |
| account's 'primary' identifying attribute, for example, a user id or username.</dd> |
| <dd><code>credentials</code> - the credentials that verify identity for the account</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="<init>(org.apache.shiro.subject.PrincipalCollection,java.lang.Object,org.apache.shiro.util.ByteSource)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>SimpleAccount</h4> |
| <pre>public <a href="../../../../src-html/org/apache/shiro/authc/SimpleAccount.html#line.137">SimpleAccount</a>​(<a href="../subject/PrincipalCollection.html" title="interface in org.apache.shiro.subject">PrincipalCollection</a> principals, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> hashedCredentials, |
| org.apache.shiro.util.ByteSource credentialsSalt)</pre> |
| <div class="block">Constructs a SimpleAccount instance for the specified principals and credentials.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>principals</code> - the identifying attributes of the account, at least one of which should be considered the |
| account's 'primary' identifying attribute, for example, a user id or username.</dd> |
| <dd><code>hashedCredentials</code> - the hashed credentials that verify identity for the account</dd> |
| <dd><code>credentialsSalt</code> - the salt used when hashing the credentials</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.1</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="credential/HashedCredentialsMatcher.html" title="class in org.apache.shiro.authc.credential"><code>HashedCredentialsMatcher</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="<init>(org.apache.shiro.subject.PrincipalCollection,java.lang.Object,java.util.Set)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>SimpleAccount</h4> |
| <pre>public <a href="../../../../src-html/org/apache/shiro/authc/SimpleAccount.html#line.150">SimpleAccount</a>​(<a href="../subject/PrincipalCollection.html" title="interface in org.apache.shiro.subject">PrincipalCollection</a> principals, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> credentials, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util" class="externalLink">Set</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>> roles)</pre> |
| <div class="block">Constructs a SimpleAccount instance for the specified principals and credentials, with the assigned roles.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>principals</code> - the identifying attributes of the account, at least one of which should be considered the |
| account's 'primary' identifying attribute, for example, a user id or username.</dd> |
| <dd><code>credentials</code> - the credentials that verify identity for the account</dd> |
| <dd><code>roles</code> - the names of the roles assigned to this account.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="<init>(java.lang.Object,java.lang.Object,java.lang.String,java.util.Set,java.util.Set)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>SimpleAccount</h4> |
| <pre>public <a href="../../../../src-html/org/apache/shiro/authc/SimpleAccount.html#line.165">SimpleAccount</a>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> principal, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> credentials, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> realmName, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util" class="externalLink">Set</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>> roleNames, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util" class="externalLink">Set</a><<a href="../authz/Permission.html" title="interface in org.apache.shiro.authz">Permission</a>> permissions)</pre> |
| <div class="block">Constructs a SimpleAccount instance for the specified realm with the given principal and credentials, with the |
| the assigned roles and permissions.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>principal</code> - the 'primary' identifying attributes of the account, for example, a user id or username.</dd> |
| <dd><code>credentials</code> - the credentials that verify identity for the account</dd> |
| <dd><code>realmName</code> - the name of the realm that accesses this account data</dd> |
| <dd><code>roleNames</code> - the names of the roles assigned to this account.</dd> |
| <dd><code>permissions</code> - the permissions assigned to this account directly (not those assigned to any of the realms).</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="<init>(java.util.Collection,java.lang.Object,java.lang.String,java.util.Set,java.util.Set)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>SimpleAccount</h4> |
| <pre>public <a href="../../../../src-html/org/apache/shiro/authc/SimpleAccount.html#line.182">SimpleAccount</a>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util" class="externalLink">Collection</a> principals, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> credentials, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> realmName, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util" class="externalLink">Set</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>> roleNames, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util" class="externalLink">Set</a><<a href="../authz/Permission.html" title="interface in org.apache.shiro.authz">Permission</a>> permissions)</pre> |
| <div class="block">Constructs a SimpleAccount instance for the specified realm with the given principals and credentials, with the |
| the assigned roles and permissions.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>principals</code> - the identifying attributes of the account, at least one of which should be considered the |
| account's 'primary' identifying attribute, for example, a user id or username.</dd> |
| <dd><code>credentials</code> - the credentials that verify identity for the account</dd> |
| <dd><code>realmName</code> - the name of the realm that accesses this account data</dd> |
| <dd><code>roleNames</code> - the names of the roles assigned to this account.</dd> |
| <dd><code>permissions</code> - the permissions assigned to this account directly (not those assigned to any of the realms).</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="<init>(org.apache.shiro.subject.PrincipalCollection,java.lang.Object,java.util.Set,java.util.Set)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>SimpleAccount</h4> |
| <pre>public <a href="../../../../src-html/org/apache/shiro/authc/SimpleAccount.html#line.198">SimpleAccount</a>​(<a href="../subject/PrincipalCollection.html" title="interface in org.apache.shiro.subject">PrincipalCollection</a> principals, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> credentials, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util" class="externalLink">Set</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>> roleNames, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util" class="externalLink">Set</a><<a href="../authz/Permission.html" title="interface in org.apache.shiro.authz">Permission</a>> permissions)</pre> |
| <div class="block">Constructs a SimpleAccount instance from the given principals and credentials, with the |
| the assigned roles and permissions.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>principals</code> - the identifying attributes of the account, at least one of which should be considered the |
| account's 'primary' identifying attribute, for example, a user id or username.</dd> |
| <dd><code>credentials</code> - the credentials that verify identity for the account</dd> |
| <dd><code>roleNames</code> - the names of the roles assigned to this account.</dd> |
| <dd><code>permissions</code> - the permissions assigned to this account directly (not those assigned to any of the realms).</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| <!-- ============ METHOD DETAIL ========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a id="getPrincipals()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPrincipals</h4> |
| <pre class="methodSignature">public <a href="../subject/PrincipalCollection.html" title="interface in org.apache.shiro.subject">PrincipalCollection</a> <a href="../../../../src-html/org/apache/shiro/authc/SimpleAccount.html#line.214">getPrincipals</a>()</pre> |
| <div class="block">Returns the principals, aka the identifying attributes (username, user id, first name, last name, etc) of this |
| Account.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="AuthenticationInfo.html#getPrincipals()">getPrincipals</a></code> in interface <code><a href="AuthenticationInfo.html" title="interface in org.apache.shiro.authc">AuthenticationInfo</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>all the principals, aka the identifying attributes, of this Account.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setPrincipals(org.apache.shiro.subject.PrincipalCollection)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setPrincipals</h4> |
| <pre class="methodSignature">public void <a href="../../../../src-html/org/apache/shiro/authc/SimpleAccount.html#line.225">setPrincipals</a>​(<a href="../subject/PrincipalCollection.html" title="interface in org.apache.shiro.subject">PrincipalCollection</a> principals)</pre> |
| <div class="block">Sets the principals, aka the identifying attributes (username, user id, first name, last name, etc) of this |
| Account.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>principals</code> - all the principals, aka the identifying attributes, of this Account.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="AuthenticationInfo.html#getPrincipals()"><code>AuthenticationInfo.getPrincipals()</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getCredentials()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCredentials</h4> |
| <pre class="methodSignature">public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> <a href="../../../../src-html/org/apache/shiro/authc/SimpleAccount.html#line.236">getCredentials</a>()</pre> |
| <div class="block">Simply returns <code>this.authcInfo.getCredentials</code>. The <code>authcInfo</code> attribute is constructed |
| via the constructors to wrap the input arguments.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="AuthenticationInfo.html#getCredentials()">getCredentials</a></code> in interface <code><a href="AuthenticationInfo.html" title="interface in org.apache.shiro.authc">AuthenticationInfo</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this Account's credentials.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setCredentials(java.lang.Object)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setCredentials</h4> |
| <pre class="methodSignature">public void <a href="../../../../src-html/org/apache/shiro/authc/SimpleAccount.html#line.247">setCredentials</a>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> credentials)</pre> |
| <div class="block">Sets this Account's credentials that verify one or more of the Account's |
| <a href="#getPrincipals()"><code>principals</code></a>, such as a password or private key.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>credentials</code> - the credentials associated with this Account that verify one or more of the Account principals.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="AuthenticationInfo.html#getCredentials()"><code>AuthenticationInfo.getCredentials()</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getCredentialsSalt()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCredentialsSalt</h4> |
| <pre class="methodSignature">public org.apache.shiro.util.ByteSource <a href="../../../../src-html/org/apache/shiro/authc/SimpleAccount.html#line.259">getCredentialsSalt</a>()</pre> |
| <div class="block">Returns the salt used to hash this Account's credentials (eg for password hashing), or <code>null</code> if no salt |
| was used or credentials were not hashed at all.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="SaltedAuthenticationInfo.html#getCredentialsSalt()">getCredentialsSalt</a></code> in interface <code><a href="SaltedAuthenticationInfo.html" title="interface in org.apache.shiro.authc">SaltedAuthenticationInfo</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the salt used to hash this Account's credentials (eg for password hashing), or <code>null</code> if no salt |
| was used or credentials were not hashed at all.</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.1</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setCredentialsSalt(org.apache.shiro.util.ByteSource)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setCredentialsSalt</h4> |
| <pre class="methodSignature">public void <a href="../../../../src-html/org/apache/shiro/authc/SimpleAccount.html#line.271">setCredentialsSalt</a>​(org.apache.shiro.util.ByteSource salt)</pre> |
| <div class="block">Sets the salt to use to hash this Account's credentials (eg for password hashing), or <code>null</code> if no salt |
| is used or credentials are not hashed at all.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>salt</code> - the salt to use to hash this Account's credentials (eg for password hashing), or <code>null</code> if no |
| salt is used or credentials are not hashed at all.</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.1</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getRoles()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getRoles</h4> |
| <pre class="methodSignature">public <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util" class="externalLink">Collection</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>> <a href="../../../../src-html/org/apache/shiro/authc/SimpleAccount.html#line.280">getRoles</a>()</pre> |
| <div class="block">Returns <code>this.authzInfo.getRoles();</code></div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../authz/AuthorizationInfo.html#getRoles()">getRoles</a></code> in interface <code><a href="../authz/AuthorizationInfo.html" title="interface in org.apache.shiro.authz">AuthorizationInfo</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the Account's assigned roles.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setRoles(java.util.Set)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setRoles</h4> |
| <pre class="methodSignature">public void <a href="../../../../src-html/org/apache/shiro/authc/SimpleAccount.html#line.290">setRoles</a>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util" class="externalLink">Set</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>> roles)</pre> |
| <div class="block">Sets the Account's assigned roles. Simply calls <code>this.authzInfo.setRoles(roles)</code>.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>roles</code> - the Account's assigned roles.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../authz/AuthorizationInfo.html#getRoles()"><code>AuthorizationInfo.getRoles()</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="addRole(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addRole</h4> |
| <pre class="methodSignature">public void <a href="../../../../src-html/org/apache/shiro/authc/SimpleAccount.html#line.300">addRole</a>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> role)</pre> |
| <div class="block">Adds a role to this Account's set of assigned roles. Simply delegates to |
| <code>this.authzInfo.addRole(role)</code>.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>role</code> - a role to assign to this Account.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="addRole(java.util.Collection)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addRole</h4> |
| <pre class="methodSignature">public void <a href="../../../../src-html/org/apache/shiro/authc/SimpleAccount.html#line.310">addRole</a>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util" class="externalLink">Collection</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>> roles)</pre> |
| <div class="block">Adds one or more roles to this Account's set of assigned roles. Simply delegates to |
| <code>this.authzInfo.addRoles(roles)</code>.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>roles</code> - one or more roles to assign to this Account.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getStringPermissions()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getStringPermissions</h4> |
| <pre class="methodSignature">public <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util" class="externalLink">Collection</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>> <a href="../../../../src-html/org/apache/shiro/authc/SimpleAccount.html#line.320">getStringPermissions</a>()</pre> |
| <div class="block">Returns all String-based permissions assigned to this Account. Simply delegates to |
| <code>this.authzInfo.getStringPermissions()</code>.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../authz/AuthorizationInfo.html#getStringPermissions()">getStringPermissions</a></code> in interface <code><a href="../authz/AuthorizationInfo.html" title="interface in org.apache.shiro.authz">AuthorizationInfo</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>all String-based permissions assigned to this Account.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setStringPermissions(java.util.Set)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setStringPermissions</h4> |
| <pre class="methodSignature">public void <a href="../../../../src-html/org/apache/shiro/authc/SimpleAccount.html#line.331">setStringPermissions</a>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util" class="externalLink">Set</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>> permissions)</pre> |
| <div class="block">Sets the String-based permissions assigned to this Account. Simply delegates to |
| <code>this.authzInfo.setStringPermissions(permissions)</code>.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>permissions</code> - all String-based permissions assigned to this Account.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../authz/AuthorizationInfo.html#getStringPermissions()"><code>AuthorizationInfo.getStringPermissions()</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="addStringPermission(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addStringPermission</h4> |
| <pre class="methodSignature">public void <a href="../../../../src-html/org/apache/shiro/authc/SimpleAccount.html#line.340">addStringPermission</a>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> permission)</pre> |
| <div class="block">Assigns a String-based permission directly to this Account (not to any of its realms).</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>permission</code> - the String-based permission to assign.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="addStringPermissions(java.util.Collection)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addStringPermissions</h4> |
| <pre class="methodSignature">public void <a href="../../../../src-html/org/apache/shiro/authc/SimpleAccount.html#line.349">addStringPermissions</a>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util" class="externalLink">Collection</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>> permissions)</pre> |
| <div class="block">Assigns one or more string-based permissions directly to this Account (not to any of its realms).</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>permissions</code> - one or more String-based permissions to assign.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getObjectPermissions()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getObjectPermissions</h4> |
| <pre class="methodSignature">public <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util" class="externalLink">Collection</a><<a href="../authz/Permission.html" title="interface in org.apache.shiro.authz">Permission</a>> <a href="../../../../src-html/org/apache/shiro/authc/SimpleAccount.html#line.358">getObjectPermissions</a>()</pre> |
| <div class="block">Returns all object-based permissions assigned directly to this Account (not any of its realms).</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../authz/AuthorizationInfo.html#getObjectPermissions()">getObjectPermissions</a></code> in interface <code><a href="../authz/AuthorizationInfo.html" title="interface in org.apache.shiro.authz">AuthorizationInfo</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>all object-based permissions assigned directly to this Account (not any of its realms).</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setObjectPermissions(java.util.Set)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setObjectPermissions</h4> |
| <pre class="methodSignature">public void <a href="../../../../src-html/org/apache/shiro/authc/SimpleAccount.html#line.367">setObjectPermissions</a>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util" class="externalLink">Set</a><<a href="../authz/Permission.html" title="interface in org.apache.shiro.authz">Permission</a>> permissions)</pre> |
| <div class="block">Sets all object-based permissions assigned directly to this Account (not any of its realms).</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>permissions</code> - the object-based permissions to assign directly to this Account.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="addObjectPermission(org.apache.shiro.authz.Permission)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addObjectPermission</h4> |
| <pre class="methodSignature">public void <a href="../../../../src-html/org/apache/shiro/authc/SimpleAccount.html#line.376">addObjectPermission</a>​(<a href="../authz/Permission.html" title="interface in org.apache.shiro.authz">Permission</a> permission)</pre> |
| <div class="block">Assigns an object-based permission directly to this Account (not any of its realms).</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>permission</code> - the object-based permission to assign directly to this Account (not any of its realms).</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="addObjectPermissions(java.util.Collection)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addObjectPermissions</h4> |
| <pre class="methodSignature">public void <a href="../../../../src-html/org/apache/shiro/authc/SimpleAccount.html#line.385">addObjectPermissions</a>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util" class="externalLink">Collection</a><<a href="../authz/Permission.html" title="interface in org.apache.shiro.authz">Permission</a>> permissions)</pre> |
| <div class="block">Assigns one or more object-based permissions directly to this Account (not any of its realms).</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>permissions</code> - one or more object-based permissions to assign directly to this Account (not any of its realms).</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="isLocked()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isLocked</h4> |
| <pre class="methodSignature">public boolean <a href="../../../../src-html/org/apache/shiro/authc/SimpleAccount.html#line.394">isLocked</a>()</pre> |
| <div class="block">Returns <code>true</code> if this Account is locked and thus cannot be used to login, <code>false</code> otherwise.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><code>true</code> if this Account is locked and thus cannot be used to login, <code>false</code> otherwise.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setLocked(boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setLocked</h4> |
| <pre class="methodSignature">public void <a href="../../../../src-html/org/apache/shiro/authc/SimpleAccount.html#line.403">setLocked</a>​(boolean locked)</pre> |
| <div class="block">Sets whether or not the account is locked and can be used to login.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>locked</code> - <code>true</code> if this Account is locked and thus cannot be used to login, <code>false</code> otherwise.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="isCredentialsExpired()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isCredentialsExpired</h4> |
| <pre class="methodSignature">public boolean <a href="../../../../src-html/org/apache/shiro/authc/SimpleAccount.html#line.413">isCredentialsExpired</a>()</pre> |
| <div class="block">Returns whether or not the Account's credentials are expired. This usually indicates that the Subject or an application |
| administrator would need to change the credentials before the account could be used.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>whether or not the Account's credentials are expired.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setCredentialsExpired(boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setCredentialsExpired</h4> |
| <pre class="methodSignature">public void <a href="../../../../src-html/org/apache/shiro/authc/SimpleAccount.html#line.424">setCredentialsExpired</a>​(boolean credentialsExpired)</pre> |
| <div class="block">Sets whether or not the Account's credentials are expired. A <code>true</code> value indicates that the Subject |
| or application administrator would need to change their credentials before the account could be used.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>credentialsExpired</code> - <code>true</code> if this Account's credentials are expired and need to be changed, |
| <code>false</code> otherwise.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="merge(org.apache.shiro.authc.AuthenticationInfo)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>merge</h4> |
| <pre class="methodSignature">public void <a href="../../../../src-html/org/apache/shiro/authc/SimpleAccount.html#line.438">merge</a>​(<a href="AuthenticationInfo.html" title="interface in org.apache.shiro.authc">AuthenticationInfo</a> info)</pre> |
| <div class="block">Merges the specified <code>AuthenticationInfo</code> into this <code>Account</code>. |
| <p/> |
| If the specified argument is also an instance of <a href="SimpleAccount.html" title="class in org.apache.shiro.authc"><code>SimpleAccount</code></a>, the |
| <a href="#isLocked()"><code>isLocked()</code></a> and <a href="#isCredentialsExpired()"><code>isCredentialsExpired()</code></a> attributes are merged (set on this instance) as well |
| (only if their values are <code>true</code>).</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="MergableAuthenticationInfo.html#merge(org.apache.shiro.authc.AuthenticationInfo)">merge</a></code> in interface <code><a href="MergableAuthenticationInfo.html" title="interface in org.apache.shiro.authc">MergableAuthenticationInfo</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>info</code> - the <code>AuthenticationInfo</code> to merge into this account.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="hashCode()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>hashCode</h4> |
| <pre class="methodSignature">public int <a href="../../../../src-html/org/apache/shiro/authc/SimpleAccount.html#line.460">hashCode</a>()</pre> |
| <div class="block">If the <a href="#getPrincipals()"><code>principals</code></a> are not null, returns <code>principals.hashCode()</code>, otherwise |
| returns 0 (zero).</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang" class="externalLink">hashCode</a></code> in class <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><code>principals.hashCode()</code> if they are not null, 0 (zero) otherwise.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="equals(java.lang.Object)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>equals</h4> |
| <pre class="methodSignature">public boolean <a href="../../../../src-html/org/apache/shiro/authc/SimpleAccount.html#line.472">equals</a>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> o)</pre> |
| <div class="block">Returns <code>true</code> if the specified object is also a <a href="SimpleAccount.html" title="class in org.apache.shiro.authc"><code>SimpleAccount</code></a> and its |
| <a href="#getPrincipals()"><code>principals</code></a> are equal to this object's <code>principals</code>, <code>false</code> otherwise.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang" class="externalLink">equals</a></code> in class <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>o</code> - the object to test for equality.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><code>true</code> if the specified object is also a <a href="SimpleAccount.html" title="class in org.apache.shiro.authc"><code>SimpleAccount</code></a> and its |
| <a href="#getPrincipals()"><code>principals</code></a> are equal to this object's <code>principals</code>, <code>false</code> otherwise.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="toString()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>toString</h4> |
| <pre class="methodSignature">public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> <a href="../../../../src-html/org/apache/shiro/authc/SimpleAccount.html#line.490">toString</a>()</pre> |
| <div class="block">Returns <a href="#getPrincipals()"><code>principals</code></a>.toString() if they are not null, otherwise prints out the string |
| "empty"</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang" class="externalLink">toString</a></code> in class <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the String representation of this Account object.</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </main> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <footer role="contentinfo"> |
| <nav role="navigation"> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a id="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/SimpleAccount.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../allclasses.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a id="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </nav> |
| <p class="legalCopy"><small>Copyright © 2004–2023 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </footer> |
| </body> |
| </html> |