org.apache.sshd.common.io.mina

Class MinaService

java.lang.Object

org.apache.sshd.common.util.logging.AbstractLoggingBean

org.apache.sshd.common.util.closeable.IoBaseCloseable

org.apache.sshd.common.util.closeable.AbstractCloseable

org.apache.sshd.common.io.mina.MinaService

All Implemented Interfaces:

Closeable, AutoCloseable, Channel, org.apache.mina.core.service.IoHandler, IoService

Direct Known Subclasses:

MinaAcceptor, MinaConnector

public abstract class MinaService
extends AbstractCloseable
implements IoService, org.apache.mina.core.service.IoHandler, Closeable

Author:

Apache MINA SSHD Project

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.sshd.common.util.closeable.AbstractCloseable

AbstractCloseable.State

Field Summary

Fields

Modifier and Type	Field and Description
protected IoHandler	handler
protected org.apache.mina.core.service.IoProcessor<org.apache.mina.transport.socket.nio.NioSession>	ioProcessor
protected FactoryManager	manager
protected org.apache.mina.core.session.IoSessionConfig	sessionConfig

Fields inherited from class org.apache.sshd.common.util.closeable.AbstractCloseable

closeFuture, lock, state

Fields inherited from class org.apache.sshd.common.util.logging.AbstractLoggingBean

log

Fields inherited from interface org.apache.sshd.common.io.IoService

DEFAULT_REUSE_ADDRESS

Fields inherited from interface org.apache.sshd.common.Closeable

CLOSE_WAIT_TIMEOUT, DEFAULT_CLOSE_WAIT_TIMEOUT

Constructor Summary

Constructors

Constructor and Description
MinaService(FactoryManager manager, IoHandler handler, org.apache.mina.core.service.IoProcessor<org.apache.mina.transport.socket.nio.NioSession> ioProcessor)

Method Summary

Modifier and Type	Method and Description
protected void	configure(org.apache.mina.transport.socket.SocketSessionConfig config)
void	dispose()
protected void	doCloseImmediately() doCloseImmediately is called once and only once with state == Immediate Overriding methods should always call the base implementation.
void	exceptionCaught(org.apache.mina.core.session.IoSession session, Throwable cause)
protected Boolean	getBoolean(String property)
protected Integer	getInteger(String property)
protected abstract org.apache.mina.core.service.IoService	getIoService()
Map<Long,IoSession>	getManagedSessions() Returns the map of all sessions which are currently managed by this service.
protected IoSession	getSession(org.apache.mina.core.session.IoSession session)
protected void	handleConfigurationError(org.apache.mina.transport.socket.SocketSessionConfig config, String propName, Object propValue, org.apache.mina.core.RuntimeIoException t)
void	inputClosed(org.apache.mina.core.session.IoSession session)
void	messageReceived(org.apache.mina.core.session.IoSession session, Object message)
void	messageSent(org.apache.mina.core.session.IoSession session, Object message)
void	sessionClosed(org.apache.mina.core.session.IoSession session)
void	sessionCreated(org.apache.mina.core.session.IoSession session)
void	sessionIdle(org.apache.mina.core.session.IoSession session, org.apache.mina.core.session.IdleStatus status)
void	sessionOpened(org.apache.mina.core.session.IoSession session)

Methods inherited from class org.apache.sshd.common.util.closeable.AbstractCloseable

addCloseFutureListener, builder, close, doCloseGracefully, isClosed, isClosing, preClose, removeCloseFutureListener

Methods inherited from class org.apache.sshd.common.util.logging.AbstractLoggingBean

getSimplifiedLogger

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.sshd.common.Closeable

addCloseFutureListener, close, close, close, getMaxCloseWaitTime, isClosed, isClosing, isOpen, removeCloseFutureListener

Field Detail

manager

protected final FactoryManager manager

handler

protected final IoHandler handler

ioProcessor

protected final org.apache.mina.core.service.IoProcessor<org.apache.mina.transport.socket.nio.NioSession> ioProcessor

sessionConfig

protected org.apache.mina.core.session.IoSessionConfig sessionConfig

Constructor Detail

MinaService

public MinaService(FactoryManager manager,
                   IoHandler handler,
                   org.apache.mina.core.service.IoProcessor<org.apache.mina.transport.socket.nio.NioSession> ioProcessor)

Method Detail

getIoService

protected abstract org.apache.mina.core.service.IoService getIoService()

dispose

public void dispose()

doCloseImmediately

protected void doCloseImmediately()

Description copied from class: AbstractCloseable

doCloseImmediately is called once and only once with state == Immediate

Overriding methods should always call the base implementation. It may be called concurrently while preClose() or doCloseGracefully is executing

Overrides:

doCloseImmediately in class AbstractCloseable

getManagedSessions

public Map<Long,IoSession> getManagedSessions()

Description copied from interface: IoService

Returns the map of all sessions which are currently managed by this service. The key of map is the ID of the session.

Specified by:

getManagedSessions in interface IoService

Returns:

the sessions. An empty collection if there's no session.

sessionOpened

public void sessionOpened(org.apache.mina.core.session.IoSession session)
                   throws Exception

Specified by:

sessionOpened in interface org.apache.mina.core.service.IoHandler

Throws:

Exception

sessionIdle

public void sessionIdle(org.apache.mina.core.session.IoSession session,
                        org.apache.mina.core.session.IdleStatus status)
                 throws Exception

Specified by:

sessionIdle in interface org.apache.mina.core.service.IoHandler

Throws:

Exception

messageSent

public void messageSent(org.apache.mina.core.session.IoSession session,
                        Object message)
                 throws Exception

Specified by:

messageSent in interface org.apache.mina.core.service.IoHandler

Throws:

Exception

inputClosed

public void inputClosed(org.apache.mina.core.session.IoSession session)
                 throws Exception

Specified by:

inputClosed in interface org.apache.mina.core.service.IoHandler

Throws:

Exception

sessionCreated

public void sessionCreated(org.apache.mina.core.session.IoSession session)
                    throws Exception

Specified by:

sessionCreated in interface org.apache.mina.core.service.IoHandler

Throws:

Exception

sessionClosed

public void sessionClosed(org.apache.mina.core.session.IoSession session)
                   throws Exception

Specified by:

sessionClosed in interface org.apache.mina.core.service.IoHandler

Throws:

Exception

exceptionCaught

public void exceptionCaught(org.apache.mina.core.session.IoSession session,
                            Throwable cause)
                     throws Exception

Specified by:

exceptionCaught in interface org.apache.mina.core.service.IoHandler

Throws:

Exception

messageReceived

public void messageReceived(org.apache.mina.core.session.IoSession session,
                            Object message)
                     throws Exception

Specified by:

messageReceived in interface org.apache.mina.core.service.IoHandler

Throws:

Exception

getSession

protected IoSession getSession(org.apache.mina.core.session.IoSession session)

configure

protected void configure(org.apache.mina.transport.socket.SocketSessionConfig config)

handleConfigurationError

protected void handleConfigurationError(org.apache.mina.transport.socket.SocketSessionConfig config,
                                        String propName,
                                        Object propValue,
                                        org.apache.mina.core.RuntimeIoException t)

getInteger

protected Integer getInteger(String property)

getBoolean

protected Boolean getBoolean(String property)