com.sshtools.j2ssh.connection
Class SshMsgGlobalRequest

java.lang.Object
  |
  +--com.sshtools.j2ssh.transport.SshMessage
        |
        +--com.sshtools.j2ssh.connection.SshMsgGlobalRequest

public class SshMsgGlobalRequest
extends SshMessage

Implements the SSH_MSG_GLOBAL_REQUEST message.

Version:
1.0
Author:
Lee David Painter ( lee@sshtools.com )

Field Summary
protected static int SSH_MSG_GLOBAL_REQUEST
          The message id
 
Constructor Summary
SshMsgGlobalRequest()
          Constructor for the SshMsgGlobalRequest object
SshMsgGlobalRequest(java.lang.String requestName, boolean wantReply, byte[] requestData)
          Constructor for the SshMsgGlobalRequest object
 
Method Summary
protected  void constructByteArray(ByteArrayWriter baw)
          Abstract method implementation to construct a byte array containing the message data.
protected  void constructMessage(ByteArrayReader bar)
          Abstract method implementation to construct the message from a byte array
 java.lang.String getMessageName()
          Gets the message name for debugging
 byte[] getRequestData()
          Gets the request data
 java.lang.String getRequestName()
          Gets the request name
 boolean getWantReply()
          Indicates whether the sender wants a reply
 
Methods inherited from class com.sshtools.j2ssh.transport.SshMessage
fromByteArray, getMessageId, toByteArray
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

SSH_MSG_GLOBAL_REQUEST

protected static final int SSH_MSG_GLOBAL_REQUEST
The message id

See Also:
Constant Field Values
Constructor Detail

SshMsgGlobalRequest

public SshMsgGlobalRequest(java.lang.String requestName,
                           boolean wantReply,
                           byte[] requestData)
Constructor for the SshMsgGlobalRequest object

Parameters:
requestName - The request name
wantReply - True if a reply is required
requestData - The request specific data

SshMsgGlobalRequest

public SshMsgGlobalRequest()
Constructor for the SshMsgGlobalRequest object

Method Detail

getMessageName

public java.lang.String getMessageName()
Gets the message name for debugging

Specified by:
getMessageName in class SshMessage
Returns:

constructMessage

protected void constructMessage(ByteArrayReader bar)
                         throws InvalidMessageException
Abstract method implementation to construct the message from a byte array

Specified by:
constructMessage in class SshMessage
Parameters:
bar - The byte array being read
Throws:
InvalidMessageException - Thrown if the data cannot be read

constructByteArray

protected void constructByteArray(ByteArrayWriter baw)
                           throws InvalidMessageException
Abstract method implementation to construct a byte array containing the message data.

Specified by:
constructByteArray in class SshMessage
Parameters:
baw - The byte array being written to.
Throws:
InvalidMessageException - Thrown of the data cannot be written

getRequestData

public byte[] getRequestData()
Gets the request data

Returns:
The request data

getRequestName

public java.lang.String getRequestName()
Gets the request name

Returns:
The request name

getWantReply

public boolean getWantReply()
Indicates whether the sender wants a reply

Returns:
The want reply value


Copyright © 2002 Sshtools.com. All Rights Reserved.