blob: b33d0e1dcef272f9f12b55390dc371e41888f34f [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>ServletRequestAttributeListener</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="ServletRequestAttributeListener";
}
}
catch(err) {
}
//-->
var methods = {"i0":18,"i1":18,"i2":18};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],16:["t5","Default 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="../../jakarta/servlet/ServletRequestAttributeEvent.html" title="class in jakarta.servlet"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../jakarta/servlet/ServletRequestEvent.html" title="class in jakarta.servlet"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../index.html?jakarta/servlet/ServletRequestAttributeListener.html" target="_top">Frames</a></li>
<li><a href="ServletRequestAttributeListener.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>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</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">jakarta.servlet</div>
<h2 title="Interface ServletRequestAttributeListener" class="title">Interface ServletRequestAttributeListener</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Superinterfaces:</dt>
<dd>java.util.EventListener</dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">ServletRequestAttributeListener</span>
extends java.util.EventListener</pre>
<div class="block">Interface for receiving notification events about ServletRequest attribute changes.
<p>
Notifications will be generated while the request is within the scope of the web application. A ServletRequest is
defined as coming into scope of a web application when it is about to enter the first servlet or filter of the web
application, and as going out of scope when it exits the last servlet or the first filter in the chain.
<p>
In order to receive these notification events, the implementation class must be either declared in the deployment
descriptor of the web application, annotated with <a href="../../jakarta/servlet/annotation/WebListener.html" title="annotation in jakarta.servlet.annotation"><code>WebListener</code></a>, or registered via
one of the addListener methods defined on <a href="../../jakarta/servlet/ServletContext.html" title="interface in jakarta.servlet"><code>ServletContext</code></a>.
<p>
The order in which implementations of this interface are invoked is unspecified.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>Servlet 2.4</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">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t5" class="tableTab"><span><a href="javascript:show(16);">Default Methods</a></span><span class="tabEnd">&nbsp;</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>default void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../jakarta/servlet/ServletRequestAttributeListener.html#attributeAdded-jakarta.servlet.ServletRequestAttributeEvent-">attributeAdded</a></span>(<a href="../../jakarta/servlet/ServletRequestAttributeEvent.html" title="class in jakarta.servlet">ServletRequestAttributeEvent</a>&nbsp;srae)</code>
<div class="block">Receives notification that an attribute has been added to the ServletRequest.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>default void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../jakarta/servlet/ServletRequestAttributeListener.html#attributeRemoved-jakarta.servlet.ServletRequestAttributeEvent-">attributeRemoved</a></span>(<a href="../../jakarta/servlet/ServletRequestAttributeEvent.html" title="class in jakarta.servlet">ServletRequestAttributeEvent</a>&nbsp;srae)</code>
<div class="block">Receives notification that an attribute has been removed from the ServletRequest.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>default void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../jakarta/servlet/ServletRequestAttributeListener.html#attributeReplaced-jakarta.servlet.ServletRequestAttributeEvent-">attributeReplaced</a></span>(<a href="../../jakarta/servlet/ServletRequestAttributeEvent.html" title="class in jakarta.servlet">ServletRequestAttributeEvent</a>&nbsp;srae)</code>
<div class="block">Receives notification that an attribute has been replaced on the ServletRequest.</div>
</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="attributeAdded-jakarta.servlet.ServletRequestAttributeEvent-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>attributeAdded</h4>
<pre>default&nbsp;void&nbsp;attributeAdded(<a href="../../jakarta/servlet/ServletRequestAttributeEvent.html" title="class in jakarta.servlet">ServletRequestAttributeEvent</a>&nbsp;srae)</pre>
<div class="block">Receives notification that an attribute has been added to the ServletRequest.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>srae</code> - the ServletRequestAttributeEvent containing the ServletRequest and the name and value of the attribute
that was added</dd>
</dl>
</li>
</ul>
<a name="attributeRemoved-jakarta.servlet.ServletRequestAttributeEvent-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>attributeRemoved</h4>
<pre>default&nbsp;void&nbsp;attributeRemoved(<a href="../../jakarta/servlet/ServletRequestAttributeEvent.html" title="class in jakarta.servlet">ServletRequestAttributeEvent</a>&nbsp;srae)</pre>
<div class="block">Receives notification that an attribute has been removed from the ServletRequest.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>srae</code> - the ServletRequestAttributeEvent containing the ServletRequest and the name and value of the attribute
that was removed</dd>
</dl>
</li>
</ul>
<a name="attributeReplaced-jakarta.servlet.ServletRequestAttributeEvent-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>attributeReplaced</h4>
<pre>default&nbsp;void&nbsp;attributeReplaced(<a href="../../jakarta/servlet/ServletRequestAttributeEvent.html" title="class in jakarta.servlet">ServletRequestAttributeEvent</a>&nbsp;srae)</pre>
<div class="block">Receives notification that an attribute has been replaced on the ServletRequest.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>srae</code> - the ServletRequestAttributeEvent containing the ServletRequest and the name and (old) value of the
attribute that was replaced</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/servlet/ServletRequestAttributeEvent.html" title="class in jakarta.servlet"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../jakarta/servlet/ServletRequestEvent.html" title="class in jakarta.servlet"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../index.html?jakarta/servlet/ServletRequestAttributeListener.html" target="_top">Frames</a></li>
<li><a href="ServletRequestAttributeListener.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>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>