Package 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:

Serializable, ChannelIdentifier

public class SshChannelOpenException
extends SshChannelException

Documents failure of a channel to open as expected.

Author:

Apache MINA SSHD Project

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
SshChannelOpenException(long channelId, int code, String message)
SshChannelOpenException(long channelId, int code, String message, Throwable cause)

Method Summary

Modifier and Type	Method	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

Constructor Detail

SshChannelOpenException

public SshChannelOpenException(long channelId,
                               int code,
                               String message)

SshChannelOpenException

public SshChannelOpenException(long channelId,
                               int code,
                               String message,
                               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.