| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> | |
| <!--NewPage--> | |
| <HTML> | |
| <HEAD> | |
| <!-- Generated by javadoc (build 1.5.0_05) on Thu Dec 08 16:09:31 KST 2005 --> | |
| <META http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> | |
| <TITLE> | |
| IoHandlerCommand (MINA 0.9.0 API) | |
| </TITLE> | |
| <META NAME="keywords" CONTENT="org.apache.mina.handler.chain.IoHandlerCommand interface"> | |
| <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style"> | |
| <SCRIPT type="text/javascript"> | |
| function windowTitle() | |
| { | |
| parent.document.title="IoHandlerCommand (MINA 0.9.0 API)"; | |
| } | |
| </SCRIPT> | |
| <NOSCRIPT> | |
| </NOSCRIPT> | |
| </HEAD> | |
| <BODY BGCOLOR="white" onload="windowTitle();"> | |
| <!-- ========= START OF TOP NAVBAR ======= --> | |
| <A NAME="navbar_top"><!-- --></A> | |
| <A HREF="#skip-navbar_top" title="Skip navigation links"></A> | |
| <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> | |
| <TR> | |
| <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> | |
| <A NAME="navbar_top_firstrow"><!-- --></A> | |
| <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> | |
| <TR ALIGN="center" VALIGN="top"> | |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> | |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> | |
| <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> | |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/IoHandlerCommand.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> | |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> | |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> | |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> | |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> | |
| </TR> | |
| </TABLE> | |
| </TD> | |
| <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> | |
| </EM> | |
| </TD> | |
| </TR> | |
| <TR> | |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> | |
| <A HREF="../../../../../org/apache/mina/handler/chain/IoHandlerChain.Entry.html" title="class in org.apache.mina.handler.chain"><B>PREV CLASS</B></A> | |
| <A HREF="../../../../../org/apache/mina/handler/chain/IoHandlerCommand.NextCommand.html" title="interface in org.apache.mina.handler.chain"><B>NEXT CLASS</B></A></FONT></TD> | |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> | |
| <A HREF="../../../../../index.html?org/apache/mina/handler/chain/IoHandlerCommand.html" target="_top"><B>FRAMES</B></A> | |
| <A HREF="IoHandlerCommand.html" target="_top"><B>NO FRAMES</B></A> | |
| <SCRIPT type="text/javascript"> | |
| <!-- | |
| if(window==top) { | |
| document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>'); | |
| } | |
| //--> | |
| </SCRIPT> | |
| <NOSCRIPT> | |
| <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A> | |
| </NOSCRIPT> | |
| </FONT></TD> | |
| </TR> | |
| <TR> | |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> | |
| SUMMARY: <A HREF="#nested_class_summary">NESTED</A> | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> | |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> | |
| DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD> | |
| </TR> | |
| </TABLE> | |
| <A NAME="skip-navbar_top"></A> | |
| <!-- ========= END OF TOP NAVBAR ========= --> | |
| <HR> | |
| <!-- ======== START OF CLASS DATA ======== --> | |
| <H2> | |
| <FONT SIZE="-1"> | |
| org.apache.mina.handler.chain</FONT> | |
| <BR> | |
| Interface IoHandlerCommand</H2> | |
| <DL> | |
| <DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../../../org/apache/mina/handler/chain/IoHandlerChain.html" title="class in org.apache.mina.handler.chain">IoHandlerChain</A></DD> | |
| </DL> | |
| <HR> | |
| <DL> | |
| <DT><PRE>public interface <B>IoHandlerCommand</B></DL> | |
| </PRE> | |
| <P> | |
| <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. To improve interoperability of <A HREF="../../../../../org/apache/mina/handler/chain/IoHandlerCommand.html" title="interface in org.apache.mina.handler.chain"><CODE>IoHandlerCommand</CODE></A> | |
| implementations, a useful design pattern is to expose the key values | |
| used as JavaBeans properties of the <A HREF="../../../../../org/apache/mina/handler/chain/IoHandlerCommand.html" title="interface in org.apache.mina.handler.chain"><CODE>IoHandlerCommand</CODE></A> implementation class | |
| itself. For example, a <A HREF="../../../../../org/apache/mina/handler/chain/IoHandlerCommand.html" title="interface in org.apache.mina.handler.chain"><CODE>IoHandlerCommand</CODE></A> that requires an input and an | |
| output key might implement the following properties:</p> | |
| <pre> | |
| private String inputKey = "input"; | |
| public String getInputKey() { | |
| return (this.inputKey); | |
| } | |
| public void setInputKey(String inputKey) { | |
| this.inputKey = inputKey; | |
| } | |
| private String outputKey = "output"; | |
| public String getOutputKey() { | |
| return (this.outputKey); | |
| } | |
| public void setOutputKey(String outputKey) { | |
| this.outputKey = outputKey; | |
| } | |
| </pre> | |
| <p>And the operation of accessing the "input" information in the context | |
| would be executed by calling:</p> | |
| <pre> | |
| String input = (String) session.getAttribute(getInputKey()); | |
| </pre> | |
| <p>instead of hard coding the attribute name. The use of the "Key" | |
| suffix on such property names is a useful convention to identify properties | |
| being used in this fashion, as opposed to JavaBeans properties that simply | |
| configure the internal operation of this <A HREF="../../../../../org/apache/mina/handler/chain/IoHandlerCommand.html" title="interface in org.apache.mina.handler.chain"><CODE>IoHandlerCommand</CODE></A>.</p> | |
| <P> | |
| <P> | |
| <DL> | |
| <DT><B>Version:</B></DT> | |
| <DD>$Rev: 355016 $, $Date: 2005-12-08 16:00:30 +0900 (Thu, 08 Dec 2005) $</DD> | |
| <DT><B>Author:</B></DT> | |
| <DD><a href="mailto:dev@directory.apache.org">Apache Directory Project</a></DD> | |
| </DL> | |
| <HR> | |
| <P> | |
| <!-- ======== NESTED CLASS SUMMARY ======== --> | |
| <A NAME="nested_class_summary"><!-- --></A> | |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> | |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> | |
| <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> | |
| <B>Nested Class Summary</B></FONT></TH> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE>static interface</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../../org/apache/mina/handler/chain/IoHandlerCommand.NextCommand.html" title="interface in org.apache.mina.handler.chain">IoHandlerCommand.NextCommand</A></B></CODE> | |
| <BR> | |
| 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>.</TD> | |
| </TR> | |
| </TABLE> | |
| | |
| <!-- ========== METHOD SUMMARY =========== --> | |
| <A NAME="method_summary"><!-- --></A> | |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> | |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> | |
| <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> | |
| <B>Method Summary</B></FONT></TH> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> void</CODE></FONT></TD> | |
| <TD><CODE><B><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></B>(<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, | |
| <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A> message)</CODE> | |
| <BR> | |
| Execute a unit of processing work to be performed.</TD> | |
| </TR> | |
| </TABLE> | |
| | |
| <P> | |
| <!-- ============ METHOD DETAIL ========== --> | |
| <A NAME="method_detail"><!-- --></A> | |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> | |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> | |
| <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> | |
| <B>Method Detail</B></FONT></TH> | |
| </TR> | |
| </TABLE> | |
| <A NAME="execute(org.apache.mina.handler.chain.IoHandlerCommand.NextCommand, org.apache.mina.common.IoSession, java.lang.Object)"><!-- --></A><H3> | |
| execute</H3> | |
| <PRE> | |
| void <B>execute</B>(<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, | |
| <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A> message) | |
| throws <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Exception.html" title="class or interface in java.lang">Exception</A></PRE> | |
| <DL> | |
| <DD><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>. | |
| <P> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><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><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><CODE>message</CODE> - the message object of this request | |
| <DT><B>Throws:</B> | |
| <DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Exception.html" title="class or interface in java.lang">Exception</A></CODE> - general purpose exception return | |
| to indicate abnormal termination</DL> | |
| </DD> | |
| </DL> | |
| <!-- ========= END OF CLASS DATA ========= --> | |
| <HR> | |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> | |
| <A NAME="navbar_bottom"><!-- --></A> | |
| <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> | |
| <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> | |
| <TR> | |
| <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> | |
| <A NAME="navbar_bottom_firstrow"><!-- --></A> | |
| <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> | |
| <TR ALIGN="center" VALIGN="top"> | |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> | |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> | |
| <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> | |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/IoHandlerCommand.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> | |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> | |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> | |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> | |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> | |
| </TR> | |
| </TABLE> | |
| </TD> | |
| <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> | |
| </EM> | |
| </TD> | |
| </TR> | |
| <TR> | |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> | |
| <A HREF="../../../../../org/apache/mina/handler/chain/IoHandlerChain.Entry.html" title="class in org.apache.mina.handler.chain"><B>PREV CLASS</B></A> | |
| <A HREF="../../../../../org/apache/mina/handler/chain/IoHandlerCommand.NextCommand.html" title="interface in org.apache.mina.handler.chain"><B>NEXT CLASS</B></A></FONT></TD> | |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> | |
| <A HREF="../../../../../index.html?org/apache/mina/handler/chain/IoHandlerCommand.html" target="_top"><B>FRAMES</B></A> | |
| <A HREF="IoHandlerCommand.html" target="_top"><B>NO FRAMES</B></A> | |
| <SCRIPT type="text/javascript"> | |
| <!-- | |
| if(window==top) { | |
| document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>'); | |
| } | |
| //--> | |
| </SCRIPT> | |
| <NOSCRIPT> | |
| <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A> | |
| </NOSCRIPT> | |
| </FONT></TD> | |
| </TR> | |
| <TR> | |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> | |
| SUMMARY: <A HREF="#nested_class_summary">NESTED</A> | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> | |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> | |
| DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD> | |
| </TR> | |
| </TABLE> | |
| <A NAME="skip-navbar_bottom"></A> | |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> | |
| <HR> | |
| Copyright © 2004-2005 . All Rights Reserved. | |
| </BODY> | |
| </HTML> |