RejectLogonException.java

/*******************************************************************************
 * Copyright (c) quickfixengine.org  All rights reserved. 
 * 
 * This file is part of the QuickFIX FIX Engine 
 * 
 * This file may be distributed under the terms of the quickfixengine.org 
 * license as defined by quickfixengine.org and appearing in the file 
 * LICENSE included in the packaging of this file. 
 * 
 * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING 
 * THE WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A 
 * PARTICULAR PURPOSE. 
 * 
 * See http://www.quickfixengine.org/LICENSE for licensing information. 
 * 
 * Contact ask@quickfixengine.org if any conditions of this licensing 
 * are not clear to you.
 ******************************************************************************/

package quickfix;

/**
 * This exception causes a logon to be rejected with a forced logout and immediate disconnect.
 */
public class RejectLogonException extends Exception {

    private final boolean logoutBeforeDisconnect;
    private final int     sessionStatus;

    public RejectLogonException() {
        this(null, true, -1);
    }

    /**
     * @param msg text to print to session event log
     */
    public RejectLogonException(String msg) {
        this(msg, true, -1);
    }

    /**
     * @param msg text to print to session event log
     */
    public RejectLogonException(String msg, int sessionStatus) {
        this(msg, true, sessionStatus);
    }

    /**
     * @param msg text to print to session event log
     * @param logoutBeforeDisconnect controls whether a logout is sent 
     * @param sessionStatus can be used to supply a SessionStatus value
     * before the disconnect, defaults to true.
     */
    public RejectLogonException(String msg, boolean logoutBeforeDisconnect, int sessionStatus) {
        super(msg);
        this.logoutBeforeDisconnect = logoutBeforeDisconnect;
        this.sessionStatus = sessionStatus;
    }
    
    public boolean isLogoutBeforeDisconnect() {
        return logoutBeforeDisconnect ;
    }
    
    public int getSessionStatus() {
        return sessionStatus;
    }
}