SubsystemClient (J2SSH Javadocs)

java.lang.Object

com.sshtools.j2ssh.subsystem.SubsystemClient

All Implemented Interfaces:: Runnable

public abstract class SubsystemClient extends Object implements Runnable

Version:: $Revision: 1.33 $
Author:: $author$

Field Summary

Fields

Modifier and Type

Field

Description

protected SubsystemMessageStore

messageStore

protected SessionChannelClient

session
Constructor Summary

Constructors

Constructor

Description

SubsystemClient(String name)

Creates a new SubsystemClient object.

SubsystemClient(String name, SubsystemMessageStore messageStore)

Creates a new SubsystemClient object.
Method Summary

Modifier and Type

Method

Description

String

getName()

SessionChannelClient

getSessionChannel()

boolean

isClosed()

protected abstract boolean

onStart()

void

run()

protected void

sendMessage(SubsystemMessage msg)

void

setSessionChannel(SessionChannelClient session)

boolean

start()

void

stop()

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details
- messageStore
  
  protected SubsystemMessageStore messageStore
- session
  
  protected SessionChannelClient session
Constructor Details
- SubsystemClient
  
  public SubsystemClient(String name)
  
  Creates a new SubsystemClient object.
  
  Parameters:
  
  name -
- SubsystemClient
  
  public SubsystemClient(String name, SubsystemMessageStore messageStore)
  
  Creates a new SubsystemClient object.
  
  Parameters:
  
  name -
  
  messageStore -
Method Details
- isClosed
  
  public boolean isClosed()
  
  Returns:
- setSessionChannel
  
  public void setSessionChannel(SessionChannelClient session)
  
  Parameters:
  
  session -
- getSessionChannel
  
  public SessionChannelClient getSessionChannel()
  
  Returns:
- start
  
  public boolean start() throws IOException
  
  Returns:
  
  Throws:
  
  IOException
- onStart
  
  protected abstract boolean onStart() throws IOException
  
  Returns:
  
  Throws:
  
  IOException
- getName
  
  public String getName()
  
  Returns:
- sendMessage
  
  protected void sendMessage(SubsystemMessage msg) throws InvalidMessageException, IOException
  
  Parameters:
  
  msg -
  
  Throws:
  
  InvalidMessageException
  
  IOException
- run
  
  public void run()
  
  Specified by:
  
  run in interface Runnable
- stop
  
  public void stop() throws IOException
  
  Throws:
  
  IOException