odbcappender.h

Go to the documentation of this file.

/*
 * 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 _LOG4CXX_DB_ODBC_APPENDER_H
#define _LOG4CXX_DB_ODBC_APPENDER_H
 
#include <log4cxx/log4cxx.h>
 
#include <log4cxx/helpers/exception.h>
#include <log4cxx/appenderskeleton.h>
#include <log4cxx/spi/loggingevent.h>
 
#if LOG4CXX_EVENTS_AT_EXIT
#include <log4cxx/private/atexitregistry.h>
#endif
 
#include <list>
#include <memory>
 
namespace LOG4CXX_NS
{
namespace db
{
class LOG4CXX_EXPORT SQLException : public LOG4CXX_NS::helpers::Exception
{
    public:
        SQLException(short fHandleType,
            void* hInput, const char* prolog,
            LOG4CXX_NS::helpers::Pool& p);
        SQLException(const char* msg);
        SQLException(const SQLException& src);
    private:
        const char* formatMessage(short fHandleType,
            void* hInput, const char* prolog,
            LOG4CXX_NS::helpers::Pool& p);
};

 
class LOG4CXX_EXPORT ODBCAppender : public AppenderSkeleton
{
    public:
        DECLARE_LOG4CXX_OBJECT(ODBCAppender)
        BEGIN_LOG4CXX_CAST_MAP()
        LOG4CXX_CAST_ENTRY(ODBCAppender)
        LOG4CXX_CAST_ENTRY_CHAIN(AppenderSkeleton)
        END_LOG4CXX_CAST_MAP()
 
        typedef void* SQLHDBC;
        typedef void* SQLHENV;
        typedef void* SQLHANDLE;
        typedef short SQLSMALLINT;
 
        ODBCAppender();
        virtual ~ODBCAppender();

        void setOption(const LogString& option, const LogString& value) override;

        void activateOptions(helpers::Pool& p) override;

        void append(const spi::LoggingEventPtr& event, helpers::Pool&) override;
 
    protected:
#if LOG4CXX_ABI_VERSION <= 15
        LogString getLogStatement(const spi::LoggingEventPtr& event,
            helpers::Pool& p) const;

        virtual void execute(const LogString& sql,
            LOG4CXX_NS::helpers::Pool& p) /*throw(SQLException)*/;
#endif
        virtual void closeConnection(SQLHDBC con);

        virtual SQLHDBC getConnection(LOG4CXX_NS::helpers::Pool& p) /*throw(SQLException)*/;

    public:
        void close() override;

        virtual void flushBuffer(LOG4CXX_NS::helpers::Pool& p);

        bool requiresLayout() const override;

        void setSql(const LogString& s);

        const LogString& getSql() const;
 
 
        void setUser(const LogString& user);
 
        void setURL(const LogString& url);
 
        void setPassword(const LogString& password);
 
        void setBufferSize(size_t newBufferSize);
 
        const LogString& getUser() const;
 
        const LogString& getURL() const;
 
        const LogString& getPassword() const;
 
        size_t getBufferSize() const;
    private:
        ODBCAppender(const ODBCAppender&);
        ODBCAppender& operator=(const ODBCAppender&);
#if LOG4CXX_WCHAR_T_API || LOG4CXX_LOGCHAR_IS_WCHAR_T || defined(WIN32) || defined(_WIN32)
        static void encode(wchar_t** dest, const LogString& src,
            LOG4CXX_NS::helpers::Pool& p);
#endif
        static void encode(unsigned short** dest, const LogString& src,
            LOG4CXX_NS::helpers::Pool& p);
 
    protected:
        struct ODBCAppenderPriv;
}; // class ODBCAppender
LOG4CXX_PTR_DEF(ODBCAppender);
 
} // namespace db
} // namespace log4cxx
 
#endif // _LOG4CXX_DB_ODBC_APPENDER_H