Apache Log4cxx  Version 1.3.1
jsonlayout.h
Go to the documentation of this file.
1 /*
2  * Licensed to the Apache Software Foundation (ASF) under one or more
3  * contributor license agreements. See the NOTICE file distributed with
4  * this work for additional information regarding copyright ownership.
5  * The ASF licenses this file to You under the Apache License, Version 2.0
6  * (the "License"); you may not use this file except in compliance with
7  * the License. You may obtain a copy of the License at
8  *
9  * http://www.apache.org/licenses/LICENSE-2.0
10  *
11  * Unless required by applicable law or agreed to in writing, software
12  * distributed under the License is distributed on an "AS IS" BASIS,
13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14  * See the License for the specific language governing permissions and
15  * limitations under the License.
16  */
17 
18 #ifndef _LOG4CXX_JSON_LAYOUT_H
19 #define _LOG4CXX_JSON_LAYOUT_H
20 
21 #include <log4cxx/layout.h>
24 
25 
26 namespace LOG4CXX_NS
27 {
31 class LOG4CXX_EXPORT JSONLayout : public Layout
32 {
33  private:
34  LOG4CXX_DECLARE_PRIVATE_MEMBER_PTR(JSONLayoutPrivate, m_priv)
35 
36  protected:
37  void appendQuotedEscapedString(LogString& buf, const LogString& input) const;
39  const spi::LoggingEventPtr& event) const;
41  const spi::LoggingEventPtr& event) const;
43  const spi::LoggingEventPtr& event, LOG4CXX_NS::helpers::Pool& p) const;
44 
45  public:
46  static void appendItem(const LogString& item, LogString& toAppendTo);
52 
54 
56 
64  void setLocationInfo(bool locationInfoFlag);
65 
66 
70  bool getLocationInfo() const;
71 
79  void setPrettyPrint(bool prettyPrintFlag);
80 
84  bool getPrettyPrint() const;
85 
91  void setThreadInfo(bool newValue);
92 
96  bool getThreadInfo() const;
97 
101  LogString getContentType() const override;
102 
108  void activateOptions(helpers::Pool& /* p */) override;
109 
119  void setOption(const LogString& option, const LogString& value) override;
120 
121  void format(LogString& output,
122  const spi::LoggingEventPtr& event, helpers::Pool& pool) const override;
123 
127  bool ignoresThrowable() const override
128  {
129  return false;
130  }
131 
132 }; // class JSONLayout
134 } // namespace log4cxx
135 
136 #endif // _LOG4CXX_JSON_LAYOUT_H
This layout outputs events in a JSON dictionary.
Definition: jsonlayout.h:32
void appendQuotedEscapedString(LogString &buf, const LogString &input) const
void appendSerializedMDC(LogString &buf, const spi::LoggingEventPtr &event) const
static void appendItem(const LogString &item, LogString &toAppendTo)
void appendSerializedNDC(LogString &buf, const spi::LoggingEventPtr &event) const
void appendSerializedLocationInfo(LogString &buf, const spi::LoggingEventPtr &event, log4cxx::helpers::Pool &p) const
Extend this abstract class to create your own log layout format.
Definition: layout.h:34
std::shared_ptr< LoggingEvent > LoggingEventPtr
Definition: appender.h:31
LOG4CXX_PTR_DEF(JSONLayout)
std::basic_string< logchar > LogString
Definition: logstring.h:60
#define LOG4CXX_CAST_ENTRY(Interface)
Definition: object.h:158
#define END_LOG4CXX_CAST_MAP()
Definition: object.h:152
#define DECLARE_LOG4CXX_OBJECT(object)
Definition: object.h:43
#define LOG4CXX_CAST_ENTRY_CHAIN(Interface)
Definition: object.h:164
#define BEGIN_LOG4CXX_CAST_MAP()
Definition: object.h:146