org.apache.sshd.common

Interface Service

All Superinterfaces:

AutoCloseable, Channel, Closeable, PropertyResolver, SessionContextHolder, SessionHolder<Session>

All Known Subinterfaces:

ConnectionService

All Known Implementing Classes:

AbstractConnectionService, ClientConnectionService, ClientUserAuthService, ServerConnectionService, ServerUserAuthService

public interface Service
extends SessionHolder<Session>, PropertyResolver, Closeable

See RFC 4253 [SSH-TRANS] and the SSH_MSG_SERVICE_REQUEST packet. Examples include "ssh-userauth" and "ssh-connection" but developers are also free to implement their own custom service.

Author:

Apache MINA SSHD Project

Field Summary

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

EMPTY

Method Summary

Modifier and Type	Method and Description
default PropertyResolver	getParentPropertyResolver()
void	process(int cmd, Buffer buffer) Service the request.
void	start()

Methods inherited from interface org.apache.sshd.common.session.SessionHolder

getSession, getSessionContext

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

getBoolean, getBooleanProperty, getCharset, getInteger, getIntProperty, getLong, getLongProperty, getObject, getProperties, getString, getStringProperty, isEmpty, isEmpty

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

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

Method Detail

getParentPropertyResolver

default PropertyResolver getParentPropertyResolver()

Specified by:

getParentPropertyResolver in interface PropertyResolver

start

void start()

process

void process(int cmd,
             Buffer buffer)
      throws Exception

Service the request.

Parameters:

cmd - The incoming command type

buffer - The Buffer containing optional command parameters

Throws:

Exception - If failed to process the command