com.jscape.inet.ssh.transport.messages
Class SshMsgDebug

java.lang.Object
  com.jscape.inet.ssh.transport.Message
      com.jscape.inet.ssh.transport.messages.SshMsgDebug

All Implemented Interfaces:

TransportDispatchable

public class SshMsgDebug
extends Message
implements TransportDispatchable

Debug message: SSH_MSG_DEBUG. This message is used to transmit information that may help debugging.

Version:

1.0

Author:

Alex Usun

Field Summary

static int

TYPE Message type code.

Constructor Summary

SshMsgDebug(boolean alwaysDisplay, java.lang.String message, java.lang.String languageTag)
Creates a new message instance.

Method Summary

boolean	accept(TransportMessageDispatcher dispatcher) Calls an appropriate dispatcher method.
boolean	getAlwaysDisplay() Returns if message should be dispalyed.
java.lang.String	getLanguageTag() Returns the message language tag.
java.lang.String	getMessage() Returns the debug message.
static SshMsgDebug	readFrom(java.io.InputStream in)
static Message	readFrom(SshReader reader) Reads the message from the reader.
java.lang.String	toString() Returns the string representation of this message.
void	writeTo(java.io.OutputStream out)
void	writeTo(SshWriter writer) Writes the message to the specified writer.

Methods inherited from class com.jscape.inet.ssh.transport.Message

getId, getType, readFrom, readFrom, setId

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

TYPE

public static final int TYPE

Message type code.

See Also:

Constant Field Values

Constructor Detail

SshMsgDebug

public SshMsgDebug(boolean alwaysDisplay,
                   java.lang.String message,
                   java.lang.String languageTag)

Creates a new message instance.

Parameters:

alwaysDisplay - if true the message should be displayed

message - debug message

languageTag - the message language tag

Method Detail

readFrom

public static SshMsgDebug readFrom(java.io.InputStream in)
                            throws java.io.IOException

Parameters:

in -

Returns:

SshMsgDebug instance

Throws:

java.io.IOException

readFrom

public static Message readFrom(SshReader reader)
                        throws java.io.IOException

Reads the message from the reader.

Parameters:

reader - the SSH types reader

Returns:

the readed message

Throws:

java.io.IOException - if an I/O error occurs

getAlwaysDisplay

public boolean getAlwaysDisplay()

Returns if message should be dispalyed.

Returns:

if message should be dispalyed

getMessage

public java.lang.String getMessage()

Returns the debug message.

Returns:

the debug message

getLanguageTag

public java.lang.String getLanguageTag()

Returns the message language tag.

Returns:

the message language tag

writeTo

public void writeTo(java.io.OutputStream out)
             throws java.io.IOException

Overrides:

writeTo in class Message

Parameters:

out -

Throws:

java.io.IOException

writeTo

public void writeTo(SshWriter writer)
             throws java.io.IOException

Writes the message to the specified writer.

Overrides:

writeTo in class Message

Parameters:

writer - the SSH types writer

Throws:

java.io.IOException - if an I/O error occurs

accept

public boolean accept(TransportMessageDispatcher dispatcher)

Calls an appropriate dispatcher method.

Specified by:

accept in interface TransportDispatchable

Parameters:

dispatcher - the message dispatcher

Returns:

true if dispatcher can dispatch this message; false otherwise

toString

public java.lang.String toString()

Returns the string representation of this message.

Overrides:

toString in class java.lang.Object

Returns:

the string representation of this message