org.apache.sshd.common.SshException Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of sshd-common Show documentation
The newest version!
/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements. See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership. The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License. You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied. See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */
package org.apache.sshd.common;

import java.io.IOException;
import java.util.Objects;

import org.apache.sshd.common.util.GenericUtils;

/**
 * Represents an SSH related exception
 *
 * @author Apache MINA SSHD Project
 */
public class SshException extends IOException {

    private static final long serialVersionUID = -7349477687125144606L;

    private final int disconnectCode;

    public SshException(String message) {
        this(message, null);
    }

    public SshException(Throwable cause) {
        this(Objects.requireNonNull(cause, "No cause").getMessage(), cause);
    }

    public SshException(String message, Throwable cause) {
        this(0, message, cause);
    }

    public SshException(int disconnectCode) {
        this(disconnectCode, SshConstants.getDisconnectReasonName(disconnectCode));
    }

    public SshException(int disconnectCode, String message) {
        this(disconnectCode, message, null);
    }

    public SshException(int disconnectCode, Throwable cause) {
        this(disconnectCode, SshConstants.getDisconnectReasonName(disconnectCode), cause);
    }

    public SshException(int disconnectCode, String message, Throwable cause) {
        super(GenericUtils.isEmpty(message) ? SshConstants.getDisconnectReasonName(disconnectCode) : message);
        this.disconnectCode = disconnectCode;
        if (cause != null) {
            initCause(cause);
        }
    }

    public int getDisconnectCode() {
        return disconnectCode;
    }
}