propertyconfigurator.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_PROPERTY_CONFIGURATOR_H
#define _LOG4CXX_PROPERTY_CONFIGURATOR_H
 
#include <log4cxx/helpers/object.h>
#include <log4cxx/logstring.h>
#include <log4cxx/spi/configurator.h>
#include <map>
 
#include <log4cxx/file.h>
 
namespace LOG4CXX_NS
{
namespace helpers
{
class Properties;
}

class LOG4CXX_EXPORT PropertyConfigurator
    : public spi::Configurator
{
    private:
        LOG4CXX_DECLARE_PRIVATE_MEMBER_PTR(PrivateData, m_priv)
    public:
        DECLARE_LOG4CXX_OBJECT(PropertyConfigurator)
        BEGIN_LOG4CXX_CAST_MAP()
        LOG4CXX_CAST_ENTRY(PropertyConfigurator)
        LOG4CXX_CAST_ENTRY_CHAIN(spi::Configurator)
        END_LOG4CXX_CAST_MAP()
 
        PropertyConfigurator();
        virtual ~PropertyConfigurator();
        spi::ConfigurationStatus doConfigure
            ( const File&                     configFileName
            , const spi::LoggerRepositoryPtr& target = {}
            ) override;

        static spi::ConfigurationStatus configure(const File& configFilename);

        static spi::ConfigurationStatus configureAndWatch
            ( const File& configFilename
            , long        millisecondDelay = 0
            );

        static spi::ConfigurationStatus configure(helpers::Properties& properties);

        spi::ConfigurationStatus doConfigure
            ( helpers::Properties&            properties
            , const spi::LoggerRepositoryPtr& target
            );
    private:
        PropertyConfigurator(const PropertyConfigurator&);
        PropertyConfigurator& operator=(const PropertyConfigurator&);
}; // class PropertyConfigurator
}  // namespace log4cxx
 
 
#endif //_LOG4CXX_PROPERTY_CONFIGURATOR_H