SshMsgUserAuthInfoRequest (J2SSH Javadocs)

java.lang.Object
- com.sshtools.j2ssh.transport.SshMessage
- - com.sshtools.j2ssh.authentication.SshMsgUserAuthInfoRequest

public class SshMsgUserAuthInfoRequest
extends SshMessage

Version:: $Revision: 1.16 $
Author:: $author$

Field Summary

Fields
Modifier and Type Field and Description

static int SSH_MSG_USERAUTH_INFO_REQUEST

Fields
Modifier and Type	Field and Description
`static int`	`SSH_MSG_USERAUTH_INFO_REQUEST`

Constructor Summary

Constructors
Constructor and Description
`SshMsgUserAuthInfoRequest()` Creates a new SshMsgUserAuthInfoRequest object.
`SshMsgUserAuthInfoRequest(java.lang.String name, java.lang.String instruction, java.lang.String langtag)` Creates a new SshMsgUserAuthInfoRequest object.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addPrompt(java.lang.String prompt, boolean echo)`
`protected void`	`constructByteArray(ByteArrayWriter baw)` Message implementations should implement this method, writing the data as exected in the transport protocol message format.
`protected void`	`constructMessage(ByteArrayReader bar)` Message implementation should implement this method, reading the data as expected in the transport protocol message format.
`java.lang.String`	`getInstruction()`
`java.lang.String`	`getLanguageTag()`
`java.lang.String`	`getMessageName()` Returns the name of the message implementation for debugging purposes.
`java.lang.String`	`getName()`
`KBIPrompt[]`	`getPrompts()`

Methods inherited from class com.sshtools.j2ssh.transport.SshMessage
fromByteArray, getMessageId, getMessageId, toByteArray

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

- Field Detail
  - SSH_MSG_USERAUTH_INFO_REQUEST
```
public static final int SSH_MSG_USERAUTH_INFO_REQUEST
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - SshMsgUserAuthInfoRequest
```
public SshMsgUserAuthInfoRequest()
```
    Creates a new SshMsgUserAuthInfoRequest object.
  - SshMsgUserAuthInfoRequest
```
public SshMsgUserAuthInfoRequest(java.lang.String name,
                                 java.lang.String instruction,
                                 java.lang.String langtag)
```
    Creates a new SshMsgUserAuthInfoRequest object.
    
    Parameters:
    
    name -
    
    instruction -
    
    langtag -
- Method Detail
  - addPrompt
```
public void addPrompt(java.lang.String prompt,
                      boolean echo)
```
    Parameters:
    
    prompt -
    
    echo -
  - getPrompts
```
public KBIPrompt[] getPrompts()
```
    Returns:
  - getName
```
public java.lang.String getName()
```
    Returns:
  - getInstruction
```
public java.lang.String getInstruction()
```
    Returns:
  - getLanguageTag
```
public java.lang.String getLanguageTag()
```
    Returns:
  - getMessageName
```
public java.lang.String getMessageName()
```
    Description copied from class: SshMessage
    
    Returns the name of the message implementation for debugging purposes.
    
    Specified by:
    
    getMessageName in class SshMessage
    
    Returns:
  - constructByteArray
```
protected void constructByteArray(ByteArrayWriter baw)
                           throws InvalidMessageException
```
    Description copied from class: SshMessage
    
    Message implementations should implement this method, writing the data as exected in the transport protocol message format.
    
    Specified by:
    
    constructByteArray in class SshMessage
    
    Parameters:
    
    baw -
    
    Throws:
    
    InvalidMessageException - DOCUMENT ME!
    
    InvalidMessageException
  - constructMessage
```
protected void constructMessage(ByteArrayReader bar)
                         throws InvalidMessageException
```
    Description copied from class: SshMessage
    
    Message implementation should implement this method, reading the data as expected in the transport protocol message format.
    
    Specified by:
    
    constructMessage in class SshMessage
    
    Parameters:
    
    bar -
    
    Throws:
    
    InvalidMessageException - DOCUMENT ME!
    
    InvalidMessageException

Class SshMsgUserAuthInfoRequest

Field Summary

Constructor Summary

Method Summary

Methods inherited from class com.sshtools.j2ssh.transport.SshMessage

Methods inherited from class java.lang.Object

Field Detail

SSH_MSG_USERAUTH_INFO_REQUEST

Constructor Detail

SshMsgUserAuthInfoRequest

SshMsgUserAuthInfoRequest

Method Detail

addPrompt

getPrompts

getName

getInstruction

getLanguageTag

getMessageName

constructByteArray

constructMessage