/**
 * Copyright (C) 2011 Citrix Systems, Inc.  All rights reserved
 *
 * This software is licensed under the GNU General Public License v3 or later.
 *
 * It is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or any later version.
 * This program 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 */
package com.cloud.utils.exception;

import java.util.ArrayList;

import com.cloud.utils.AnnotationHelper;
import com.cloud.utils.IdentityProxy;

/**
 * RuntimeCloudException is a generic exception class that has an IdentityProxy
 * object in it to enable on the fly conversion of database ids to uuids
 * by the API response serializer. Any exceptions that are thrown by
 * command invocations must extend this class, or the CloudException
 * class, which extends Exception instead of RuntimeException like this
 * class does.
 */

public class RuntimeCloudException extends RuntimeException {

    // This holds a list of uuids and their names. Add uuid:fieldname pairs
    // if required, to this list before throwing an exception, using addProxyObject().
    protected ArrayList<IdentityProxy> idList = new ArrayList<IdentityProxy>();

    // This holds an error code. Set this before throwing an exception, if applicable.
    protected int csErrorCode;

    public void addProxyObject(String tableName, Long id, String idFieldName) {
        if (tableName != null) {
            idList.add(new IdentityProxy(tableName, id, idFieldName));
        }
        return;
    }

    public RuntimeCloudException(String message) {
        super(message);
        setCSErrorCode(CSExceptionErrorCode.getCSErrCode(this.getClass().getName()));
    }

    public RuntimeCloudException(String message, Throwable cause) {
        super(message, cause);
        setCSErrorCode(CSExceptionErrorCode.getCSErrCode(this.getClass().getName()));
    }

    public void addProxyObject(Object voObj, Long id, String idFieldName) {
        // Get the VO object's table name.
        if (voObj != null) {
            String tablename = AnnotationHelper.getTableName(voObj);
            if (tablename != null) {
                addProxyObject(tablename, id, idFieldName);
            }
        }
        return;
    }

    public RuntimeCloudException() {
        super();
        setCSErrorCode(CSExceptionErrorCode.getCSErrCode(this.getClass().getName()));
    }

    public ArrayList<IdentityProxy> getIdProxyList() {
        return idList;
    }

    public void setCSErrorCode(int cserrcode) {
        this.csErrorCode = cserrcode;
    }

    public int getCSErrorCode() {
        return this.csErrorCode;
    }
}