org.eclipse.scada.core.server.net

Class AbstractServerConnectionHandler

java.lang.Object

org.eclipse.scada.core.server.net.AbstractServerConnectionHandler

All Implemented Interfaces:

SingleSessionIoHandler

Direct Known Subclasses:

ServerConnectionHandler

public abstract class AbstractServerConnectionHandler
extends Object
implements SingleSessionIoHandler

Field Summary

Fields

Modifier and Type	Field and Description
protected ConnectionInformation	connectionInformation
protected IoSession	ioSession
protected Messenger	messenger
protected PingService	pingService

Constructor Summary

Constructors

Constructor and Description
AbstractServerConnectionHandler(IoSession ioSession, ConnectionInformation connectionInformation)

Method Summary

Methods

Modifier and Type	Method and Description
protected void	cleanUp()
void	exceptionCaught(Throwable cause) Invoked when any exception is thrown by user IoHandler implementation or by MINA.
protected boolean	getBooleanProperty(String propertyName, boolean defaultValue)
protected int	getIntProperty(String propertyName, int defaultValue)
int	getMessageTimeout()
int	getPingPeriod()
protected Map<String,String>	getTransportProperties(Properties props)
void	messageReceived(Object message) Invoked when protocol message is received.
void	messageSent(Object message) Invoked when protocol message that user requested by IoSession.write(Object) is sent out actually.
protected void	modifyFilterChain(IoSession ioSession, Map<String,String> properties)
protected void	replySessionCreated(Properties originalProperties, Message originalMessage, Map<String,String> sessionProperties)
protected void	sendPrivilegeChange(Set<String> privileges)
void	sessionClosed() Invoked when the connection is closed.
protected void	sessionConfigured(Map<String,String> properties)
void	sessionCreated() Invoked when the session is created.
void	sessionIdle(IdleStatus status) Invoked when the connection is idle.
void	sessionOpened() Invoked when the connection is opened.
protected void	startSession()

Methods inherited from class java.lang.Object

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

Field Detail

ioSession

protected IoSession ioSession

messenger

protected final Messenger messenger

pingService

protected final PingService pingService

connectionInformation

protected final ConnectionInformation connectionInformation

Constructor Detail

AbstractServerConnectionHandler

public AbstractServerConnectionHandler(IoSession ioSession,
                               ConnectionInformation connectionInformation)

Method Detail

sessionConfigured

protected void sessionConfigured(Map<String,String> properties)

sendPrivilegeChange

protected void sendPrivilegeChange(Set<String> privileges)

modifyFilterChain

protected void modifyFilterChain(IoSession ioSession,
                     Map<String,String> properties)

getTransportProperties

protected Map<String,String> getTransportProperties(Properties props)

replySessionCreated

protected void replySessionCreated(Properties originalProperties,
                       Message originalMessage,
                       Map<String,String> sessionProperties)

exceptionCaught

public void exceptionCaught(Throwable cause)
                     throws Exception

Description copied from interface: SingleSessionIoHandler

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

Specified by:

exceptionCaught in interface SingleSessionIoHandler

Parameters:

cause - the caught exception

Throws:

Exception

See Also:

IoHandler.exceptionCaught(IoSession, Throwable)

messageReceived

public void messageReceived(Object message)
                     throws Exception

Description copied from interface: SingleSessionIoHandler

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

Specified by:

messageReceived in interface SingleSessionIoHandler

Parameters:

message - the received message

Throws:

Exception

See Also:

IoHandler.messageReceived(IoSession, Object)

startSession

protected void startSession()

messageSent

public void messageSent(Object message)
                 throws Exception

Description copied from interface: SingleSessionIoHandler

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

Specified by:

messageSent in interface SingleSessionIoHandler

Parameters:

message - the sent message

Throws:

Exception

See Also:

IoHandler.messageSent(IoSession, Object)

sessionClosed

public void sessionClosed()
                   throws Exception

Description copied from interface: SingleSessionIoHandler

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

Specified by:

sessionClosed in interface SingleSessionIoHandler

Throws:

Exception

See Also:

IoHandler.sessionClosed(IoSession)

cleanUp

protected void cleanUp()

sessionCreated

public void sessionCreated()
                    throws Exception

Description copied from interface: SingleSessionIoHandler

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

Specified by:

sessionCreated in interface SingleSessionIoHandler

Throws:

Exception

See Also:

IoHandler.sessionCreated(IoSession)

sessionIdle

public void sessionIdle(IdleStatus status)
                 throws Exception

Description copied from interface: SingleSessionIoHandler

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 SingleSessionIoHandler

Parameters:

status - the type of idleness

Throws:

Exception

See Also:

IoHandler.sessionIdle(IoSession, IdleStatus)

sessionOpened

public void sessionOpened()
                   throws Exception

Description copied from interface: SingleSessionIoHandler

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

Specified by:

sessionOpened in interface SingleSessionIoHandler

Throws:

Exception

See Also:

IoHandler.sessionOpened(IoSession)

getPingPeriod

public int getPingPeriod()

getMessageTimeout

public int getMessageTimeout()

getBooleanProperty

protected boolean getBooleanProperty(String propertyName,
                         boolean defaultValue)

getIntProperty

protected int getIntProperty(String propertyName,
                 int defaultValue)