Ssh.Shell (J2SSH Javadocs)

java.lang.Object
- com.sshtools.ant.SshSubTask
- - com.sshtools.ant.Ssh.Shell

All Implemented Interfaces:

PseudoTerminal

Direct Known Subclasses:

Ssh.Exec

Enclosing class:

Ssh
```
public class Ssh.Shell
extends SshSubTask
implements PseudoTerminal
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

class Ssh.Shell.Read

class Ssh.Shell.Write

Nested Classes
Modifier and Type	Class and Description
`class`	`Ssh.Shell.Read`
`class`	`Ssh.Shell.Write`

Field Summary

Fields
Modifier and Type Field and Description

protected SessionOutputReader output
- Fields inherited from class com.sshtools.ant.SshSubTask
  parent, taskString
- Fields inherited from interface com.sshtools.j2ssh.session.PseudoTerminal
  CS7, CS8, ECHO, ECHOCTL, ECHOE, ECHOK, ECHOKE, ECHONL, ICANON, ICRNL, IEXTEN, IGNCR, IGNPAR, IMAXBEL, INLCR, INPCK, ISIG, ISTRIP, IUCLC, IXANY, IXOFF, IXON, NOFLSH, OCRNL, OLCUC, ONLCR, ONLRET, ONOCR, OPOST, PARENB, PARMRK, PARODD, PENDIN, TOSTOP, TTY_OP_END, TTY_OP_ISPEED, TTY_OP_OSPEED, VDISCARD, VDSUSP, VEOF, VEOL, VEOL2, VERASE, VFLUSH, VINTR, VKILL, VLNEXT, VQUIT, VREPRINT, VSTART, VSTATUS, VSTOP, VSUSP, VSWTCH, VWERASE, XCASE

Fields
Modifier and Type	Field and Description
`protected SessionOutputReader`	`output`

Constructor Summary

Constructors
Constructor and Description

Shell()

Constructors
Constructor and Description
`Shell()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`allocatePseudoTerminal(SessionChannelClient session)`
`Ssh.Shell.Read`	`createRead()`
`Ssh.Shell.Write`	`createWrite()` Reading/Writing to the session/command
`void`	`execute(SshClient ssh)`
`int`	`getColumns()`
`java.lang.String`	`getEncodedTerminalModes()`
`int`	`getHeight()`
`int`	`getRows()`
`java.lang.String`	`getTerm()` PseduoTermainal interface
`int`	`getWidth()`
`protected void`	`performTasks(SessionChannelClient session)`
`void`	`setCols(int cols)`
`void`	`setRows(int rows)`
`void`	`setTerm(java.lang.String term)`
`protected void`	`validate()`

Methods inherited from class com.sshtools.ant.SshSubTask
log, log, setParent

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

Field Detail
- output
```
protected SessionOutputReader output
```

Constructor Detail
- Shell
```
public Shell()
```

Method Detail

execute

public void execute(SshClient ssh)
             throws org.apache.tools.ant.BuildException

Overrides:: execute in class SshSubTask
Throws:: org.apache.tools.ant.BuildException

validate

protected void validate()
                 throws org.apache.tools.ant.BuildException

Throws:: org.apache.tools.ant.BuildException

allocatePseudoTerminal

protected void allocatePseudoTerminal(SessionChannelClient session)
                               throws org.apache.tools.ant.BuildException

Throws:: org.apache.tools.ant.BuildException

performTasks

protected void performTasks(SessionChannelClient session)
                     throws org.apache.tools.ant.BuildException

Throws:: org.apache.tools.ant.BuildException

setTerm

public void setTerm(java.lang.String term)

setCols
```
public void setCols(int cols)
```

setRows
```
public void setRows(int rows)
```

getTerm
```
public java.lang.String getTerm()
```
PseduoTermainal interface

Specified by:

getTerm in interface PseudoTerminal

Returns:

getColumns
```
public int getColumns()
```
Specified by:

getColumns in interface PseudoTerminal

Returns:

getRows
```
public int getRows()
```
Specified by:

getRows in interface PseudoTerminal

Returns:

getWidth
```
public int getWidth()
```
Specified by:

getWidth in interface PseudoTerminal

Returns:

getHeight
```
public int getHeight()
```
Specified by:

getHeight in interface PseudoTerminal

Returns:

getEncodedTerminalModes
```
public java.lang.String getEncodedTerminalModes()
```
Specified by:

getEncodedTerminalModes in interface PseudoTerminal

Returns:

createWrite
```
public Ssh.Shell.Write createWrite()
```
Reading/Writing to the session/command

createRead
```
public Ssh.Shell.Read createRead()
```

Class Ssh.Shell

Nested Class Summary

Field Summary

Fields inherited from class com.sshtools.ant.SshSubTask

Fields inherited from interface com.sshtools.j2ssh.session.PseudoTerminal

Constructor Summary

Method Summary

Methods inherited from class com.sshtools.ant.SshSubTask

Methods inherited from class java.lang.Object

Field Detail

output

Constructor Detail

Shell

Method Detail

execute

validate

allocatePseudoTerminal

performTasks

setTerm

setCols

setRows

getTerm

getColumns

getRows

getWidth

getHeight

getEncodedTerminalModes

createWrite

createRead