| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (version 1.7.0_25) on Wed May 25 23:25:55 EDT 2016 --> |
| <meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> |
| <title>JdbcRealm (Apache Shiro 1.2.5 API)</title> |
| <meta name="date" content="2016-05-25"> |
| <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="JdbcRealm (Apache Shiro 1.2.5 API)"; |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar_top"> |
| <!-- --> |
| </a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/JdbcRealm.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"> |
| <li>Prev Class</li> |
| <li><a href="../../../../../org/apache/shiro/realm/jdbc/JdbcRealm.SaltStyle.html" title="enum in org.apache.shiro.realm.jdbc"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/shiro/realm/jdbc/JdbcRealm.html" target="_top">Frames</a></li> |
| <li><a href="JdbcRealm.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../allclasses-noframe.html">All Classes</a></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> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li><a href="#nested_class_summary">Nested</a> | </li> |
| <li><a href="#field_summary">Field</a> | </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><a href="#field_detail">Field</a> | </li> |
| <li><a href="#constructor_detail">Constr</a> | </li> |
| <li><a href="#method_detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip-navbar_top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.apache.shiro.realm.jdbc</div> |
| <h2 title="Class JdbcRealm" class="title">Class JdbcRealm</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="../../../../../org/apache/shiro/realm/CachingRealm.html" title="class in org.apache.shiro.realm">org.apache.shiro.realm.CachingRealm</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="../../../../../org/apache/shiro/realm/AuthenticatingRealm.html" title="class in org.apache.shiro.realm">org.apache.shiro.realm.AuthenticatingRealm</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="../../../../../org/apache/shiro/realm/AuthorizingRealm.html" title="class in org.apache.shiro.realm">org.apache.shiro.realm.AuthorizingRealm</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.shiro.realm.jdbc.JdbcRealm</li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><a href="../../../../../org/apache/shiro/authc/LogoutAware.html" title="interface in org.apache.shiro.authc">LogoutAware</a>, <a href="../../../../../org/apache/shiro/authz/Authorizer.html" title="interface in org.apache.shiro.authz">Authorizer</a>, <a href="../../../../../org/apache/shiro/authz/permission/PermissionResolverAware.html" title="interface in org.apache.shiro.authz.permission">PermissionResolverAware</a>, <a href="../../../../../org/apache/shiro/authz/permission/RolePermissionResolverAware.html" title="interface in org.apache.shiro.authz.permission">RolePermissionResolverAware</a>, <a href="../../../../../org/apache/shiro/cache/CacheManagerAware.html" title="interface in org.apache.shiro.cache">CacheManagerAware</a>, <a href="../../../../../org/apache/shiro/realm/Realm.html" title="interface in org.apache.shiro.realm">Realm</a>, <a href="../../../../../org/apache/shiro/util/Initializable.html" title="interface in org.apache.shiro.util">Initializable</a>, <a href="../../../../../org/apache/shiro/util/Nameable.html" title="interface in org.apache.shiro.util">Nameable</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public class <a href="../../../../../src-html/org/apache/shiro/realm/jdbc/JdbcRealm.html#line.57">JdbcRealm</a> |
| extends <a href="../../../../../org/apache/shiro/realm/AuthorizingRealm.html" title="class in org.apache.shiro.realm">AuthorizingRealm</a></pre> |
| <div class="block">Realm that allows authentication and authorization via JDBC calls. The default queries suggest a potential schema |
| for retrieving the user's password for authentication, and querying for a user's roles and permissions. The |
| default queries can be overridden by setting the query properties of the realm. |
| <p/> |
| If the default implementation |
| of authentication and authorization cannot handle your schema, this class can be subclassed and the |
| appropriate methods overridden. (usually <a href="../../../../../org/apache/shiro/realm/jdbc/JdbcRealm.html#doGetAuthenticationInfo(org.apache.shiro.authc.AuthenticationToken)"><code>doGetAuthenticationInfo(org.apache.shiro.authc.AuthenticationToken)</code></a>, |
| <a href="../../../../../org/apache/shiro/realm/jdbc/JdbcRealm.html#getRoleNamesForUser(java.sql.Connection, java.lang.String)"><code>getRoleNamesForUser(java.sql.Connection,String)</code></a>, and/or <a href="../../../../../org/apache/shiro/realm/jdbc/JdbcRealm.html#getPermissions(java.sql.Connection, java.lang.String, java.util.Collection)"><code>getPermissions(java.sql.Connection,String,java.util.Collection)</code></a> |
| <p/> |
| This realm supports caching by extending from <a href="../../../../../org/apache/shiro/realm/AuthorizingRealm.html" title="class in org.apache.shiro.realm"><code>AuthorizingRealm</code></a>.</div> |
| <dl><dt><span class="strong">Since:</span></dt> |
| <dd>0.2</dd></dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="nested_class_summary"> |
| <!-- --> |
| </a> |
| <h3>Nested Class Summary</h3> |
| <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation"> |
| <caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Class and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/shiro/realm/jdbc/JdbcRealm.SaltStyle.html" title="enum in org.apache.shiro.realm.jdbc">JdbcRealm.SaltStyle</a></strong></code> |
| <div class="block">Password hash salt configuration.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field_summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> |
| <caption><span>Fields</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Field and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected <a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/shiro/realm/jdbc/JdbcRealm.html#authenticationQuery">authenticationQuery</a></strong></code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected <a href="http://java.sun.com/javase/6/docs/api/javax/sql/DataSource.html?is-external=true" title="class or interface in javax.sql">DataSource</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/shiro/realm/jdbc/JdbcRealm.html#dataSource">dataSource</a></strong></code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected static <a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/shiro/realm/jdbc/JdbcRealm.html#DEFAULT_AUTHENTICATION_QUERY">DEFAULT_AUTHENTICATION_QUERY</a></strong></code> |
| <div class="block">The default query used to retrieve account data for the user.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected static <a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/shiro/realm/jdbc/JdbcRealm.html#DEFAULT_PERMISSIONS_QUERY">DEFAULT_PERMISSIONS_QUERY</a></strong></code> |
| <div class="block">The default query used to retrieve permissions that apply to a particular role.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected static <a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/shiro/realm/jdbc/JdbcRealm.html#DEFAULT_SALTED_AUTHENTICATION_QUERY">DEFAULT_SALTED_AUTHENTICATION_QUERY</a></strong></code> |
| <div class="block">The default query used to retrieve account data for the user when <a href="../../../../../org/apache/shiro/realm/jdbc/JdbcRealm.html#saltStyle"><code>saltStyle</code></a> is COLUMN.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected static <a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/shiro/realm/jdbc/JdbcRealm.html#DEFAULT_USER_ROLES_QUERY">DEFAULT_USER_ROLES_QUERY</a></strong></code> |
| <div class="block">The default query used to retrieve the roles that apply to a user.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/shiro/realm/jdbc/JdbcRealm.html#permissionsLookupEnabled">permissionsLookupEnabled</a></strong></code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected <a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/shiro/realm/jdbc/JdbcRealm.html#permissionsQuery">permissionsQuery</a></strong></code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected <a href="../../../../../org/apache/shiro/realm/jdbc/JdbcRealm.SaltStyle.html" title="enum in org.apache.shiro.realm.jdbc">JdbcRealm.SaltStyle</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/shiro/realm/jdbc/JdbcRealm.html#saltStyle">saltStyle</a></strong></code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected <a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/shiro/realm/jdbc/JdbcRealm.html#userRolesQuery">userRolesQuery</a></strong></code> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor_summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colOne" scope="col">Constructor and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><strong><a href="../../../../../org/apache/shiro/realm/jdbc/JdbcRealm.html#JdbcRealm()">JdbcRealm</a></strong>()</code> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method_summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span>Methods</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected <a href="../../../../../org/apache/shiro/authc/AuthenticationInfo.html" title="interface in org.apache.shiro.authc">AuthenticationInfo</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/shiro/realm/jdbc/JdbcRealm.html#doGetAuthenticationInfo(org.apache.shiro.authc.AuthenticationToken)">doGetAuthenticationInfo</a></strong>(<a href="../../../../../org/apache/shiro/authc/AuthenticationToken.html" title="interface in org.apache.shiro.authc">AuthenticationToken</a> token)</code> |
| <div class="block">Retrieves authentication data from an implementation-specific datasource (RDBMS, LDAP, etc) for the given |
| authentication token.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected <a href="../../../../../org/apache/shiro/authz/AuthorizationInfo.html" title="interface in org.apache.shiro.authz">AuthorizationInfo</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/shiro/realm/jdbc/JdbcRealm.html#doGetAuthorizationInfo(org.apache.shiro.subject.PrincipalCollection)">doGetAuthorizationInfo</a></strong>(<a href="../../../../../org/apache/shiro/subject/PrincipalCollection.html" title="interface in org.apache.shiro.subject">PrincipalCollection</a> principals)</code> |
| <div class="block">This implementation of the interface expects the principals collection to return a String username keyed off of |
| this realm's <a href="../../../../../org/apache/shiro/realm/CachingRealm.html#getName()"><code>name</code></a></div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected <a href="http://java.sun.com/javase/6/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><<a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/shiro/realm/jdbc/JdbcRealm.html#getPermissions(java.sql.Connection, java.lang.String, java.util.Collection)">getPermissions</a></strong>(<a href="http://java.sun.com/javase/6/docs/api/java/sql/Connection.html?is-external=true" title="class or interface in java.sql">Connection</a> conn, |
| <a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> username, |
| <a href="http://java.sun.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> roleNames)</code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected <a href="http://java.sun.com/javase/6/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><<a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/shiro/realm/jdbc/JdbcRealm.html#getRoleNamesForUser(java.sql.Connection, java.lang.String)">getRoleNamesForUser</a></strong>(<a href="http://java.sun.com/javase/6/docs/api/java/sql/Connection.html?is-external=true" title="class or interface in java.sql">Connection</a> conn, |
| <a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> username)</code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected <a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/shiro/realm/jdbc/JdbcRealm.html#getSaltForUser(java.lang.String)">getSaltForUser</a></strong>(<a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> username)</code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/shiro/realm/jdbc/JdbcRealm.html#setAuthenticationQuery(java.lang.String)">setAuthenticationQuery</a></strong>(<a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> authenticationQuery)</code> |
| <div class="block">Overrides the default query used to retrieve a user's password during authentication.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/shiro/realm/jdbc/JdbcRealm.html#setDataSource(javax.sql.DataSource)">setDataSource</a></strong>(<a href="http://java.sun.com/javase/6/docs/api/javax/sql/DataSource.html?is-external=true" title="class or interface in javax.sql">DataSource</a> dataSource)</code> |
| <div class="block">Sets the datasource that should be used to retrieve connections used by this realm.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/shiro/realm/jdbc/JdbcRealm.html#setPermissionsLookupEnabled(boolean)">setPermissionsLookupEnabled</a></strong>(boolean permissionsLookupEnabled)</code> |
| <div class="block">Enables lookup of permissions during authorization.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/shiro/realm/jdbc/JdbcRealm.html#setPermissionsQuery(java.lang.String)">setPermissionsQuery</a></strong>(<a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> permissionsQuery)</code> |
| <div class="block">Overrides the default query used to retrieve a user's permissions during authorization.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/shiro/realm/jdbc/JdbcRealm.html#setSaltStyle(org.apache.shiro.realm.jdbc.JdbcRealm.SaltStyle)">setSaltStyle</a></strong>(<a href="../../../../../org/apache/shiro/realm/jdbc/JdbcRealm.SaltStyle.html" title="enum in org.apache.shiro.realm.jdbc">JdbcRealm.SaltStyle</a> saltStyle)</code> |
| <div class="block">Sets the salt style.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/shiro/realm/jdbc/JdbcRealm.html#setUserRolesQuery(java.lang.String)">setUserRolesQuery</a></strong>(<a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> userRolesQuery)</code> |
| <div class="block">Overrides the default query used to retrieve a user's roles during authorization.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods_inherited_from_class_org.apache.shiro.realm.AuthorizingRealm"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.apache.shiro.realm.<a href="../../../../../org/apache/shiro/realm/AuthorizingRealm.html" title="class in org.apache.shiro.realm">AuthorizingRealm</a></h3> |
| <code><a href="../../../../../org/apache/shiro/realm/AuthorizingRealm.html#afterCacheManagerSet()">afterCacheManagerSet</a>, <a href="../../../../../org/apache/shiro/realm/AuthorizingRealm.html#checkPermission(org.apache.shiro.authz.Permission, org.apache.shiro.authz.AuthorizationInfo)">checkPermission</a>, <a href="../../../../../org/apache/shiro/realm/AuthorizingRealm.html#checkPermission(org.apache.shiro.subject.PrincipalCollection, org.apache.shiro.authz.Permission)">checkPermission</a>, <a href="../../../../../org/apache/shiro/realm/AuthorizingRealm.html#checkPermission(org.apache.shiro.subject.PrincipalCollection, java.lang.String)">checkPermission</a>, <a href="../../../../../org/apache/shiro/realm/AuthorizingRealm.html#checkPermissions(java.util.Collection, org.apache.shiro.authz.AuthorizationInfo)">checkPermissions</a>, <a href="../../../../../org/apache/shiro/realm/AuthorizingRealm.html#checkPermissions(org.apache.shiro.subject.PrincipalCollection, java.util.Collection)">checkPermissions</a>, <a href="../../../../../org/apache/shiro/realm/AuthorizingRealm.html#checkPermissions(org.apache.shiro.subject.PrincipalCollection, java.lang.String...)">checkPermissions</a>, <a href="../../../../../org/apache/shiro/realm/AuthorizingRealm.html#checkRole(org.apache.shiro.subject.PrincipalCollection, java.lang.String)">checkRole</a>, <a href="../../../../../org/apache/shiro/realm/AuthorizingRealm.html#checkRole(java.lang.String, org.apache.shiro.authz.AuthorizationInfo)">checkRole</a>, <a href="../../../../../org/apache/shiro/realm/AuthorizingRealm.html#checkRoles(java.util.Collection, org.apache.shiro.authz.AuthorizationInfo)">checkRoles</a>, <a href="../../../../../org/apache/shiro/realm/AuthorizingRealm.html#checkRoles(org.apache.shiro.subject.PrincipalCollection, java.util.Collection)">checkRoles</a>, <a href="../../../../../org/apache/shiro/realm/AuthorizingRealm.html#checkRoles(org.apache.shiro.subject.PrincipalCollection, java.lang.String...)">checkRoles</a>, <a href="../../../../../org/apache/shiro/realm/AuthorizingRealm.html#clearCachedAuthorizationInfo(org.apache.shiro.subject.PrincipalCollection)">clearCachedAuthorizationInfo</a>, <a href="../../../../../org/apache/shiro/realm/AuthorizingRealm.html#doClearCache(org.apache.shiro.subject.PrincipalCollection)">doClearCache</a>, <a href="../../../../../org/apache/shiro/realm/AuthorizingRealm.html#getAuthorizationCache()">getAuthorizationCache</a>, <a href="../../../../../org/apache/shiro/realm/AuthorizingRealm.html#getAuthorizationCacheKey(org.apache.shiro.subject.PrincipalCollection)">getAuthorizationCacheKey</a>, <a href="../../../../../org/apache/shiro/realm/AuthorizingRealm.html#getAuthorizationCacheName()">getAuthorizationCacheName</a>, <a href="../../../../../org/apache/shiro/realm/AuthorizingRealm.html#getAuthorizationInfo(org.apache.shiro.subject.PrincipalCollection)">getAuthorizationInfo</a>, <a href="../../../../../org/apache/shiro/realm/AuthorizingRealm.html#getPermissionResolver()">getPermissionResolver</a>, <a href="../../../../../org/apache/shiro/realm/AuthorizingRealm.html#getPermissions(org.apache.shiro.authz.AuthorizationInfo)">getPermissions</a>, <a href="../../../../../org/apache/shiro/realm/AuthorizingRealm.html#getRolePermissionResolver()">getRolePermissionResolver</a>, <a href="../../../../../org/apache/shiro/realm/AuthorizingRealm.html#hasAllRoles(org.apache.shiro.subject.PrincipalCollection, java.util.Collection)">hasAllRoles</a>, <a href="../../../../../org/apache/shiro/realm/AuthorizingRealm.html#hasRole(org.apache.shiro.subject.PrincipalCollection, java.lang.String)">hasRole</a>, <a href="../../../../../org/apache/shiro/realm/AuthorizingRealm.html#hasRole(java.lang.String, org.apache.shiro.authz.AuthorizationInfo)">hasRole</a>, <a href="../../../../../org/apache/shiro/realm/AuthorizingRealm.html#hasRoles(java.util.List, org.apache.shiro.authz.AuthorizationInfo)">hasRoles</a>, <a href="../../../../../org/apache/shiro/realm/AuthorizingRealm.html#hasRoles(org.apache.shiro.subject.PrincipalCollection, java.util.List)">hasRoles</a>, <a href="../../../../../org/apache/shiro/realm/AuthorizingRealm.html#isAuthorizationCachingEnabled()">isAuthorizationCachingEnabled</a>, <a href="../../../../../org/apache/shiro/realm/AuthorizingRealm.html#isPermitted(java.util.List, org.apache.shiro.authz.AuthorizationInfo)">isPermitted</a>, <a href="../../../../../org/apache/shiro/realm/AuthorizingRealm.html#isPermitted(org.apache.shiro.authz.Permission, org.apache.shiro.authz.AuthorizationInfo)">isPermitted</a>, <a href="../../../../../org/apache/shiro/realm/AuthorizingRealm.html#isPermitted(org.apache.shiro.subject.PrincipalCollection, java.util.List)">isPermitted</a>, <a href="../../../../../org/apache/shiro/realm/AuthorizingRealm.html#isPermitted(org.apache.shiro.subject.PrincipalCollection, org.apache.shiro.authz.Permission)">isPermitted</a>, <a href="../../../../../org/apache/shiro/realm/AuthorizingRealm.html#isPermitted(org.apache.shiro.subject.PrincipalCollection, java.lang.String...)">isPermitted</a>, <a href="../../../../../org/apache/shiro/realm/AuthorizingRealm.html#isPermitted(org.apache.shiro.subject.PrincipalCollection, java.lang.String)">isPermitted</a>, <a href="../../../../../org/apache/shiro/realm/AuthorizingRealm.html#isPermittedAll(java.util.Collection, org.apache.shiro.authz.AuthorizationInfo)">isPermittedAll</a>, <a href="../../../../../org/apache/shiro/realm/AuthorizingRealm.html#isPermittedAll(org.apache.shiro.subject.PrincipalCollection, java.util.Collection)">isPermittedAll</a>, <a href="../../../../../org/apache/shiro/realm/AuthorizingRealm.html#isPermittedAll(org.apache.shiro.subject.PrincipalCollection, java.lang.String...)">isPermittedAll</a>, <a href="../../../../../org/apache/shiro/realm/AuthorizingRealm.html#onInit()">onInit</a>, <a href="../../../../../org/apache/shiro/realm/AuthorizingRealm.html#setAuthorizationCache(org.apache.shiro.cache.Cache)">setAuthorizationCache</a>, <a href="../../../../../org/apache/shiro/realm/AuthorizingRealm.html#setAuthorizationCacheName(java.lang.String)">setAuthorizationCacheName</a>, <a href="../../../../../org/apache/shiro/realm/AuthorizingRealm.html#setAuthorizationCachingEnabled(boolean)">setAuthorizationCachingEnabled</a>, <a href="../../../../../org/apache/shiro/realm/AuthorizingRealm.html#setName(java.lang.String)">setName</a>, <a href="../../../../../org/apache/shiro/realm/AuthorizingRealm.html#setPermissionResolver(org.apache.shiro.authz.permission.PermissionResolver)">setPermissionResolver</a>, <a href="../../../../../org/apache/shiro/realm/AuthorizingRealm.html#setRolePermissionResolver(org.apache.shiro.authz.permission.RolePermissionResolver)">setRolePermissionResolver</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods_inherited_from_class_org.apache.shiro.realm.AuthenticatingRealm"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.apache.shiro.realm.<a href="../../../../../org/apache/shiro/realm/AuthenticatingRealm.html" title="class in org.apache.shiro.realm">AuthenticatingRealm</a></h3> |
| <code><a href="../../../../../org/apache/shiro/realm/AuthenticatingRealm.html#assertCredentialsMatch(org.apache.shiro.authc.AuthenticationToken, org.apache.shiro.authc.AuthenticationInfo)">assertCredentialsMatch</a>, <a href="../../../../../org/apache/shiro/realm/AuthenticatingRealm.html#clearCachedAuthenticationInfo(org.apache.shiro.subject.PrincipalCollection)">clearCachedAuthenticationInfo</a>, <a href="../../../../../org/apache/shiro/realm/AuthenticatingRealm.html#getAuthenticationCache()">getAuthenticationCache</a>, <a href="../../../../../org/apache/shiro/realm/AuthenticatingRealm.html#getAuthenticationCacheKey(org.apache.shiro.authc.AuthenticationToken)">getAuthenticationCacheKey</a>, <a href="../../../../../org/apache/shiro/realm/AuthenticatingRealm.html#getAuthenticationCacheKey(org.apache.shiro.subject.PrincipalCollection)">getAuthenticationCacheKey</a>, <a href="../../../../../org/apache/shiro/realm/AuthenticatingRealm.html#getAuthenticationCacheName()">getAuthenticationCacheName</a>, <a href="../../../../../org/apache/shiro/realm/AuthenticatingRealm.html#getAuthenticationInfo(org.apache.shiro.authc.AuthenticationToken)">getAuthenticationInfo</a>, <a href="../../../../../org/apache/shiro/realm/AuthenticatingRealm.html#getAuthenticationTokenClass()">getAuthenticationTokenClass</a>, <a href="../../../../../org/apache/shiro/realm/AuthenticatingRealm.html#getCredentialsMatcher()">getCredentialsMatcher</a>, <a href="../../../../../org/apache/shiro/realm/AuthenticatingRealm.html#init()">init</a>, <a href="../../../../../org/apache/shiro/realm/AuthenticatingRealm.html#isAuthenticationCachingEnabled()">isAuthenticationCachingEnabled</a>, <a href="../../../../../org/apache/shiro/realm/AuthenticatingRealm.html#isAuthenticationCachingEnabled(org.apache.shiro.authc.AuthenticationToken, org.apache.shiro.authc.AuthenticationInfo)">isAuthenticationCachingEnabled</a>, <a href="../../../../../org/apache/shiro/realm/AuthenticatingRealm.html#setAuthenticationCache(org.apache.shiro.cache.Cache)">setAuthenticationCache</a>, <a href="../../../../../org/apache/shiro/realm/AuthenticatingRealm.html#setAuthenticationCacheName(java.lang.String)">setAuthenticationCacheName</a>, <a href="../../../../../org/apache/shiro/realm/AuthenticatingRealm.html#setAuthenticationCachingEnabled(boolean)">setAuthenticationCachingEnabled</a>, <a href="../../../../../org/apache/shiro/realm/AuthenticatingRealm.html#setAuthenticationTokenClass(java.lang.Class)">setAuthenticationTokenClass</a>, <a href="../../../../../org/apache/shiro/realm/AuthenticatingRealm.html#setCredentialsMatcher(org.apache.shiro.authc.credential.CredentialsMatcher)">setCredentialsMatcher</a>, <a href="../../../../../org/apache/shiro/realm/AuthenticatingRealm.html#supports(org.apache.shiro.authc.AuthenticationToken)">supports</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods_inherited_from_class_org.apache.shiro.realm.CachingRealm"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.apache.shiro.realm.<a href="../../../../../org/apache/shiro/realm/CachingRealm.html" title="class in org.apache.shiro.realm">CachingRealm</a></h3> |
| <code><a href="../../../../../org/apache/shiro/realm/CachingRealm.html#clearCache(org.apache.shiro.subject.PrincipalCollection)">clearCache</a>, <a href="../../../../../org/apache/shiro/realm/CachingRealm.html#getAvailablePrincipal(org.apache.shiro.subject.PrincipalCollection)">getAvailablePrincipal</a>, <a href="../../../../../org/apache/shiro/realm/CachingRealm.html#getCacheManager()">getCacheManager</a>, <a href="../../../../../org/apache/shiro/realm/CachingRealm.html#getName()">getName</a>, <a href="../../../../../org/apache/shiro/realm/CachingRealm.html#isCachingEnabled()">isCachingEnabled</a>, <a href="../../../../../org/apache/shiro/realm/CachingRealm.html#onLogout(org.apache.shiro.subject.PrincipalCollection)">onLogout</a>, <a href="../../../../../org/apache/shiro/realm/CachingRealm.html#setCacheManager(org.apache.shiro.cache.CacheManager)">setCacheManager</a>, <a href="../../../../../org/apache/shiro/realm/CachingRealm.html#setCachingEnabled(boolean)">setCachingEnabled</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.<a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> |
| <code><a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a>, <a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods_inherited_from_class_org.apache.shiro.util.Initializable"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.apache.shiro.util.<a href="../../../../../org/apache/shiro/util/Initializable.html" title="interface in org.apache.shiro.util">Initializable</a></h3> |
| <code><a href="../../../../../org/apache/shiro/util/Initializable.html#init()">init</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field_detail"> |
| <!-- --> |
| </a> |
| <h3>Field Detail</h3> |
| <a name="DEFAULT_AUTHENTICATION_QUERY"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>DEFAULT_AUTHENTICATION_QUERY</h4> |
| <pre>protected static final <a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/shiro/realm/jdbc/JdbcRealm.html#line.67">DEFAULT_AUTHENTICATION_QUERY</a></pre> |
| <div class="block">The default query used to retrieve account data for the user.</div> |
| <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.shiro.realm.jdbc.JdbcRealm.DEFAULT_AUTHENTICATION_QUERY">Constant Field Values</a></dd></dl> |
| </li> |
| </ul> |
| <a name="DEFAULT_SALTED_AUTHENTICATION_QUERY"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>DEFAULT_SALTED_AUTHENTICATION_QUERY</h4> |
| <pre>protected static final <a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/shiro/realm/jdbc/JdbcRealm.html#line.72">DEFAULT_SALTED_AUTHENTICATION_QUERY</a></pre> |
| <div class="block">The default query used to retrieve account data for the user when <a href="../../../../../org/apache/shiro/realm/jdbc/JdbcRealm.html#saltStyle"><code>saltStyle</code></a> is COLUMN.</div> |
| <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.shiro.realm.jdbc.JdbcRealm.DEFAULT_SALTED_AUTHENTICATION_QUERY">Constant Field Values</a></dd></dl> |
| </li> |
| </ul> |
| <a name="DEFAULT_USER_ROLES_QUERY"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>DEFAULT_USER_ROLES_QUERY</h4> |
| <pre>protected static final <a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/shiro/realm/jdbc/JdbcRealm.html#line.77">DEFAULT_USER_ROLES_QUERY</a></pre> |
| <div class="block">The default query used to retrieve the roles that apply to a user.</div> |
| <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.shiro.realm.jdbc.JdbcRealm.DEFAULT_USER_ROLES_QUERY">Constant Field Values</a></dd></dl> |
| </li> |
| </ul> |
| <a name="DEFAULT_PERMISSIONS_QUERY"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>DEFAULT_PERMISSIONS_QUERY</h4> |
| <pre>protected static final <a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/shiro/realm/jdbc/JdbcRealm.html#line.82">DEFAULT_PERMISSIONS_QUERY</a></pre> |
| <div class="block">The default query used to retrieve permissions that apply to a particular role.</div> |
| <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.shiro.realm.jdbc.JdbcRealm.DEFAULT_PERMISSIONS_QUERY">Constant Field Values</a></dd></dl> |
| </li> |
| </ul> |
| <a name="dataSource"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>dataSource</h4> |
| <pre>protected <a href="http://java.sun.com/javase/6/docs/api/javax/sql/DataSource.html?is-external=true" title="class or interface in javax.sql">DataSource</a> <a href="../../../../../src-html/org/apache/shiro/realm/jdbc/JdbcRealm.html#line.99">dataSource</a></pre> |
| </li> |
| </ul> |
| <a name="authenticationQuery"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>authenticationQuery</h4> |
| <pre>protected <a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/shiro/realm/jdbc/JdbcRealm.html#line.101">authenticationQuery</a></pre> |
| </li> |
| </ul> |
| <a name="userRolesQuery"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>userRolesQuery</h4> |
| <pre>protected <a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/shiro/realm/jdbc/JdbcRealm.html#line.103">userRolesQuery</a></pre> |
| </li> |
| </ul> |
| <a name="permissionsQuery"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>permissionsQuery</h4> |
| <pre>protected <a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/shiro/realm/jdbc/JdbcRealm.html#line.105">permissionsQuery</a></pre> |
| </li> |
| </ul> |
| <a name="permissionsLookupEnabled"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>permissionsLookupEnabled</h4> |
| <pre>protected boolean <a href="../../../../../src-html/org/apache/shiro/realm/jdbc/JdbcRealm.html#line.107">permissionsLookupEnabled</a></pre> |
| </li> |
| </ul> |
| <a name="saltStyle"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>saltStyle</h4> |
| <pre>protected <a href="../../../../../org/apache/shiro/realm/jdbc/JdbcRealm.SaltStyle.html" title="enum in org.apache.shiro.realm.jdbc">JdbcRealm.SaltStyle</a> <a href="../../../../../src-html/org/apache/shiro/realm/jdbc/JdbcRealm.html#line.109">saltStyle</a></pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor_detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="JdbcRealm()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>JdbcRealm</h4> |
| <pre>public <a href="../../../../../src-html/org/apache/shiro/realm/jdbc/JdbcRealm.html#line.57">JdbcRealm</a>()</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method_detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="setDataSource(javax.sql.DataSource)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setDataSource</h4> |
| <pre>public void <a href="../../../../../src-html/org/apache/shiro/realm/jdbc/JdbcRealm.html#line.124">setDataSource</a>(<a href="http://java.sun.com/javase/6/docs/api/javax/sql/DataSource.html?is-external=true" title="class or interface in javax.sql">DataSource</a> dataSource)</pre> |
| <div class="block">Sets the datasource that should be used to retrieve connections used by this realm.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>dataSource</code> - the SQL data source.</dd></dl> |
| </li> |
| </ul> |
| <a name="setAuthenticationQuery(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setAuthenticationQuery</h4> |
| <pre>public void <a href="../../../../../src-html/org/apache/shiro/realm/jdbc/JdbcRealm.html#line.138">setAuthenticationQuery</a>(<a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> authenticationQuery)</pre> |
| <div class="block">Overrides the default query used to retrieve a user's password during authentication. When using the default |
| implementation, this query must take the user's username as a single parameter and return a single result |
| with the user's password as the first column. If you require a solution that does not match this query |
| structure, you can override <a href="../../../../../org/apache/shiro/realm/jdbc/JdbcRealm.html#doGetAuthenticationInfo(org.apache.shiro.authc.AuthenticationToken)"><code>doGetAuthenticationInfo(org.apache.shiro.authc.AuthenticationToken)</code></a> or |
| just <a href="../../../../../org/apache/shiro/realm/jdbc/JdbcRealm.html#getPasswordForUser(java.sql.Connection, java.lang.String)"><code>getPasswordForUser(java.sql.Connection,String)</code></a></div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>authenticationQuery</code> - the query to use for authentication.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../org/apache/shiro/realm/jdbc/JdbcRealm.html#DEFAULT_AUTHENTICATION_QUERY"><code>DEFAULT_AUTHENTICATION_QUERY</code></a></dd></dl> |
| </li> |
| </ul> |
| <a name="setUserRolesQuery(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setUserRolesQuery</h4> |
| <pre>public void <a href="../../../../../src-html/org/apache/shiro/realm/jdbc/JdbcRealm.html#line.152">setUserRolesQuery</a>(<a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> userRolesQuery)</pre> |
| <div class="block">Overrides the default query used to retrieve a user's roles during authorization. When using the default |
| implementation, this query must take the user's username as a single parameter and return a row |
| per role with a single column containing the role name. If you require a solution that does not match this query |
| structure, you can override <a href="../../../../../org/apache/shiro/realm/jdbc/JdbcRealm.html#doGetAuthorizationInfo(org.apache.shiro.subject.PrincipalCollection)"><code>doGetAuthorizationInfo(PrincipalCollection)</code></a> or just |
| <a href="../../../../../org/apache/shiro/realm/jdbc/JdbcRealm.html#getRoleNamesForUser(java.sql.Connection, java.lang.String)"><code>getRoleNamesForUser(java.sql.Connection,String)</code></a></div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>userRolesQuery</code> - the query to use for retrieving a user's roles.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../org/apache/shiro/realm/jdbc/JdbcRealm.html#DEFAULT_USER_ROLES_QUERY"><code>DEFAULT_USER_ROLES_QUERY</code></a></dd></dl> |
| </li> |
| </ul> |
| <a name="setPermissionsQuery(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setPermissionsQuery</h4> |
| <pre>public void <a href="../../../../../src-html/org/apache/shiro/realm/jdbc/JdbcRealm.html#line.171">setPermissionsQuery</a>(<a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> permissionsQuery)</pre> |
| <div class="block">Overrides the default query used to retrieve a user's permissions during authorization. When using the default |
| implementation, this query must take a role name as the single parameter and return a row |
| per permission with three columns containing the fully qualified name of the permission class, the permission |
| name, and the permission actions (in that order). If you require a solution that does not match this query |
| structure, you can override <a href="../../../../../org/apache/shiro/realm/jdbc/JdbcRealm.html#doGetAuthorizationInfo(org.apache.shiro.subject.PrincipalCollection)"><code>doGetAuthorizationInfo(org.apache.shiro.subject.PrincipalCollection)</code></a> or just |
| <a href="../../../../../org/apache/shiro/realm/jdbc/JdbcRealm.html#getPermissions(java.sql.Connection, java.lang.String, java.util.Collection)"><code>getPermissions(java.sql.Connection,String,java.util.Collection)</code></a></p> |
| <p/> |
| <b>Permissions are only retrieved if you set <a href="../../../../../org/apache/shiro/realm/jdbc/JdbcRealm.html#permissionsLookupEnabled"><code>permissionsLookupEnabled</code></a> to true. Otherwise, |
| this query is ignored.</b></div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>permissionsQuery</code> - the query to use for retrieving permissions for a role.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../org/apache/shiro/realm/jdbc/JdbcRealm.html#DEFAULT_PERMISSIONS_QUERY"><code>DEFAULT_PERMISSIONS_QUERY</code></a>, |
| <a href="../../../../../org/apache/shiro/realm/jdbc/JdbcRealm.html#setPermissionsLookupEnabled(boolean)"><code>setPermissionsLookupEnabled(boolean)</code></a></dd></dl> |
| </li> |
| </ul> |
| <a name="setPermissionsLookupEnabled(boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setPermissionsLookupEnabled</h4> |
| <pre>public void <a href="../../../../../src-html/org/apache/shiro/realm/jdbc/JdbcRealm.html#line.182">setPermissionsLookupEnabled</a>(boolean permissionsLookupEnabled)</pre> |
| <div class="block">Enables lookup of permissions during authorization. The default is "false" - meaning that only roles |
| are associated with a user. Set this to true in order to lookup roles <b>and</b> permissions.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>permissionsLookupEnabled</code> - true if permissions should be looked up during authorization, or false if only |
| roles should be looked up.</dd></dl> |
| </li> |
| </ul> |
| <a name="setSaltStyle(org.apache.shiro.realm.jdbc.JdbcRealm.SaltStyle)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setSaltStyle</h4> |
| <pre>public void <a href="../../../../../src-html/org/apache/shiro/realm/jdbc/JdbcRealm.html#line.191">setSaltStyle</a>(<a href="../../../../../org/apache/shiro/realm/jdbc/JdbcRealm.SaltStyle.html" title="enum in org.apache.shiro.realm.jdbc">JdbcRealm.SaltStyle</a> saltStyle)</pre> |
| <div class="block">Sets the salt style. See <a href="../../../../../org/apache/shiro/realm/jdbc/JdbcRealm.html#saltStyle"><code>saltStyle</code></a>.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>saltStyle</code> - new SaltStyle to set.</dd></dl> |
| </li> |
| </ul> |
| <a name="doGetAuthenticationInfo(org.apache.shiro.authc.AuthenticationToken)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>doGetAuthenticationInfo</h4> |
| <pre>protected <a href="../../../../../org/apache/shiro/authc/AuthenticationInfo.html" title="interface in org.apache.shiro.authc">AuthenticationInfo</a> <a href="../../../../../src-html/org/apache/shiro/realm/jdbc/JdbcRealm.html#line.202">doGetAuthenticationInfo</a>(<a href="../../../../../org/apache/shiro/authc/AuthenticationToken.html" title="interface in org.apache.shiro.authc">AuthenticationToken</a> token) |
| throws <a href="../../../../../org/apache/shiro/authc/AuthenticationException.html" title="class in org.apache.shiro.authc">AuthenticationException</a></pre> |
| <div class="block"><strong>Description copied from class: <code><a href="../../../../../org/apache/shiro/realm/AuthenticatingRealm.html#doGetAuthenticationInfo(org.apache.shiro.authc.AuthenticationToken)">AuthenticatingRealm</a></code></strong></div> |
| <div class="block">Retrieves authentication data from an implementation-specific datasource (RDBMS, LDAP, etc) for the given |
| authentication token. |
| <p/> |
| For most datasources, this means just 'pulling' authentication data for an associated subject/user and nothing |
| more and letting Shiro do the rest. But in some systems, this method could actually perform EIS specific |
| log-in logic in addition to just retrieving data - it is up to the Realm implementation. |
| <p/> |
| A <code>null</code> return value means that no account could be associated with the specified token.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../../org/apache/shiro/realm/AuthenticatingRealm.html#doGetAuthenticationInfo(org.apache.shiro.authc.AuthenticationToken)">doGetAuthenticationInfo</a></code> in class <code><a href="../../../../../org/apache/shiro/realm/AuthenticatingRealm.html" title="class in org.apache.shiro.realm">AuthenticatingRealm</a></code></dd> |
| <dt><span class="strong">Parameters:</span></dt><dd><code>token</code> - the authentication token containing the user's principal and credentials.</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>an <a href="../../../../../org/apache/shiro/authc/AuthenticationInfo.html" title="interface in org.apache.shiro.authc"><code>AuthenticationInfo</code></a> object containing account data resulting from the |
| authentication ONLY if the lookup is successful (i.e. account exists and is valid, etc.)</dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="../../../../../org/apache/shiro/authc/AuthenticationException.html" title="class in org.apache.shiro.authc">AuthenticationException</a></code> - if there is an error acquiring data or performing |
| realm-specific authentication logic for the specified <tt>token</tt></dd></dl> |
| </li> |
| </ul> |
| <a name="doGetAuthorizationInfo(org.apache.shiro.subject.PrincipalCollection)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>doGetAuthorizationInfo</h4> |
| <pre>protected <a href="../../../../../org/apache/shiro/authz/AuthorizationInfo.html" title="interface in org.apache.shiro.authz">AuthorizationInfo</a> <a href="../../../../../src-html/org/apache/shiro/realm/jdbc/JdbcRealm.html#line.317">doGetAuthorizationInfo</a>(<a href="../../../../../org/apache/shiro/subject/PrincipalCollection.html" title="interface in org.apache.shiro.subject">PrincipalCollection</a> principals)</pre> |
| <div class="block">This implementation of the interface expects the principals collection to return a String username keyed off of |
| this realm's <a href="../../../../../org/apache/shiro/realm/CachingRealm.html#getName()"><code>name</code></a></div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../../org/apache/shiro/realm/AuthorizingRealm.html#doGetAuthorizationInfo(org.apache.shiro.subject.PrincipalCollection)">doGetAuthorizationInfo</a></code> in class <code><a href="../../../../../org/apache/shiro/realm/AuthorizingRealm.html" title="class in org.apache.shiro.realm">AuthorizingRealm</a></code></dd> |
| <dt><span class="strong">Parameters:</span></dt><dd><code>principals</code> - the primary identifying principals of the AuthorizationInfo that should be retrieved.</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>the AuthorizationInfo associated with this principals.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../org/apache/shiro/realm/AuthorizingRealm.html#getAuthorizationInfo(org.apache.shiro.subject.PrincipalCollection)"><code>AuthorizingRealm.getAuthorizationInfo(org.apache.shiro.subject.PrincipalCollection)</code></a></dd></dl> |
| </li> |
| </ul> |
| <a name="getRoleNamesForUser(java.sql.Connection, java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getRoleNamesForUser</h4> |
| <pre>protected <a href="http://java.sun.com/javase/6/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><<a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> <a href="../../../../../src-html/org/apache/shiro/realm/jdbc/JdbcRealm.html#line.356">getRoleNamesForUser</a>(<a href="http://java.sun.com/javase/6/docs/api/java/sql/Connection.html?is-external=true" title="class or interface in java.sql">Connection</a> conn, |
| <a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> username) |
| throws <a href="http://java.sun.com/javase/6/docs/api/java/sql/SQLException.html?is-external=true" title="class or interface in java.sql">SQLException</a></pre> |
| <dl><dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="http://java.sun.com/javase/6/docs/api/java/sql/SQLException.html?is-external=true" title="class or interface in java.sql">SQLException</a></code></dd></dl> |
| </li> |
| </ul> |
| <a name="getPermissions(java.sql.Connection, java.lang.String, java.util.Collection)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPermissions</h4> |
| <pre>protected <a href="http://java.sun.com/javase/6/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><<a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> <a href="../../../../../src-html/org/apache/shiro/realm/jdbc/JdbcRealm.html#line.388">getPermissions</a>(<a href="http://java.sun.com/javase/6/docs/api/java/sql/Connection.html?is-external=true" title="class or interface in java.sql">Connection</a> conn, |
| <a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> username, |
| <a href="http://java.sun.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> roleNames) |
| throws <a href="http://java.sun.com/javase/6/docs/api/java/sql/SQLException.html?is-external=true" title="class or interface in java.sql">SQLException</a></pre> |
| <dl><dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="http://java.sun.com/javase/6/docs/api/java/sql/SQLException.html?is-external=true" title="class or interface in java.sql">SQLException</a></code></dd></dl> |
| </li> |
| </ul> |
| <a name="getSaltForUser(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getSaltForUser</h4> |
| <pre>protected <a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/shiro/realm/jdbc/JdbcRealm.html#line.423">getSaltForUser</a>(<a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> username)</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar_bottom"> |
| <!-- --> |
| </a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/JdbcRealm.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"> |
| <li>Prev Class</li> |
| <li><a href="../../../../../org/apache/shiro/realm/jdbc/JdbcRealm.SaltStyle.html" title="enum in org.apache.shiro.realm.jdbc"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/shiro/realm/jdbc/JdbcRealm.html" target="_top">Frames</a></li> |
| <li><a href="JdbcRealm.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../allclasses-noframe.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> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li><a href="#nested_class_summary">Nested</a> | </li> |
| <li><a href="#field_summary">Field</a> | </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><a href="#field_detail">Field</a> | </li> |
| <li><a href="#constructor_detail">Constr</a> | </li> |
| <li><a href="#method_detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip-navbar_bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <p class="legalCopy"><small>Copyright © 2004-2016 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.</small></p> |
| </body> |
| </html> |