/usr/share/doc/libmina-java-doc/api/org/apache/mina/handler/chain/IoHandlerCommand.html is in libmina-java-doc 1.1.7.dfsg-11.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 | <!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 (version 1.7.0_25) on Wed Jul 03 23:15:08 UTC 2013 -->
<title>IoHandlerCommand</title>
<meta name="date" content="2013-07-03">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="IoHandlerCommand";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><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="../../../../../org/apache/mina/handler/chain/IoHandlerChain.Entry.html" title="class in org.apache.mina.handler.chain"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../org/apache/mina/handler/chain/IoHandlerCommand.NextCommand.html" title="interface in org.apache.mina.handler.chain"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/mina/handler/chain/IoHandlerCommand.html" target="_top">Frames</a></li>
<li><a href="IoHandlerCommand.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><a href="#nested_class_summary">Nested</a> | </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.mina.handler.chain</div>
<h2 title="Interface IoHandlerCommand" class="title">Interface IoHandlerCommand</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/mina/handler/chain/IoHandlerChain.html" title="class in org.apache.mina.handler.chain">IoHandlerChain</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="strong">IoHandlerCommand</span></pre>
<div class="block"><p>A <a href="../../../../../org/apache/mina/handler/chain/IoHandlerCommand.html" title="interface in org.apache.mina.handler.chain"><code>IoHandlerCommand</code></a> encapsulates a unit of processing work to be
performed, whose purpose is to examine and/or modify the state of a
transaction that is represented by custom attributes provided by
<a href="../../../../../org/apache/mina/common/IoSession.html" title="interface in org.apache.mina.common"><code>IoSession</code></a>. Individual <a href="../../../../../org/apache/mina/handler/chain/IoHandlerCommand.html" title="interface in org.apache.mina.handler.chain"><code>IoHandlerCommand</code></a>s can be assembled into
a <a href="../../../../../org/apache/mina/handler/chain/IoHandlerChain.html" title="class in org.apache.mina.handler.chain"><code>IoHandlerChain</code></a>, which allows them to either complete the
required processing or delegate further processing to the next
<a href="../../../../../org/apache/mina/handler/chain/IoHandlerCommand.html" title="interface in org.apache.mina.handler.chain"><code>IoHandlerCommand</code></a> in the <a href="../../../../../org/apache/mina/handler/chain/IoHandlerChain.html" title="class in org.apache.mina.handler.chain"><code>IoHandlerChain</code></a>.</p>
<p><a href="../../../../../org/apache/mina/handler/chain/IoHandlerCommand.html" title="interface in org.apache.mina.handler.chain"><code>IoHandlerCommand</code></a> implementations typically retrieve and store state
information in the <a href="../../../../../org/apache/mina/common/IoSession.html" title="interface in org.apache.mina.common"><code>IoSession</code></a> that is passed as a parameter to
the <a href="../../../../../org/apache/mina/handler/chain/IoHandlerCommand.html#execute(org.apache.mina.handler.chain.IoHandlerCommand.NextCommand, org.apache.mina.common.IoSession, java.lang.Object)"><code>execute(NextCommand,IoSession,Object)</code></a> method, using custom
session attributes. If you think getting attributes is tedious process,
you can create a bean which contains getters and setters of all properties
and store the bean as a session attribute:</p>
<pre>
public class MyContext {
public String getPropertyX() { ... };
public void setPropertyX(String propertyX) { ... };
public int getPropertyZ() { ... };
public void setPropertyZ(int propertyZ) { ... };
}
public class MyHandlderCommand implements IoHandlerCommand {
public void execute( NextCommand next, IoSession session, Object message ) throws Exception {
MyContext ctx = session.getAttribute( "mycontext" );
...
}
}
</pre></div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="nested_class_summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation">
<caption><span>Nested Classes</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Interface and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static interface </code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/mina/handler/chain/IoHandlerCommand.NextCommand.html" title="interface in org.apache.mina.handler.chain">IoHandlerCommand.NextCommand</a></strong></code>
<div class="block">Represents an indirect reference to the next <a href="../../../../../org/apache/mina/handler/chain/IoHandlerCommand.html" title="interface in org.apache.mina.handler.chain"><code>IoHandlerCommand</code></a> of
the <a href="../../../../../org/apache/mina/handler/chain/IoHandlerChain.html" title="class in org.apache.mina.handler.chain"><code>IoHandlerChain</code></a>.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/mina/handler/chain/IoHandlerCommand.html#execute(org.apache.mina.handler.chain.IoHandlerCommand.NextCommand, org.apache.mina.common.IoSession, java.lang.Object)">execute</a></strong>(<a href="../../../../../org/apache/mina/handler/chain/IoHandlerCommand.NextCommand.html" title="interface in org.apache.mina.handler.chain">IoHandlerCommand.NextCommand</a> next,
<a href="../../../../../org/apache/mina/common/IoSession.html" title="interface in org.apache.mina.common">IoSession</a> session,
java.lang.Object message)</code>
<div class="block">Execute a unit of processing work to be performed.</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="execute(org.apache.mina.handler.chain.IoHandlerCommand.NextCommand, org.apache.mina.common.IoSession, java.lang.Object)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>execute</h4>
<pre>void execute(<a href="../../../../../org/apache/mina/handler/chain/IoHandlerCommand.NextCommand.html" title="interface in org.apache.mina.handler.chain">IoHandlerCommand.NextCommand</a> next,
<a href="../../../../../org/apache/mina/common/IoSession.html" title="interface in org.apache.mina.common">IoSession</a> session,
java.lang.Object message)
throws java.lang.Exception</pre>
<div class="block"><p>Execute a unit of processing work to be performed. This
<a href="../../../../../org/apache/mina/handler/chain/IoHandlerCommand.html" title="interface in org.apache.mina.handler.chain"><code>IoHandlerCommand</code></a> may either complete the required processing
and just return to stop the processing, or delegate remaining
processing to the next <a href="../../../../../org/apache/mina/handler/chain/IoHandlerCommand.html" title="interface in org.apache.mina.handler.chain"><code>IoHandlerCommand</code></a> in a <a href="../../../../../org/apache/mina/handler/chain/IoHandlerChain.html" title="class in org.apache.mina.handler.chain"><code>IoHandlerChain</code></a>
containing this <a href="../../../../../org/apache/mina/handler/chain/IoHandlerCommand.html" title="interface in org.apache.mina.handler.chain"><code>IoHandlerCommand</code></a> by calling
<a href="../../../../../org/apache/mina/handler/chain/IoHandlerCommand.NextCommand.html#execute(org.apache.mina.common.IoSession, java.lang.Object)"><code>IoHandlerCommand.NextCommand.execute(IoSession,Object)</code></a>.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>next</code> - an indirect reference to the next <a href="../../../../../org/apache/mina/handler/chain/IoHandlerCommand.html" title="interface in org.apache.mina.handler.chain"><code>IoHandlerCommand</code></a> that
provides a way to forward the request to the next <a href="../../../../../org/apache/mina/handler/chain/IoHandlerCommand.html" title="interface in org.apache.mina.handler.chain"><code>IoHandlerCommand</code></a>.</dd><dd><code>session</code> - the <a href="../../../../../org/apache/mina/common/IoSession.html" title="interface in org.apache.mina.common"><code>IoSession</code></a> which is associated with
this request</dd><dd><code>message</code> - the message object of this request</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.Exception</code> - general purpose exception return
to indicate abnormal termination</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><a href="#skip-navbar_bottom" title="Skip navigation links"></a><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="../../../../../org/apache/mina/handler/chain/IoHandlerChain.Entry.html" title="class in org.apache.mina.handler.chain"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../org/apache/mina/handler/chain/IoHandlerCommand.NextCommand.html" title="interface in org.apache.mina.handler.chain"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/mina/handler/chain/IoHandlerCommand.html" target="_top">Frames</a></li>
<li><a href="IoHandlerCommand.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><a href="#nested_class_summary">Nested</a> | </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 ======= -->
</body>
</html>
|