/*
 * 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.global;

import org.apache.sshd.common.SshConstants;

/**
 * An exception that can be set on a {@link org.apache.sshd.common.future.GlobalRequestFuture} to indicate that the
 * server sent back a failure reply.
 */
public class GlobalRequestException extends Exception {

    private static final long serialVersionUID = 225802262556424684L;

    private final int code;

    /**
     * Creates a new {@link GlobalRequestException} with the given SSH message code.
     *
     * @param code SSH message code to set; normally {@link SshConstants#SSH_MSG_UNIMPLEMENTED} or
     *             {@link SshConstants#SSH_MSG_REQUEST_FAILURE}
     */
    public GlobalRequestException(int code) {
        super(SshConstants.getCommandMessageName(code));
        this.code = code;
    }

    /**
     * Retrieves the SSH message code.
     *
     * @return the code, normally {@link SshConstants#SSH_MSG_UNIMPLEMENTED} or
     *         {@link SshConstants#SSH_MSG_REQUEST_FAILURE}
     */
    public int getCode() {
        return code;
    }
}
