src/main/activemq/connector/openwire/commands/BrokerError.h

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

#ifndef _ACTIVEMQ_CONNECTOR_OPENWIRE_COMMANDS_BROKERERROR_H_
#define _ACTIVEMQ_CONNECTOR_OPENWIRE_COMMANDS_BROKERERROR_H_

#include <activemq/connector/openwire/commands/BaseCommand.h>
#include <activemq/exceptions/NullPointerException.h>

#include <string>
#include <vector>

namespace activemq{
namespace connector{
namespace openwire{
namespace commands{
           
    /**
     * This class represents an Exception sent from the Broker.  The Broker
     * sends java Throwables, so we must mimic its structure here.
     */
    class BrokerError : public BaseCommand<transport::Command>
    {
    public:

        struct StackTraceElement
        {
            std::string ClassName;
            std::string FileName;
            std::string MethodName;
            int LineNumber;
        };

    public:

        BrokerError() {}
        virtual ~BrokerError() {
            for( unsigned int i = 0; i < stackTraceElements.size(); ++i ) {
                delete stackTraceElements[i];
            }
        }

        /**
         * Get the DataStructure Type as defined in CommandTypes.h
         * @return The type of the data structure
         */
        virtual unsigned char getDataStructureType() const {
            return 0;
        }

        /**
         * Clone this obbject and return a new instance that the
         * caller now owns, this will be an exact copy of this one
         * @returns new copy of this object.
         */
        virtual DataStructure* cloneDataStructure() const {

            BrokerError* error = new BrokerError();
            error->copyDataStructure( this );
            return error;
        }            
        
        /**
         * Copy the contents of the passed object into this objects
         * members, overwriting any existing data.
         * @return src - Source Object
         */
        virtual void copyDataStructure( const DataStructure* src ) {
            
            const BrokerError* srcErr = dynamic_cast<const BrokerError*>( src );
            
            if( srcErr == NULL || src == NULL ) {
                throw activemq::exceptions::NullPointerException(
                    __FILE__, __LINE__,
                    "BrokerError::copyCommand - src is NULL or invalid" );
            } 
            
            this->setMessage( srcErr->getMessage() );
            this->setExceptionClass( srcErr->getExceptionClass() );
            
            for( unsigned int i = 0; i < srcErr->getStackTraceElements().size(); ++i ) {
                if( srcErr->getStackTraceElements()[i] != NULL ) {
                    StackTraceElement* element = new StackTraceElement;
                    *element = *( srcErr->getStackTraceElements()[i] );

                    // store the copy
                    this->stackTraceElements.push_back( element );
                }
            }
            
            if( srcErr->getCause() ) {
                this->cause = dynamic_cast<BrokerError*>( 
                    srcErr->getCause()->cloneDataStructure() );
            }
        }

        /**
         * Gets the string holding the error message
         * @returns String Message
         */
        virtual const std::string& getMessage() const {
            return message;
        }
        
        /**
         * Sets the string that contains the error Message
         * @param message - String Error Message
         */
        virtual void setMessage( const std::string& message ) {
            this->message = message;
        }

        /**
         * Gets the string holding the Exception Class name
         * @returns Exception Class name
         */
        virtual const std::string& getExceptionClass() const {
            return exceptionClass;
        }

        /**
         * Sets the string that contains the Exception Class name
         * @param exceptionClass - String Exception Class name
         */
        virtual void setExceptionClass( const std::string& exceptionClass ) {
            this->exceptionClass = exceptionClass;
        }

        /**
         * Gets the Broker Error that caused this exception
         * @returns Broker Error Pointer
         */
        virtual BrokerError* getCause() const {
            return cause;
        }
        
        /**
         * Sets the Broker Error that caused this exception
         * @param cause - Broker Error
         */
        virtual void setCause( BrokerError* cause ) {
            this->cause = cause;
        }

        /**
         * Gets the Stack Trace Elemtns for the Exception
         * @returns Stack Trace Elements
         */
        virtual const std::vector<StackTraceElement*>& getStackTraceElements() const {
            return stackTraceElements;
        }
        
        /**
         * Sets the Stack Trace Elements for this Exception
         * @param stackTraceElements - Stack Trace Elements
         */
        virtual void setStackTraceElements( const std::vector<StackTraceElement*>& stackTraceElements ) {
            this->stackTraceElements = stackTraceElements;
        }
        
    private:

        std::string message;
        std::string exceptionClass;
        std::vector<StackTraceElement*> stackTraceElements;
        BrokerError* cause;

    };

}}}}

#endif /*_ACTIVEMQ_CONNECTOR_OPENWIRE_COMMANDS_BROKERERROR_H_*/