| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <title>LoginToContinue</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="LoginToContinue"; |
| } |
| } |
| 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><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="../../../../../../javax/security/enterprise/authentication/mechanism/http/HttpMessageContextWrapper.html" title="class in javax.security.enterprise.authentication.mechanism.http"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../javax/security/enterprise/authentication/mechanism/http/RememberMe.html" title="annotation in javax.security.enterprise.authentication.mechanism.http"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?javax/security/enterprise/authentication/mechanism/http/LoginToContinue.html" target="_top">Frames</a></li> |
| <li><a href="LoginToContinue.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>Field | </li> |
| <li>Required | </li> |
| <li><a href="#annotation.type.optional.element.summary">Optional</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#annotation.type.element.detail">Element</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">javax.security.enterprise.authentication.mechanism.http</div> |
| <h2 title="Annotation Type LoginToContinue" class="title">Annotation Type LoginToContinue</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <br> |
| <pre>@Inherited |
| <a href="../../../../../../javax/interceptor/InterceptorBinding.html" title="annotation in javax.interceptor">@InterceptorBinding</a> |
| @Retention(value=RUNTIME) |
| @Target(value=TYPE) |
| public @interface <span class="memberNameLabel">LoginToContinue</span></pre> |
| <div class="block">The <code>LoginToContinue</code> annotation provides an application the ability to declaratively |
| add login to continue functionality to an authentication mechanism. |
| |
| <p> |
| When the <code>LoginToContinue</code> annotation is used on a custom authentication mechanism, EL |
| expressions in attributes of type <code>String</code> are evaluated for every request requiring |
| authentication. Both immediate and deferred syntax is supported, but effectively the semantics |
| are always deferred. |
| |
| <p> |
| When the <code>LoginToContinue</code> annotation is used as attribute in either the |
| <a href="../../../../../../javax/security/enterprise/authentication/mechanism/http/FormAuthenticationMechanismDefinition.html" title="annotation in javax.security.enterprise.authentication.mechanism.http"><code>FormAuthenticationMechanismDefinition</code></a> or <a href="../../../../../../javax/security/enterprise/authentication/mechanism/http/CustomFormAuthenticationMechanismDefinition.html" title="annotation in javax.security.enterprise.authentication.mechanism.http"><code>CustomFormAuthenticationMechanismDefinition</code></a>, |
| expressions using immediate syntax are evaluated only once when the <a href="../../../../../../javax/security/enterprise/authentication/mechanism/http/HttpAuthenticationMechanism.html" title="interface in javax.security.enterprise.authentication.mechanism.http"><code>HttpAuthenticationMechanism</code></a> |
| bean is created. Since these beans are application scoped, this means only once per application. |
| Expressions using deferred syntax are evaluated as described above when the <code>LoginToContinue</code> annotation |
| is used on a custom authentication mechanism.</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- =========== ANNOTATION TYPE OPTIONAL MEMBER SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="annotation.type.optional.element.summary"> |
| <!-- --> |
| </a> |
| <h3>Optional Element Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Optional Element Summary table, listing optional elements, and an explanation"> |
| <caption><span>Optional Elements</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Optional Element and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../javax/security/enterprise/authentication/mechanism/http/LoginToContinue.html#errorPage--">errorPage</a></span></code> |
| <div class="block">The resource (page) a caller should get to see in case an error, such as providing invalid |
| credentials, occurs on the page set by <a href="../../../../../../javax/security/enterprise/authentication/mechanism/http/LoginToContinue.html#loginPage--"><code>loginPage()</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../javax/security/enterprise/authentication/mechanism/http/LoginToContinue.html#loginPage--">loginPage</a></span></code> |
| <div class="block">The resource (page) a caller should get to see in case the originally requested |
| resource requires authentication, and the caller is currently not authenticated.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../javax/security/enterprise/authentication/mechanism/http/LoginToContinue.html#useForwardToLogin--">useForwardToLogin</a></span></code> |
| <div class="block">Use a forward to reach the page set by the <a href="../../../../../../javax/security/enterprise/authentication/mechanism/http/LoginToContinue.html#loginPage--"><code>loginPage()</code></a> |
| if true, otherwise use a redirect.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../javax/security/enterprise/authentication/mechanism/http/LoginToContinue.html#useForwardToLoginExpression--">useForwardToLoginExpression</a></span></code> |
| <div class="block">EL expression variant of <code>useForwardToLogin()</code>.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ ANNOTATION TYPE MEMBER DETAIL =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="annotation.type.element.detail"> |
| <!-- --> |
| </a> |
| <h3>Element Detail</h3> |
| <a name="loginPage--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>loginPage</h4> |
| <pre>public abstract java.lang.String loginPage</pre> |
| <div class="block">The resource (page) a caller should get to see in case the originally requested |
| resource requires authentication, and the caller is currently not authenticated.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>page a caller is directed to to authenticate (login)</dd> |
| </dl> |
| <dl> |
| <dt>Default:</dt> |
| <dd>"/login"</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="useForwardToLogin--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>useForwardToLogin</h4> |
| <pre>public abstract boolean useForwardToLogin</pre> |
| <div class="block">Use a forward to reach the page set by the <a href="../../../../../../javax/security/enterprise/authentication/mechanism/http/LoginToContinue.html#loginPage--"><code>loginPage()</code></a> |
| if true, otherwise use a redirect.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if a forward is to be used, false for a redirect</dd> |
| </dl> |
| <dl> |
| <dt>Default:</dt> |
| <dd>true</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="useForwardToLoginExpression--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>useForwardToLoginExpression</h4> |
| <pre>public abstract java.lang.String useForwardToLoginExpression</pre> |
| <div class="block">EL expression variant of <code>useForwardToLogin()</code>. |
| The expression needs to evaluate to a boolean outcome. All named CDI beans are available |
| to the expression. If both this attribute and <code>useForwardToLogin()</code> are specified, this |
| attribute take precedence.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>an expression evaluating to true if a forward is to be used, false for a redirect</dd> |
| </dl> |
| <dl> |
| <dt>Default:</dt> |
| <dd>""</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="errorPage--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>errorPage</h4> |
| <pre>public abstract java.lang.String errorPage</pre> |
| <div class="block">The resource (page) a caller should get to see in case an error, such as providing invalid |
| credentials, occurs on the page set by <a href="../../../../../../javax/security/enterprise/authentication/mechanism/http/LoginToContinue.html#loginPage--"><code>loginPage()</code></a>.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>page a caller is directed to after an authentication (login) error</dd> |
| </dl> |
| <dl> |
| <dt>Default:</dt> |
| <dd>"/login-error"</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="../../../../../../javax/security/enterprise/authentication/mechanism/http/HttpMessageContextWrapper.html" title="class in javax.security.enterprise.authentication.mechanism.http"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../javax/security/enterprise/authentication/mechanism/http/RememberMe.html" title="annotation in javax.security.enterprise.authentication.mechanism.http"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?javax/security/enterprise/authentication/mechanism/http/LoginToContinue.html" target="_top">Frames</a></li> |
| <li><a href="LoginToContinue.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>Field | </li> |
| <li>Required | </li> |
| <li><a href="#annotation.type.optional.element.summary">Optional</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#annotation.type.element.detail">Element</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </body> |
| </html> |
