Subversion Repositories Programming Utils

Rev

Details | Last modification | View Log | RSS feed

Rev Author Line No. Line
86 rm5248 1
/*
2
 * Licensed to the Apache Software Foundation (ASF) under one
3
 * or more contributor license agreements.  See the NOTICE file
4
 * distributed with this work for additional information
5
 * regarding copyright ownership.  The ASF licenses this file
6
 * to you under the Apache License, Version 2.0 (the
7
 * "License"); you may not use this file except in compliance
8
 * with the License.  You may obtain a copy of the License at
9
 *
10
 *   http://www.apache.org/licenses/LICENSE-2.0
11
 *
12
 * Unless required by applicable law or agreed to in writing,
13
 * software distributed under the License is distributed on an
14
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15
 * KIND, either express or implied.  See the License for the
16
 * specific language governing permissions and limitations
17
 * under the License.
18
 */
19
package org.apache.sshd.server.channel;
20
 
21
import org.apache.sshd.common.SshConstants;
22
 
23
/**
24
 * Documents failure of a channel to open as expected.
25
 *
26
 * @author <a href="mailto:dev@mina.apache.org">Apache MINA SSHD Project</a>
27
 */
28
public class OpenChannelException extends Exception {
29
    private final int code;
30
 
31
    public OpenChannelException(int code, String message) {
32
        this(code, message, null);
33
    }
34
 
35
    public OpenChannelException(int code, String message, Throwable cause) {
36
        super(message, cause);
37
        this.code = code;
38
    }
39
 
40
    /**
41
     * The reason code as specified by RFC 4254.
42
     * <ul>
43
     * <li>{@link SshConstants#SSH_OPEN_ADMINISTRATIVELY_PROHIBITED}
44
     * <li>{@link SshConstants#SSH_OPEN_CONNECT_FAILED}
45
     * <li>{@link SshConstants#SSH_OPEN_UNKNOWN_CHANNEL_TYPE}
46
     * <li>{@link SshConstants#SSH_OPEN_RESOURCE_SHORTAGE}
47
     * </ul>
48
     *
49
     * @return reason code; 0 if no standardized reason code is given.
50
     */
51
    public int getReasonCode() {
52
        return code;
53
    }
54
}