org.apache.sshd.common.channel.exception

Class SshChannelOpenException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.io.IOException

org.apache.sshd.common.channel.exception.SshChannelException

org.apache.sshd.common.channel.exception.SshChannelOpenException

All Implemented Interfaces:

java.io.Serializable

public class SshChannelOpenException
extends SshChannelException

Documents failure of a channel to open as expected.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
private int	code
private static long	serialVersionUID

Constructor Summary

Constructors

Constructor and Description
SshChannelOpenException(int channelId, int code, java.lang.String message)
SshChannelOpenException(int channelId, int code, java.lang.String message, java.lang.Throwable cause)

Method Summary

Modifier and Type	Method and Description
int	getReasonCode() The reason code as specified by RFC 4254.

Methods inherited from class org.apache.sshd.common.channel.exception.SshChannelException

getChannelId

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

serialVersionUID

private static final long serialVersionUID

See Also:

Constant Field Values

code

private final int code

Constructor Detail

SshChannelOpenException

public SshChannelOpenException(int channelId,
                               int code,
                               java.lang.String message)

SshChannelOpenException

public SshChannelOpenException(int channelId,
                               int code,
                               java.lang.String message,
                               java.lang.Throwable cause)

Method Detail

getReasonCode

public int getReasonCode()

The reason code as specified by RFC 4254.

• SshConstants.SSH_OPEN_ADMINISTRATIVELY_PROHIBITED
• SshConstants.SSH_OPEN_CONNECT_FAILED
• SshConstants.SSH_OPEN_UNKNOWN_CHANNEL_TYPE
• SshConstants.SSH_OPEN_RESOURCE_SHORTAGE

Returns:

reason code; 0 if no standardized reason code is given.