| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <title>SecurityService</title> |
| <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../../script.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="SecurityService"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <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="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><a href="../../../../org/apache/openejb/spi/ContainerSystem.html" title="interface in org.apache.openejb.spi"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/openejb/spi/Serializer.html" title="class in org.apache.openejb.spi"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/openejb/spi/SecurityService.html" target="_top">Frames</a></li> |
| <li><a href="SecurityService.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>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </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.openejb.spi</div> |
| <h2 title="Interface SecurityService" class="title">Interface SecurityService<T></h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Superinterfaces:</dt> |
| <dd><a href="../../../../org/apache/openejb/spi/Service.html" title="interface in org.apache.openejb.spi">Service</a></dd> |
| </dl> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><a href="../../../../org/apache/openejb/core/security/AbstractSecurityService.html" title="class in org.apache.openejb.core.security">AbstractSecurityService</a>, <a href="../../../../org/apache/openejb/ri/sp/PseudoSecurityService.html" title="class in org.apache.openejb.ri.sp">PseudoSecurityService</a>, <a href="../../../../org/apache/openejb/core/security/SecurityServiceImpl.html" title="class in org.apache.openejb.core.security">SecurityServiceImpl</a>, <a href="../../../../org/apache/tomee/catalina/TomcatSecurityService.html" title="class in org.apache.tomee.catalina">TomcatSecurityService</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <span class="typeNameLabel">SecurityService<T></span> |
| extends <a href="../../../../org/apache/openejb/spi/Service.html" title="interface in org.apache.openejb.spi">Service</a></pre> |
| <div class="block">The generic value T is any serializable token of the SecurityService |
| implementations choosing. This token only needs to be understandable |
| by the SecurityService internally and need not be a publicly usable class |
| type. No part of the outlying system will make any assumptions as to the |
| type of the object. The use of a java generic type is to express the |
| required symmetry in the interface.</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <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="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openejb/spi/SecurityService.html#associate-T-">associate</a></span>(<a href="../../../../org/apache/openejb/spi/SecurityService.html" title="type parameter in SecurityService">T</a> securityIdentity)</code> |
| <div class="block">Active</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>java.lang.Object</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openejb/spi/SecurityService.html#currentState--">currentState</a></span>()</code> </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/openejb/spi/SecurityService.html" title="type parameter in SecurityService">T</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openejb/spi/SecurityService.html#disassociate--">disassociate</a></span>()</code> |
| <div class="block">Active</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>java.security.Principal</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openejb/spi/SecurityService.html#getCallerPrincipal--">getCallerPrincipal</a></span>()</code> |
| <div class="block">Implementors are encouraged to return a java.security.Principal |
| object that implements org.apache.openejb.spi.CallerPrincipal |
| |
| JAAS LoginModule implementors are encouraged to use the CallerPrincipal |
| interface to denote the best fitting Principal for getCallerPrincipal.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openejb/spi/SecurityService.html#isCallerAuthorized-java.lang.reflect.Method-org.apache.openejb.InterfaceType-">isCallerAuthorized</a></span>(java.lang.reflect.Method method, |
| <a href="../../../../org/apache/openejb/InterfaceType.html" title="enum in org.apache.openejb">InterfaceType</a> type)</code> |
| <div class="block">Active</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openejb/spi/SecurityService.html#isCallerInRole-java.lang.String-">isCallerInRole</a></span>(java.lang.String role)</code> |
| <div class="block">Active</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/openejb/spi/SecurityService.html" title="type parameter in SecurityService">T</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openejb/spi/SecurityService.html#login-java.lang.String-java.lang.String-">login</a></span>(java.lang.String user, |
| java.lang.String pass)</code> </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/openejb/spi/SecurityService.html" title="type parameter in SecurityService">T</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openejb/spi/SecurityService.html#login-java.lang.String-java.lang.String-java.lang.String-">login</a></span>(java.lang.String securityRealm, |
| java.lang.String user, |
| java.lang.String pass)</code> </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openejb/spi/SecurityService.html#logout-T-">logout</a></span>(<a href="../../../../org/apache/openejb/spi/SecurityService.html" title="type parameter in SecurityService">T</a> securityIdentity)</code> |
| <div class="block">Active</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openejb/spi/SecurityService.html#onLogout-HttpServletRequest-">onLogout</a></span>(HttpServletRequest request)</code> |
| <div class="block">Called when request.logout() is triggered.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openejb/spi/SecurityService.html#setState-java.lang.Object-">setState</a></span>(java.lang.Object o)</code> </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.openejb.spi.Service"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.apache.openejb.spi.<a href="../../../../org/apache/openejb/spi/Service.html" title="interface in org.apache.openejb.spi">Service</a></h3> |
| <code><a href="../../../../org/apache/openejb/spi/Service.html#init-java.util.Properties-">init</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="login-java.lang.String-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>login</h4> |
| <pre><a href="../../../../org/apache/openejb/spi/SecurityService.html" title="type parameter in SecurityService">T</a> login(java.lang.String user, |
| java.lang.String pass) |
| throws javax.security.auth.login.LoginException</pre> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>javax.security.auth.login.LoginException</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="login-java.lang.String-java.lang.String-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>login</h4> |
| <pre><a href="../../../../org/apache/openejb/spi/SecurityService.html" title="type parameter in SecurityService">T</a> login(java.lang.String securityRealm, |
| java.lang.String user, |
| java.lang.String pass) |
| throws javax.security.auth.login.LoginException</pre> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>javax.security.auth.login.LoginException</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="associate-java.lang.Object-"> |
| <!-- --> |
| </a><a name="associate-T-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>associate</h4> |
| <pre>void associate(<a href="../../../../org/apache/openejb/spi/SecurityService.html" title="type parameter in SecurityService">T</a> securityIdentity) |
| throws javax.security.auth.login.LoginException</pre> |
| <div class="block">Active</div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>javax.security.auth.login.LoginException</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="disassociate--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>disassociate</h4> |
| <pre><a href="../../../../org/apache/openejb/spi/SecurityService.html" title="type parameter in SecurityService">T</a> disassociate()</pre> |
| <div class="block">Active</div> |
| </li> |
| </ul> |
| <a name="logout-java.lang.Object-"> |
| <!-- --> |
| </a><a name="logout-T-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>logout</h4> |
| <pre>void logout(<a href="../../../../org/apache/openejb/spi/SecurityService.html" title="type parameter in SecurityService">T</a> securityIdentity) |
| throws javax.security.auth.login.LoginException</pre> |
| <div class="block">Active</div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>javax.security.auth.login.LoginException</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isCallerInRole-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isCallerInRole</h4> |
| <pre>boolean isCallerInRole(java.lang.String role)</pre> |
| <div class="block">Active</div> |
| </li> |
| </ul> |
| <a name="getCallerPrincipal--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCallerPrincipal</h4> |
| <pre>java.security.Principal getCallerPrincipal()</pre> |
| <div class="block">Implementors are encouraged to return a java.security.Principal |
| object that implements org.apache.openejb.spi.CallerPrincipal |
| |
| JAAS LoginModule implementors are encouraged to use the CallerPrincipal |
| interface to denote the best fitting Principal for getCallerPrincipal.</div> |
| </li> |
| </ul> |
| <a name="isCallerAuthorized-java.lang.reflect.Method-org.apache.openejb.InterfaceType-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isCallerAuthorized</h4> |
| <pre>boolean isCallerAuthorized(java.lang.reflect.Method method, |
| <a href="../../../../org/apache/openejb/InterfaceType.html" title="enum in org.apache.openejb">InterfaceType</a> type)</pre> |
| <div class="block">Active</div> |
| </li> |
| </ul> |
| <a name="setState-java.lang.Object-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setState</h4> |
| <pre>void setState(java.lang.Object o)</pre> |
| </li> |
| </ul> |
| <a name="currentState--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>currentState</h4> |
| <pre>java.lang.Object currentState()</pre> |
| </li> |
| </ul> |
| <a name="onLogout-HttpServletRequest-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>onLogout</h4> |
| <pre>void onLogout(HttpServletRequest request)</pre> |
| <div class="block">Called when request.logout() is triggered. Intended to remove context propagation.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>request</code> - the http request triggering the logout.</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <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="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><a href="../../../../org/apache/openejb/spi/ContainerSystem.html" title="interface in org.apache.openejb.spi"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/openejb/spi/Serializer.html" title="class in org.apache.openejb.spi"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/openejb/spi/SecurityService.html" target="_top">Frames</a></li> |
| <li><a href="SecurityService.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>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </body> |
| </html> |
