org.filesys.smb.server.SMBSrvException Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jfileserver Show documentation
Java file server with SMB, FTP/FTPS and NFS support, virtual filesystems, database filesystems
The newest version!
/*
 * Copyright (C) 2006-2010 Alfresco Software Limited.
 *
 * This file is part of Alfresco
 *
 * Alfresco is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * Alfresco is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with Alfresco. If not, see .
 */

package org.filesys.smb.server;

import org.filesys.smb.SMBErrorText;
import org.filesys.smb.SMBStatus;

/**
 * SMB exception class
 *
 * This class holds the detail of an SMB network error. The SMB error class and
 * error code are available to give extra detail about the error condition.
 *
 * @author gkspencer
 */
public class SMBSrvException extends Exception {

    //  SMB error class
    protected int m_errorclass;

    //  SMB error code
    protected int m_errorcode;

    // NT 32-bit error code
    protected int m_NTerror = -1;

    /**
     * Construct an SMB exception with the specified error class/error code
     *
     * @param errclass int
     * @param errcode int
     */
    public SMBSrvException(int errclass, int errcode) {
        super(SMBErrorText.ErrorString(errclass, errcode));
        m_errorclass = errclass;
        m_errorcode = errcode;
    }

    /**
     * Construct an SMB exception with the specified error class/error code and
     * additional text error message
     *
     * @param errclass int
     * @param errcode int
     * @param msg String
     */
    public SMBSrvException(int errclass, int errcode, String msg) {
        super(msg);
        m_errorclass = errclass;
        m_errorcode = errcode;
    }

    /**
     * Construct an SMB exception using the error class/error code in the SMB packet
     *
     * @param pkt SMBSrvPacket
     */
    protected SMBSrvException(SMBSrvPacket pkt) {
        super(SMBErrorText.ErrorString(pkt.getParser().getErrorClass(), pkt.getParser().getErrorCode()));

        // Save the error class and code
        m_errorclass = pkt.getParser().getErrorClass();
        m_errorcode = pkt.getParser().getErrorCode();
    }

    /**
     * Construct an SMB exception with the specified error class/error code.
     *
     * @param nterror  int
     * @param errclass int
     * @param errcode  int
     */
    public SMBSrvException(int nterror, int errclass, int errcode) {
        super(SMBErrorText.ErrorString(errclass, errcode));
        m_errorclass = errclass;
        m_errorcode = errcode;
        m_NTerror = nterror;
    }

    /**
     * Construct an SMB exception with an NT error code
     *
     * @param ntError int
     */
    public SMBSrvException( int ntError) {
        super( SMBErrorText.ErrorString( SMBStatus.NTErr, ntError));

        // Save the NT error code
        m_NTerror = ntError;

        // Set the older error class/code to an invalid value
        m_errorclass = SMBStatus.InternalErr;
        m_errorcode  = SMBStatus.IntNoShortErrorCode;
    }

    /**
     * Construct an SMB exception with an NT error code and original cause
     *
     * @param ntError int
     * @param cause   Throwable
     */
    public SMBSrvException( int ntError, Throwable cause) {
        super( SMBErrorText.ErrorString( SMBStatus.NTErr, ntError), cause);

        // Save the NT error code
        m_NTerror = ntError;

        // Set the older error class/code to an invalid value
        m_errorclass = SMBStatus.InternalErr;
        m_errorcode  = SMBStatus.IntNoShortErrorCode;
    }

    /**
     * Return the error class for this SMB exception.
     *
     * @return SMB error class.
     */
    public int getErrorClass() {
        return m_errorclass;
    }

    /**
     * Return the error code for this SMB exception
     *
     * @return SMB error code
     */
    public int getErrorCode() {
        return m_errorcode;
    }

    /**
     * Check if the NT error code has been set
     *
     * @return boolean
     */
    public final boolean hasNTErrorCode() {
        return m_NTerror != -1 ? true : false;
    }

    /**
     * Return the NT error code
     *
     * @return int
     */
    public int getNTErrorCode() {
        return m_NTerror;
    }

    /**
     * Return the error text for the SMB exception
     *
     * @return Error text string.
     */
    public String getErrorText() {
        if (getNTErrorCode() != 0)
            return SMBErrorText.ErrorString(SMBStatus.NTErr, getNTErrorCode());
        return SMBErrorText.ErrorString(m_errorclass, m_errorcode);
    }
}