| <!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 (1.8.0_101) on Mon Sep 19 17:02:02 EDT 2022 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>Authenticator (jUDDI Core Services 3.3.11-SNAPSHOT API)</title> |
| <meta name="date" content="2022-09-19"> |
| <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="Authenticator (jUDDI Core Services 3.3.11-SNAPSHOT API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6,"i1":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="class-use/Authenticator.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/juddi/v3/auth/AuthenticatorFactory.html" title="class in org.apache.juddi.v3.auth"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/juddi/v3/auth/Authenticator.html" target="_top">Frames</a></li> |
| <li><a href="Authenticator.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.juddi.v3.auth</div> |
| <h2 title="Interface Authenticator" class="title">Interface Authenticator</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><a href="../../../../../org/apache/juddi/v3/auth/CryptedXMLDocAuthenticator.html" title="class in org.apache.juddi.v3.auth">CryptedXMLDocAuthenticator</a>, <a href="../../../../../org/apache/juddi/v3/auth/HTTPContainerAuthenticator.html" title="class in org.apache.juddi.v3.auth">HTTPContainerAuthenticator</a>, <a href="../../../../../org/apache/juddi/v3/auth/HTTPHeaderAuthenticator.html" title="class in org.apache.juddi.v3.auth">HTTPHeaderAuthenticator</a>, <a href="../../../../../org/apache/juddi/v3/auth/JUDDIAuthenticator.html" title="class in org.apache.juddi.v3.auth">JUDDIAuthenticator</a>, <a href="../../../../../org/apache/juddi/v3/auth/LdapExpandedAuthenticator.html" title="class in org.apache.juddi.v3.auth">LdapExpandedAuthenticator</a>, <a href="../../../../../org/apache/juddi/v3/auth/LdapSimpleAuthenticator.html" title="class in org.apache.juddi.v3.auth">LdapSimpleAuthenticator</a>, <a href="../../../../../org/apache/juddi/v3/auth/MD5XMLDocAuthenticator.html" title="class in org.apache.juddi.v3.auth">MD5XMLDocAuthenticator</a>, <a href="../../../../../org/apache/juddi/v3/auth/XMLDocAuthenticator.html" title="class in org.apache.juddi.v3.auth">XMLDocAuthenticator</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <span class="typeNameLabel">Authenticator</span></pre> |
| <div class="block">Authenticator interface. Any class implementing this interface can be invoked by |
| the AuthenticatorFactory to handle authentication of the user executing a UDDI request. |
| |
| This occurs in two steps: |
| |
| 1) Authenticating the user based the passed credentials |
| 2) Identifying the user by associating either the authorizationKey or user Id with publisher information</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Author:</span></dt> |
| <dd>Steve Viens (sviens@apache.org), <a href="mailto:jfaath@apache.org">Jeff Faath</a></dd> |
| </dl> |
| </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><a href="https://docs.oracle.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><span class="memberNameLink"><a href="../../../../../org/apache/juddi/v3/auth/Authenticator.html#authenticate-java.lang.String-java.lang.String-">authenticate</a></span>(<a href="https://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> authorizedName, |
| <a href="https://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> cred)</code> |
| <div class="block">This function is called from the Security API's GetAuthToken().</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/juddi/model/UddiEntityPublisher.html" title="class in org.apache.juddi.model">UddiEntityPublisher</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juddi/v3/auth/Authenticator.html#identify-java.lang.String-java.lang.String-javax.xml.ws.WebServiceContext-">identify</a></span>(<a href="https://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> authInfo, |
| <a href="https://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> authorizedName, |
| <a href="https://docs.oracle.com/javase/6/docs/api/javax/xml/ws/WebServiceContext.html?is-external=true" title="class or interface in javax.xml.ws">WebServiceContext</a> ctx)</code> </td> |
| </tr> |
| </table> |
| </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="authenticate-java.lang.String-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>authenticate</h4> |
| <pre><a href="https://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> authenticate(<a href="https://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> authorizedName, |
| <a href="https://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> cred) |
| throws <a href="../../../../../org/apache/juddi/v3/error/AuthenticationException.html" title="class in org.apache.juddi.v3.error">AuthenticationException</a>, |
| <a href="../../../../../org/apache/juddi/v3/error/FatalErrorException.html" title="class in org.apache.juddi.v3.error">FatalErrorException</a></pre> |
| <div class="block">This function is called from the Security API's GetAuthToken().</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>authorizedName</code> - - userId of the user making the registry request</dd> |
| <dd><code>cred</code> - - some authentical creditial (i.e. a password) which can be used to |
| authenticate the user.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The publisherID for this user</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../../org/apache/juddi/v3/error/AuthenticationException.html" title="class in org.apache.juddi.v3.error">AuthenticationException</a></code></dd> |
| <dd><code><a href="../../../../../org/apache/juddi/v3/error/FatalErrorException.html" title="class in org.apache.juddi.v3.error">FatalErrorException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="identify-java.lang.String-java.lang.String-javax.xml.ws.WebServiceContext-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>identify</h4> |
| <pre><a href="../../../../../org/apache/juddi/model/UddiEntityPublisher.html" title="class in org.apache.juddi.model">UddiEntityPublisher</a> identify(<a href="https://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> authInfo, |
| <a href="https://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> authorizedName, |
| <a href="https://docs.oracle.com/javase/6/docs/api/javax/xml/ws/WebServiceContext.html?is-external=true" title="class or interface in javax.xml.ws">WebServiceContext</a> ctx) |
| throws <a href="../../../../../org/apache/juddi/v3/error/AuthenticationException.html" title="class in org.apache.juddi.v3.error">AuthenticationException</a>, |
| <a href="../../../../../org/apache/juddi/v3/error/FatalErrorException.html" title="class in org.apache.juddi.v3.error">FatalErrorException</a></pre> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../../org/apache/juddi/v3/error/AuthenticationException.html" title="class in org.apache.juddi.v3.error">AuthenticationException</a></code></dd> |
| <dd><code><a href="../../../../../org/apache/juddi/v3/error/FatalErrorException.html" title="class in org.apache.juddi.v3.error">FatalErrorException</a></code></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="class-use/Authenticator.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/juddi/v3/auth/AuthenticatorFactory.html" title="class in org.apache.juddi.v3.auth"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/juddi/v3/auth/Authenticator.html" target="_top">Frames</a></li> |
| <li><a href="Authenticator.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 ======= --> |
| <p class="legalCopy"><small>Copyright © 2004–2022 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </body> |
| </html> |
