blob: b4f0044777ef40a8c29ceff016ca720c1e578c5d [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<title>LogoutDefinition</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="/img/jakarta-favicon.ico">
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="LogoutDefinition";
}
}
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="../../../../../../../jakarta/security/enterprise/authentication/mechanism/http/openid/DisplayType.html" title="enum in jakarta.security.enterprise.authentication.mechanism.http.openid"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../../jakarta/security/enterprise/authentication/mechanism/http/openid/OpenIdConstant.html" title="interface in jakarta.security.enterprise.authentication.mechanism.http.openid"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../index.html?jakarta/security/enterprise/authentication/mechanism/http/openid/LogoutDefinition.html" target="_top">Frames</a></li>
<li><a href="LogoutDefinition.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Required&nbsp;|&nbsp;</li>
<li><a href="#annotation.type.optional.element.summary">Optional</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</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">jakarta.security.enterprise.authentication.mechanism.http.openid</div>
<h2 title="Annotation Type LogoutDefinition" class="title">Annotation Type LogoutDefinition</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>@Retention(value=RUNTIME)
public @interface <span class="memberNameLabel">LogoutDefinition</span></pre>
<div class="block"><a href="../../../../../../../jakarta/security/enterprise/authentication/mechanism/http/openid/LogoutDefinition.html" title="annotation in jakarta.security.enterprise.authentication.mechanism.http.openid"><code>LogoutDefinition</code></a> annotation defines logout and RP session management
configuration in openid connect client.</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">&nbsp;</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>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../jakarta/security/enterprise/authentication/mechanism/http/openid/LogoutDefinition.html#accessTokenExpiry--">accessTokenExpiry</a></span></code>
<div class="block">Session timeout on the expiry of Access Token.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../jakarta/security/enterprise/authentication/mechanism/http/openid/LogoutDefinition.html#accessTokenExpiryExpression--">accessTokenExpiryExpression</a></span></code>
<div class="block">Allow the session timeout definition using a Jakarta Expression Language expression.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../jakarta/security/enterprise/authentication/mechanism/http/openid/LogoutDefinition.html#identityTokenExpiry--">identityTokenExpiry</a></span></code>
<div class="block">Session timeout on the expiry of Identity Token.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../jakarta/security/enterprise/authentication/mechanism/http/openid/LogoutDefinition.html#identityTokenExpiryExpression--">identityTokenExpiryExpression</a></span></code>
<div class="block">Allow the session timeout using the Jakarta Expression Language expression.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../jakarta/security/enterprise/authentication/mechanism/http/openid/LogoutDefinition.html#notifyProvider--">notifyProvider</a></span></code>
<div class="block">Optional.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../jakarta/security/enterprise/authentication/mechanism/http/openid/LogoutDefinition.html#notifyProviderExpression--">notifyProviderExpression</a></span></code>
<div class="block">Optional.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../jakarta/security/enterprise/authentication/mechanism/http/openid/LogoutDefinition.html#redirectURI--">redirectURI</a></span></code>
<div class="block">Optional.</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="notifyProvider--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>notifyProvider</h4>
<pre>public abstract&nbsp;boolean&nbsp;notifyProvider</pre>
<div class="block">Optional. Notify the OIDC provider (OP) that the user has logged out of
the application and might want to log out of the OP as well. If true then
after having logged out the user from RP, redirects the End-User's User
Agent to the OP's logout endpoint URL. This URL is normally obtained via
the end_session_endpoint element of the OP's metadata or can be
customized via
<code>OpenIdProviderMetadata#endSessionEndpoint</code>.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true when OIDC provider is notified of logout.</dd>
</dl>
<dl>
<dt>Default:</dt>
<dd>false</dd>
</dl>
</li>
</ul>
</li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="notifyProviderExpression--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>notifyProviderExpression</h4>
<pre>public abstract&nbsp;java.lang.String&nbsp;notifyProviderExpression</pre>
<div class="block">Optional. Allows the OIDC provider (OP) notification that the user has logged
using the Jakarta Expression Language expression. If set, overrides the value set by notifyProvider.</div>
<dl>
<dt>Default:</dt>
<dd>""</dd>
</dl>
</li>
</ul>
</li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="redirectURI--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>redirectURI</h4>
<pre>public abstract&nbsp;java.lang.String&nbsp;redirectURI</pre>
<div class="block">Optional. The post logout redirect URI to which the RP is requesting that
the End-User's User Agent be redirected after a logout has been
performed. If redirect URI is empty then redirect to OpenID connect
provider authorization_endpoint for re-authentication.
*</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>URL after logout is performed on the client.</dd>
</dl>
<dl>
<dt>Default:</dt>
<dd>""</dd>
</dl>
</li>
</ul>
</li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="accessTokenExpiry--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>accessTokenExpiry</h4>
<pre>public abstract&nbsp;boolean&nbsp;accessTokenExpiry</pre>
<div class="block">Session timeout on the expiry of Access Token.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
</dl>
<dl>
<dt>Default:</dt>
<dd>false</dd>
</dl>
</li>
</ul>
</li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="accessTokenExpiryExpression--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>accessTokenExpiryExpression</h4>
<pre>public abstract&nbsp;java.lang.String&nbsp;accessTokenExpiryExpression</pre>
<div class="block">Allow the session timeout definition using a Jakarta Expression Language expression.
If set, overrides the value defined with accessTokenExpiry.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
</dl>
<dl>
<dt>Default:</dt>
<dd>""</dd>
</dl>
</li>
</ul>
</li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="identityTokenExpiry--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>identityTokenExpiry</h4>
<pre>public abstract&nbsp;boolean&nbsp;identityTokenExpiry</pre>
<div class="block">Session timeout on the expiry of Identity Token.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
</dl>
<dl>
<dt>Default:</dt>
<dd>false</dd>
</dl>
</li>
</ul>
</li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="identityTokenExpiryExpression--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>identityTokenExpiryExpression</h4>
<pre>public abstract&nbsp;java.lang.String&nbsp;identityTokenExpiryExpression</pre>
<div class="block">Allow the session timeout using the Jakarta Expression Language expression.
If set, overrides the identityTokenExpiry value.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
</dl>
<dl>
<dt>Default:</dt>
<dd>""</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="../../../../../../../jakarta/security/enterprise/authentication/mechanism/http/openid/DisplayType.html" title="enum in jakarta.security.enterprise.authentication.mechanism.http.openid"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../../jakarta/security/enterprise/authentication/mechanism/http/openid/OpenIdConstant.html" title="interface in jakarta.security.enterprise.authentication.mechanism.http.openid"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../index.html?jakarta/security/enterprise/authentication/mechanism/http/openid/LogoutDefinition.html" target="_top">Frames</a></li>
<li><a href="LogoutDefinition.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Required&nbsp;|&nbsp;</li>
<li><a href="#annotation.type.optional.element.summary">Optional</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</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>