org.apache.sshd.common.io.mina

Class MinaService

java.lang.Object

org.apache.mina.core.service.IoHandlerAdapter

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

All Implemented Interfaces:

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

Direct Known Subclasses:

MinaAcceptor, MinaConnector

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

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 org.slf4j.Logger	log
protected FactoryManager	manager
protected org.apache.mina.core.session.IoSessionConfig	sessionConfig

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

Methods

Modifier and Type	Method and Description
CloseFuture	close(boolean immediately) Close this resource asynchronously and return a future.
protected void	configure(org.apache.mina.transport.socket.SocketSessionConfig config)
void	dispose()
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)
boolean	isClosed() Returns true if this object has been closed.
boolean	isClosing() Returns true if the Closeable.close(boolean) method has been called.
void	messageReceived(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)

Methods inherited from class org.apache.mina.core.service.IoHandlerAdapter

inputClosed, messageSent, sessionIdle, sessionOpened

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.mina.core.service.IoHandler

inputClosed, messageSent, sessionIdle, sessionOpened

Field Detail

log

protected final org.slf4j.Logger log

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()

Specified by:

dispose in interface IoService

close

public CloseFuture close(boolean immediately)

Description copied from interface: Closeable

Close this resource asynchronously and return a future. Resources support two closing modes: a graceful mode which will cleanly close the resource and an immediate mode which will close the resources abruptly.

Specified by:

close in interface Closeable

Parameters:

immediately - true if the resource should be shut down abruptly, false for a graceful close

Returns:

a future

isClosed

public boolean isClosed()

Description copied from interface: Closeable

Returns true if this object has been closed.

Specified by:

isClosed in interface Closeable

Returns:

true if closing

isClosing

public boolean isClosing()

Description copied from interface: Closeable

Returns true if the Closeable.close(boolean) method has been called. Note that this method will return true even if this Closeable.isClosed() returns true.

Specified by:

isClosing in interface Closeable

Returns:

true if closing

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.

sessionCreated

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

Specified by:

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

Overrides:

sessionCreated in class org.apache.mina.core.service.IoHandlerAdapter

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

Overrides:

sessionClosed in class org.apache.mina.core.service.IoHandlerAdapter

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

Overrides:

exceptionCaught in class org.apache.mina.core.service.IoHandlerAdapter

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

Overrides:

messageReceived in class org.apache.mina.core.service.IoHandlerAdapter

Throws:

Exception

getSession

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

configure

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

getInteger

protected Integer getInteger(String property)

getBoolean

protected Boolean getBoolean(String property)