| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <title>ClientSecurity</title> |
| <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../../script.js"></script> |
| |
| <link rel="shortcut icon" href="/favicon.png"> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="ClientSecurity"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":9,"i1":9,"i2":9,"i3":9,"i4":9,"i5":9,"i6":9,"i7":9,"i8":9,"i9":9}; |
| var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],8:["t4","Concrete 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/client/ClientRuntimeException.html" title="class in org.apache.openejb.client"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/openejb/client/ClientSecurity.SimpleIdentityResolver.html" title="class in org.apache.openejb.client"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/openejb/client/ClientSecurity.html" target="_top">Frames</a></li> |
| <li><a href="ClientSecurity.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>Constr | </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>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.client</div> |
| <h2 title="Class ClientSecurity" class="title">Class ClientSecurity</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.openejb.client.ClientSecurity</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <br> |
| <pre>public class <span class="typeNameLabel">ClientSecurity</span> |
| extends java.lang.Object</pre> |
| </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="memberSummary" 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><span class="memberNameLink"><a href="../../../../org/apache/openejb/client/ClientSecurity.SimpleIdentityResolver.html" title="class in org.apache.openejb.client">ClientSecurity.SimpleIdentityResolver</a></span></code> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <table class="memberSummary" 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>static java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openejb/client/ClientSecurity.html#IDENTITY_RESOLVER_STRATEGY">IDENTITY_RESOLVER_STRATEGY</a></span></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="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="t1" class="tableTab"><span><a href="javascript:show(1);">Static 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="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code>static java.lang.Object</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openejb/client/ClientSecurity.html#directAuthentication-java.lang.String-java.lang.String-org.apache.openejb.client.ServerMetaData-">directAuthentication</a></span>(java.lang.String username, |
| java.lang.String password, |
| <a href="../../../../org/apache/openejb/client/ServerMetaData.html" title="class in org.apache.openejb.client">ServerMetaData</a> server)</code> |
| <div class="block">This is a helper method for login modules.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>static java.lang.Object</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openejb/client/ClientSecurity.html#directAuthentication-java.lang.String-java.lang.String-java.lang.String-org.apache.openejb.client.ServerMetaData-">directAuthentication</a></span>(java.lang.String securityRealm, |
| java.lang.String username, |
| java.lang.String password, |
| <a href="../../../../org/apache/openejb/client/ServerMetaData.html" title="class in org.apache.openejb.client">ServerMetaData</a> server)</code> </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>static java.lang.Object</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openejb/client/ClientSecurity.html#getIdentity--">getIdentity</a></span>()</code> </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>static <a href="../../../../org/apache/openejb/client/IdentityResolver.html" title="interface in org.apache.openejb.client">IdentityResolver</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openejb/client/ClientSecurity.html#getIdentityResolver--">getIdentityResolver</a></span>()</code> </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>static <a href="../../../../org/apache/openejb/client/ServerMetaData.html" title="class in org.apache.openejb.client">ServerMetaData</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openejb/client/ClientSecurity.html#getServer--">getServer</a></span>()</code> </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>static void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openejb/client/ClientSecurity.html#login-java.lang.String-java.lang.String-">login</a></span>(java.lang.String username, |
| java.lang.String password)</code> |
| <div class="block">Login the spedified user using the specified password.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>static void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openejb/client/ClientSecurity.html#login-java.lang.String-java.lang.String-boolean-">login</a></span>(java.lang.String username, |
| java.lang.String password, |
| boolean threadScoped)</code> |
| <div class="block">Login the spedified user using the specified password either globally for the |
| entire Java Virtural Machine or scoped to the thread.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>static void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openejb/client/ClientSecurity.html#logout--">logout</a></span>()</code> |
| <div class="block">Clears the thread and global login data.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>static void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openejb/client/ClientSecurity.html#setIdentityResolver-org.apache.openejb.client.IdentityResolver-">setIdentityResolver</a></span>(<a href="../../../../org/apache/openejb/client/IdentityResolver.html" title="interface in org.apache.openejb.client">IdentityResolver</a> identityResolver)</code> </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code>static void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openejb/client/ClientSecurity.html#setServer-org.apache.openejb.client.ServerMetaData-">setServer</a></span>(<a href="../../../../org/apache/openejb/client/ServerMetaData.html" title="class in org.apache.openejb.client">ServerMetaData</a> server)</code> </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.Object</h3> |
| <code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</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="IDENTITY_RESOLVER_STRATEGY"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>IDENTITY_RESOLVER_STRATEGY</h4> |
| <pre>public static final java.lang.String IDENTITY_RESOLVER_STRATEGY</pre> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../constant-values.html#org.apache.openejb.client.ClientSecurity.IDENTITY_RESOLVER_STRATEGY">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="getServer--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getServer</h4> |
| <pre>public static <a href="../../../../org/apache/openejb/client/ServerMetaData.html" title="class in org.apache.openejb.client">ServerMetaData</a> getServer()</pre> |
| </li> |
| </ul> |
| <a name="setServer-org.apache.openejb.client.ServerMetaData-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setServer</h4> |
| <pre>public static void setServer(<a href="../../../../org/apache/openejb/client/ServerMetaData.html" title="class in org.apache.openejb.client">ServerMetaData</a> server)</pre> |
| </li> |
| </ul> |
| <a name="login-java.lang.String-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>login</h4> |
| <pre>public static void login(java.lang.String username, |
| java.lang.String password) |
| throws javax.security.auth.login.FailedLoginException</pre> |
| <div class="block">Login the spedified user using the specified password. This is a global login for the |
| entire Java Virtural Machine. If you would like to have a thread scoped login, use |
| ClientSecurity.login(username, password, true); |
| </p> |
| This is the equivalent of ClientSecurity.login(username, password, false);</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>username</code> - the user to login</dd> |
| <dd><code>password</code> - the password for the user</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>javax.security.auth.login.FailedLoginException</code> - if the username and password combination are not valid or |
| if there is a problem communiating with the server</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="login-java.lang.String-java.lang.String-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>login</h4> |
| <pre>public static void login(java.lang.String username, |
| java.lang.String password, |
| boolean threadScoped) |
| throws javax.security.auth.login.FailedLoginException</pre> |
| <div class="block">Login the spedified user using the specified password either globally for the |
| entire Java Virtural Machine or scoped to the thread. |
| </p> |
| When using thread scoped login, you should logout in a finally block. This particularly |
| when using thread pools. If a thread is returned to the pool with a login attached to the |
| thread the next user of that thread will inherit the thread scoped login.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>username</code> - the user to login</dd> |
| <dd><code>password</code> - the password for the user</dd> |
| <dd><code>threadScoped</code> - if true the login is scoped to the thread; otherwise the login is global |
| for the entire Java Virtural Machine</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>javax.security.auth.login.FailedLoginException</code> - if the username and password combination are not valid or |
| if there is a problem communiating with the server</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="logout--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>logout</h4> |
| <pre>public static void logout()</pre> |
| <div class="block">Clears the thread and global login data.</div> |
| </li> |
| </ul> |
| <a name="directAuthentication-java.lang.String-java.lang.String-org.apache.openejb.client.ServerMetaData-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>directAuthentication</h4> |
| <pre>public static java.lang.Object directAuthentication(java.lang.String username, |
| java.lang.String password, |
| <a href="../../../../org/apache/openejb/client/ServerMetaData.html" title="class in org.apache.openejb.client">ServerMetaData</a> server) |
| throws javax.security.auth.login.FailedLoginException</pre> |
| <div class="block">This is a helper method for login modules. Directly authenticates with the server using the specified |
| username and password returning the identity token for the client. This methods does not store the |
| identity token and the caller must arrange for the to be available to the OpenEJB proxies via an |
| IdentityResolver.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>username</code> - the username for authentication</dd> |
| <dd><code>password</code> - the password for authentication</dd> |
| <dd><code>server</code> - ServerMetaData</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the client identity token</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>javax.security.auth.login.FailedLoginException</code> - if the username password combination is not valid</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="directAuthentication-java.lang.String-java.lang.String-java.lang.String-org.apache.openejb.client.ServerMetaData-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>directAuthentication</h4> |
| <pre>public static java.lang.Object directAuthentication(java.lang.String securityRealm, |
| java.lang.String username, |
| java.lang.String password, |
| <a href="../../../../org/apache/openejb/client/ServerMetaData.html" title="class in org.apache.openejb.client">ServerMetaData</a> server) |
| throws javax.security.auth.login.FailedLoginException</pre> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>javax.security.auth.login.FailedLoginException</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getIdentity--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getIdentity</h4> |
| <pre>public static java.lang.Object getIdentity()</pre> |
| </li> |
| </ul> |
| <a name="getIdentityResolver--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getIdentityResolver</h4> |
| <pre>public static <a href="../../../../org/apache/openejb/client/IdentityResolver.html" title="interface in org.apache.openejb.client">IdentityResolver</a> getIdentityResolver()</pre> |
| </li> |
| </ul> |
| <a name="setIdentityResolver-org.apache.openejb.client.IdentityResolver-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>setIdentityResolver</h4> |
| <pre>public static void setIdentityResolver(<a href="../../../../org/apache/openejb/client/IdentityResolver.html" title="interface in org.apache.openejb.client">IdentityResolver</a> identityResolver)</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> |
| <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/client/ClientRuntimeException.html" title="class in org.apache.openejb.client"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/openejb/client/ClientSecurity.SimpleIdentityResolver.html" title="class in org.apache.openejb.client"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/openejb/client/ClientSecurity.html" target="_top">Frames</a></li> |
| <li><a href="ClientSecurity.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>Constr | </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>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> |
