Google Git
Sign in
apache / logging-log4j-site / d0d0de55986756593c08e5d2b8059541eacaf428 / . / log4j-2.0-alpha1-SNAPSHOT / log4j-api / xref / org / apache / logging / log4j / EventLogger.html
blob: 7afde2cc7e579b166aa5d5d22a08bccf638b1ffd [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8" />
<title>EventLogger xref</title>
<link type="text/css" rel="stylesheet" href="../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../apidocs/org/apache/logging/log4j/EventLogger.html">View Javadoc</a></div><pre>
<a class="jxr_linenumber" name="1" href="#1">1</a> <em class="jxr_comment">/*</em>
<a class="jxr_linenumber" name="2" href="#2">2</a> <em class="jxr_comment"> * Licensed to the Apache Software Foundation (ASF) under one or more</em>
<a class="jxr_linenumber" name="3" href="#3">3</a> <em class="jxr_comment"> * contributor license agreements. See the NOTICE file distributed with</em>
<a class="jxr_linenumber" name="4" href="#4">4</a> <em class="jxr_comment"> * this work for additional information regarding copyright ownership.</em>
<a class="jxr_linenumber" name="5" href="#5">5</a> <em class="jxr_comment"> * The ASF licenses this file to You under the Apache license, Version 2.0</em>
<a class="jxr_linenumber" name="6" href="#6">6</a> <em class="jxr_comment"> * (the "License"); you may not use this file except in compliance with</em>
<a class="jxr_linenumber" name="7" href="#7">7</a> <em class="jxr_comment"> * the License. You may obtain a copy of the License at</em>
<a class="jxr_linenumber" name="8" href="#8">8</a> <em class="jxr_comment"> *</em>
<a class="jxr_linenumber" name="9" href="#9">9</a> <em class="jxr_comment"> * <a href="http://www.apache.org/licenses/LICENSE-2.0" target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a></em>
<a class="jxr_linenumber" name="10" href="#10">10</a> <em class="jxr_comment"> *</em>
<a class="jxr_linenumber" name="11" href="#11">11</a> <em class="jxr_comment"> * Unless required by applicable law or agreed to in writing, software</em>
<a class="jxr_linenumber" name="12" href="#12">12</a> <em class="jxr_comment"> * distributed under the License is distributed on an "AS IS" BASIS,</em>
<a class="jxr_linenumber" name="13" href="#13">13</a> <em class="jxr_comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</em>
<a class="jxr_linenumber" name="14" href="#14">14</a> <em class="jxr_comment"> * See the license for the specific language governing permissions and</em>
<a class="jxr_linenumber" name="15" href="#15">15</a> <em class="jxr_comment"> * limitations under the license.</em>
<a class="jxr_linenumber" name="16" href="#16">16</a> <em class="jxr_comment"> */</em>
<a class="jxr_linenumber" name="17" href="#17">17</a> <strong class="jxr_keyword">package</strong> org.apache.logging.log4j;
<a class="jxr_linenumber" name="18" href="#18">18</a>
<a class="jxr_linenumber" name="19" href="#19">19</a> <strong class="jxr_keyword">import</strong> org.apache.logging.log4j.message.StructuredDataMessage;
<a class="jxr_linenumber" name="20" href="#20">20</a> <strong class="jxr_keyword">import</strong> org.apache.logging.log4j.spi.AbstractLogger;
<a class="jxr_linenumber" name="21" href="#21">21</a> <strong class="jxr_keyword">import</strong> org.apache.logging.log4j.spi.AbstractLoggerWrapper;
<a class="jxr_linenumber" name="22" href="#22">22</a>
<a class="jxr_linenumber" name="23" href="#23">23</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="24" href="#24">24</a> <em class="jxr_javadoccomment"> * Logs "Events" that are represented as StructuredDataMessages.</em>
<a class="jxr_linenumber" name="25" href="#25">25</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="26" href="#26">26</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../org/apache/logging/log4j/EventLogger.html">EventLogger</a> {
<a class="jxr_linenumber" name="27" href="#27">27</a>
<a class="jxr_linenumber" name="28" href="#28">28</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="29" href="#29">29</a> <em class="jxr_javadoccomment"> * Define the Event Marker.</em>
<a class="jxr_linenumber" name="30" href="#30">30</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="31" href="#31">31</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> <a href="../../../../org/apache/logging/log4j/Marker.html">Marker</a> EVENT_MARKER = MarkerManager.getMarker(<span class="jxr_string">"EVENT"</span>);
<a class="jxr_linenumber" name="32" href="#32">32</a>
<a class="jxr_linenumber" name="33" href="#33">33</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String FQCN = EventLogger.<strong class="jxr_keyword">class</strong>.getName();
<a class="jxr_linenumber" name="34" href="#34">34</a>
<a class="jxr_linenumber" name="35" href="#35">35</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <a href="../../../../org/apache/logging/log4j/spi/AbstractLoggerWrapper.html">AbstractLoggerWrapper</a> logger;
<a class="jxr_linenumber" name="36" href="#36">36</a>
<a class="jxr_linenumber" name="37" href="#37">37</a> <strong class="jxr_keyword">static</strong> {
<a class="jxr_linenumber" name="38" href="#38">38</a> <a href="../../../../org/apache/logging/log4j/Logger.html">Logger</a> l = LogManager.getLogger(<span class="jxr_string">"EventLogger"</span>);
<a class="jxr_linenumber" name="39" href="#39">39</a> <strong class="jxr_keyword">if</strong> (!(l instanceof AbstractLogger)) {
<a class="jxr_linenumber" name="40" href="#40">40</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../org/apache/logging/log4j/LoggingException.html">LoggingException</a>(<span class="jxr_string">"Logger returned must be based on AbstractLogger"</span>);
<a class="jxr_linenumber" name="41" href="#41">41</a> }
<a class="jxr_linenumber" name="42" href="#42">42</a> logger = <strong class="jxr_keyword">new</strong> <a href="../../../../org/apache/logging/log4j/spi/AbstractLoggerWrapper.html">AbstractLoggerWrapper</a>((AbstractLogger) l, <span class="jxr_string">"EventLogger"</span>);
<a class="jxr_linenumber" name="43" href="#43">43</a> }
<a class="jxr_linenumber" name="44" href="#44">44</a>
<a class="jxr_linenumber" name="45" href="#45">45</a>
<a class="jxr_linenumber" name="46" href="#46">46</a> <strong class="jxr_keyword">private</strong> <a href="../../../../org/apache/logging/log4j/EventLogger.html">EventLogger</a>() {
<a class="jxr_linenumber" name="47" href="#47">47</a> }
<a class="jxr_linenumber" name="48" href="#48">48</a>
<a class="jxr_linenumber" name="49" href="#49">49</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="50" href="#50">50</a> <em class="jxr_javadoccomment"> * Log events with a level of ALL.</em>
<a class="jxr_linenumber" name="51" href="#51">51</a> <em class="jxr_javadoccomment"> * @param msg The event StructuredDataMessage.</em>
<a class="jxr_linenumber" name="52" href="#52">52</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="53" href="#53">53</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">void</strong> logEvent(<a href="../../../../org/apache/logging/log4j/message/StructuredDataMessage.html">StructuredDataMessage</a> msg) {
<a class="jxr_linenumber" name="54" href="#54">54</a> logger.log(EVENT_MARKER, FQCN, Level.OFF, msg, <strong class="jxr_keyword">null</strong>);
<a class="jxr_linenumber" name="55" href="#55">55</a> }
<a class="jxr_linenumber" name="56" href="#56">56</a>
<a class="jxr_linenumber" name="57" href="#57">57</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="58" href="#58">58</a> <em class="jxr_javadoccomment"> * Log events and specify the logging level.</em>
<a class="jxr_linenumber" name="59" href="#59">59</a> <em class="jxr_javadoccomment"> * @param msg The event StructuredDataMessage.</em>
<a class="jxr_linenumber" name="60" href="#60">60</a> <em class="jxr_javadoccomment"> * @param level The logging Level.</em>
<a class="jxr_linenumber" name="61" href="#61">61</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="62" href="#62">62</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">void</strong> logEvent(<a href="../../../../org/apache/logging/log4j/message/StructuredDataMessage.html">StructuredDataMessage</a> msg, <a href="../../../../org/apache/logging/log4j/Level.html">Level</a> level) {
<a class="jxr_linenumber" name="63" href="#63">63</a> logger.log(EVENT_MARKER, FQCN, level, msg, <strong class="jxr_keyword">null</strong>);
<a class="jxr_linenumber" name="64" href="#64">64</a> }
<a class="jxr_linenumber" name="65" href="#65">65</a> }
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>