| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <title>jakarta.security.enterprise.authentication.mechanism.http</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="jakarta.security.enterprise.authentication.mechanism.http"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| </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 class="navBarCell1Rev">Package</li> |
| <li>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="../../../../../../jakarta/security/enterprise/package-summary.html">Prev Package</a></li> |
| <li><a href="../../../../../../jakarta/security/enterprise/credential/package-summary.html">Next Package</a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?jakarta/security/enterprise/authentication/mechanism/http/package-summary.html" target="_top">Frames</a></li> |
| <li><a href="package-summary.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> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <div class="header"> |
| <h1 title="Package" class="title">Package jakarta.security.enterprise.authentication.mechanism.http</h1> |
| <div class="docSummary"> |
| <div class="block">The HTTP authentication mechanism API package.</div> |
| </div> |
| <p>See: <a href="#package.description">Description</a></p> |
| </div> |
| <div class="contentContainer"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Interface Summary table, listing interfaces, and an explanation"> |
| <caption><span>Interface Summary</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Interface</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../../jakarta/security/enterprise/authentication/mechanism/http/HttpAuthenticationMechanism.html" title="interface in jakarta.security.enterprise.authentication.mechanism.http">HttpAuthenticationMechanism</a></td> |
| <td class="colLast"> |
| <div class="block"><code>HttpAuthenticationMechanism</code> is a mechanism for obtaining a caller's |
| credentials in some way, using the HTTP protocol where necessary.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../../jakarta/security/enterprise/authentication/mechanism/http/HttpMessageContext.html" title="interface in jakarta.security.enterprise.authentication.mechanism.http">HttpMessageContext</a></td> |
| <td class="colLast"> |
| <div class="block"><code>HttpMessageContext</code> contains all of the per-request state information and encapsulates the client request, |
| server response, container handler for authentication callbacks, and the subject representing the caller.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| <li class="blockList"> |
| <table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Class Summary table, listing classes, and an explanation"> |
| <caption><span>Class Summary</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Class</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../../jakarta/security/enterprise/authentication/mechanism/http/AuthenticationParameters.html" title="class in jakarta.security.enterprise.authentication.mechanism.http">AuthenticationParameters</a></td> |
| <td class="colLast"> |
| <div class="block">Parameters that are provided along with an authentication request.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../../jakarta/security/enterprise/authentication/mechanism/http/HttpMessageContextWrapper.html" title="class in jakarta.security.enterprise.authentication.mechanism.http">HttpMessageContextWrapper</a></td> |
| <td class="colLast"> |
| <div class="block">This class is an implementation of the HttpMessageContext interface that |
| can be subclassed by developers wishing to provide extra or different |
| functionality.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| <li class="blockList"> |
| <table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Annotation Types Summary table, listing annotation types, and an explanation"> |
| <caption><span>Annotation Types Summary</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Annotation Type</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../../jakarta/security/enterprise/authentication/mechanism/http/AutoApplySession.html" title="annotation in jakarta.security.enterprise.authentication.mechanism.http">AutoApplySession</a></td> |
| <td class="colLast"> |
| <div class="block">The AutoApplySession annotation provides an application the ability to declaratively designate |
| that an authentication mechanism uses the <code>jakarta.servlet.http.registerSession</code> |
| and auto applies this for every request.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../../jakarta/security/enterprise/authentication/mechanism/http/BasicAuthenticationMechanismDefinition.html" title="annotation in jakarta.security.enterprise.authentication.mechanism.http">BasicAuthenticationMechanismDefinition</a></td> |
| <td class="colLast"> |
| <div class="block">Annotation used to define a container authentication mechanism that implements |
| the HTTP basic access authentication protocol as defined by the Servlet spec (13.6.1) |
| and make that implementation available as an enabled CDI bean.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../../jakarta/security/enterprise/authentication/mechanism/http/CustomFormAuthenticationMechanismDefinition.html" title="annotation in jakarta.security.enterprise.authentication.mechanism.http">CustomFormAuthenticationMechanismDefinition</a></td> |
| <td class="colLast"> |
| <div class="block">Annotation used to define a container authentication mechanism that implements |
| authentication resembling Servlet FORM authentication (Servlet spec 13.6.3).</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../../jakarta/security/enterprise/authentication/mechanism/http/FormAuthenticationMechanismDefinition.html" title="annotation in jakarta.security.enterprise.authentication.mechanism.http">FormAuthenticationMechanismDefinition</a></td> |
| <td class="colLast"> |
| <div class="block">Annotation used to define a container authentication mechanism that implements |
| FORM authentication as defined by the Servlet spec (13.6.3) and make that |
| implementation available as an enabled CDI bean.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../../jakarta/security/enterprise/authentication/mechanism/http/LoginToContinue.html" title="annotation in jakarta.security.enterprise.authentication.mechanism.http">LoginToContinue</a></td> |
| <td class="colLast"> |
| <div class="block">The <code>LoginToContinue</code> annotation provides an application the ability to declaratively |
| add login to continue functionality to an authentication mechanism.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../../jakarta/security/enterprise/authentication/mechanism/http/RememberMe.html" title="annotation in jakarta.security.enterprise.authentication.mechanism.http">RememberMe</a></td> |
| <td class="colLast"> |
| <div class="block">The RememberMe annotation provides an application the ability to declaratively designate |
| that an authentication mechanism effectively "remembers" the authentication and auto |
| applies this with every request.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| </ul> |
| <a name="package.description"> |
| <!-- --> |
| </a> |
| <h2 title="Package jakarta.security.enterprise.authentication.mechanism.http Description">Package jakarta.security.enterprise.authentication.mechanism.http Description</h2> |
| <div class="block">The HTTP authentication mechanism API package. This package |
| contains classes and interfaces associated with authentication |
| mechanisms that specifically target HTTP as environment to |
| interact with a caller (challenge/response, obtain credentials).</div> |
| </div> |
| <!-- ======= 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 class="navBarCell1Rev">Package</li> |
| <li>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="../../../../../../jakarta/security/enterprise/package-summary.html">Prev Package</a></li> |
| <li><a href="../../../../../../jakarta/security/enterprise/credential/package-summary.html">Next Package</a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?jakarta/security/enterprise/authentication/mechanism/http/package-summary.html" target="_top">Frames</a></li> |
| <li><a href="package-summary.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> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </body> |
| </html> |
