Package org.apache.sshd.common.channel

Interface PtyChannelConfigurationMutator

All Superinterfaces:

PtyChannelConfigurationHolder

All Known Implementing Classes:

PtyChannelConfiguration

public interface PtyChannelConfigurationMutator
extends PtyChannelConfigurationHolder

Author:

Apache MINA SSHD Project

Field Summary

Fields inherited from interface org.apache.sshd.common.channel.PtyChannelConfigurationHolder

DEFAULT_COLUMNS_COUNT, DEFAULT_HEIGHT, DEFAULT_PTY_MODES, DEFAULT_ROWS_COUNT, DEFAULT_WIDTH, DUMMY_PTY_TYPE, WINDOWS_PTY_TYPE

Method Summary

Modifier and Type	Method	Description
static <M extends PtyChannelConfigurationMutator> M	copyConfiguration(PtyChannelConfigurationHolder src, M dst)
void	setPtyColumns(int ptyColumns)
void	setPtyHeight(int ptyHeight)
void	setPtyLines(int ptyLines)
void	setPtyModes(Map<PtyMode,Integer> ptyModes)
void	setPtyType(String ptyType)
void	setPtyWidth(int ptyWidth)
static <M extends PtyChannelConfigurationMutator> M	setupSensitiveDefaultPtyConfiguration(M mutator)	Uses O/S detection to initialize some default PTY related values

Methods inherited from interface org.apache.sshd.common.channel.PtyChannelConfigurationHolder

getPtyColumns, getPtyHeight, getPtyLines, getPtyModes, getPtyType, getPtyWidth

Method Details

setPtyType

void setPtyType(String ptyType)

setPtyColumns

void setPtyColumns(int ptyColumns)

setPtyLines

void setPtyLines(int ptyLines)

setPtyWidth

void setPtyWidth(int ptyWidth)

setPtyHeight

void setPtyHeight(int ptyHeight)

setPtyModes

void setPtyModes(Map<PtyMode,Integer> ptyModes)

copyConfiguration

static <M extends PtyChannelConfigurationMutator> M copyConfiguration(PtyChannelConfigurationHolder src,
 M dst)

setupSensitiveDefaultPtyConfiguration

static <M extends PtyChannelConfigurationMutator> M setupSensitiveDefaultPtyConfiguration(M mutator)
                                                                                   throws IOException,
InterruptedException

Uses O/S detection to initialize some default PTY related values

Type Parameters:

M - Generic PtyChannelConfigurationMutator instance

Parameters:

mutator - The mutator to update - ignored if null

Returns:

The updated mutator

Throws:

IOException - If failed to access some O/S related configuration

InterruptedException - If interrupted during access of O/S related configuration