org.apache.mina.protocol

Class ProtocolHandlerAdapter

java.lang.Object

org.apache.mina.protocol.ProtocolHandlerAdapter

All Implemented Interfaces:

ProtocolHandler

Direct Known Subclasses:

DemuxingProtocolHandler

public class ProtocolHandlerAdapter
extends java.lang.Object
implements ProtocolHandler

An abstract adapter class for ProtocolHandler. You can extend this class and selectively override required event handler methods only. All methods do nothing by default.

Version:

$Rev: 326586 $, $Date: 2005-10-19 17:50:29 +0200 (Wed, 19 Oct 2005) $

Author:

The Apache Directory Project (dev@directory.apache.org)

Constructor Summary

Constructors

Constructor and Description
ProtocolHandlerAdapter()

Method Summary

Modifier and Type	Method and Description
void	exceptionCaught(ProtocolSession session, java.lang.Throwable cause) Invoked when any exception is thrown by user ProtocolHandler implementation or by MINA.
void	messageReceived(ProtocolSession session, java.lang.Object message) Invoked when protocol message is received.
void	messageSent(ProtocolSession session, java.lang.Object message) Invoked when protocol message that user requested by ProtocolSession.write(Object) is sent out actually.
void	sessionClosed(ProtocolSession session) Invoked when the connection is closed.
void	sessionCreated(ProtocolSession session) Invoked when the session is created.
void	sessionIdle(ProtocolSession session, IdleStatus status) Invoked when the connection is idle.
void	sessionOpened(ProtocolSession session) Invoked when the connection is opened.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ProtocolHandlerAdapter

public ProtocolHandlerAdapter()

Method Detail

sessionCreated

public void sessionCreated(ProtocolSession session)
                    throws java.lang.Exception

Description copied from interface: ProtocolHandler

Invoked when the session is created. Initialize default socket parameters and user-defined attributes here.

Specified by:

sessionCreated in interface ProtocolHandler

Throws:

java.lang.Exception

sessionOpened

public void sessionOpened(ProtocolSession session)
                   throws java.lang.Exception

Description copied from interface: ProtocolHandler

Invoked when the connection is opened. This method is not invoked if the transport type is UDP.

Specified by:

sessionOpened in interface ProtocolHandler

Throws:

java.lang.Exception

sessionClosed

public void sessionClosed(ProtocolSession session)
                   throws java.lang.Exception

Description copied from interface: ProtocolHandler

Invoked when the connection is closed. This method is not invoked if the transport type is UDP.

Specified by:

sessionClosed in interface ProtocolHandler

Throws:

java.lang.Exception

sessionIdle

public void sessionIdle(ProtocolSession session,
                        IdleStatus status)
                 throws java.lang.Exception

Description copied from interface: ProtocolHandler

Invoked when the connection is idle. Refer to IdleStatus. This method is not invoked if the transport type is UDP.

Specified by:

sessionIdle in interface ProtocolHandler

Throws:

java.lang.Exception

exceptionCaught

public void exceptionCaught(ProtocolSession session,
                            java.lang.Throwable cause)
                     throws java.lang.Exception

Description copied from interface: ProtocolHandler

Invoked when any exception is thrown by user ProtocolHandler implementation or by MINA. If cause is instanceof IOException, MINA will close the connection automatically.

Specified by:

exceptionCaught in interface ProtocolHandler

Throws:

java.lang.Exception

messageReceived

public void messageReceived(ProtocolSession session,
                            java.lang.Object message)
                     throws java.lang.Exception

Description copied from interface: ProtocolHandler

Invoked when protocol message is received. Implement your protocol flow here.

Specified by:

messageReceived in interface ProtocolHandler

Throws:

java.lang.Exception

messageSent

public void messageSent(ProtocolSession session,
                        java.lang.Object message)
                 throws java.lang.Exception

Description copied from interface: ProtocolHandler

Invoked when protocol message that user requested by ProtocolSession.write(Object) is sent out actually.

Specified by:

messageSent in interface ProtocolHandler

Throws:

java.lang.Exception