Google Git
Sign in
apache / logging-site / a4f88a44f9ece0268ea2d36ba57a00f2b881cabc / . / content / log4j / 2.13.1 / log4j-slf4j-impl / apidocs / src-html / org / apache / logging / slf4j / Log4jMarkerFactory.html
blob: 1595b1b5cc758596b7749507c1afc5218b6ccf49 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="en">
<head>
<title>Source code</title>
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
</head>
<body>
<div class="sourceContainer">
<pre><span class="sourceLineNo">001</span>/*<a name="line.1"></a>
<span class="sourceLineNo">002</span> * Licensed to the Apache Software Foundation (ASF) under one or more<a name="line.2"></a>
<span class="sourceLineNo">003</span> * contributor license agreements. See the NOTICE file distributed with<a name="line.3"></a>
<span class="sourceLineNo">004</span> * this work for additional information regarding copyright ownership.<a name="line.4"></a>
<span class="sourceLineNo">005</span> * The ASF licenses this file to You under the Apache license, Version 2.0<a name="line.5"></a>
<span class="sourceLineNo">006</span> * (the "License"); you may not use this file except in compliance with<a name="line.6"></a>
<span class="sourceLineNo">007</span> * the License. You may obtain a copy of the License at<a name="line.7"></a>
<span class="sourceLineNo">008</span> *<a name="line.8"></a>
<span class="sourceLineNo">009</span> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.9"></a>
<span class="sourceLineNo">010</span> *<a name="line.10"></a>
<span class="sourceLineNo">011</span> * Unless required by applicable law or agreed to in writing, software<a name="line.11"></a>
<span class="sourceLineNo">012</span> * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.12"></a>
<span class="sourceLineNo">013</span> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.13"></a>
<span class="sourceLineNo">014</span> * See the license for the specific language governing permissions and<a name="line.14"></a>
<span class="sourceLineNo">015</span> * limitations under the license.<a name="line.15"></a>
<span class="sourceLineNo">016</span> */<a name="line.16"></a>
<span class="sourceLineNo">017</span>package org.apache.logging.slf4j;<a name="line.17"></a>
<span class="sourceLineNo">018</span><a name="line.18"></a>
<span class="sourceLineNo">019</span>import java.util.ArrayList;<a name="line.19"></a>
<span class="sourceLineNo">020</span>import java.util.Collection;<a name="line.20"></a>
<span class="sourceLineNo">021</span>import java.util.Iterator;<a name="line.21"></a>
<span class="sourceLineNo">022</span>import java.util.concurrent.ConcurrentHashMap;<a name="line.22"></a>
<span class="sourceLineNo">023</span>import java.util.concurrent.ConcurrentMap;<a name="line.23"></a>
<span class="sourceLineNo">024</span><a name="line.24"></a>
<span class="sourceLineNo">025</span>import org.apache.logging.log4j.Logger;<a name="line.25"></a>
<span class="sourceLineNo">026</span>import org.apache.logging.log4j.MarkerManager;<a name="line.26"></a>
<span class="sourceLineNo">027</span>import org.apache.logging.log4j.status.StatusLogger;<a name="line.27"></a>
<span class="sourceLineNo">028</span>import org.slf4j.IMarkerFactory;<a name="line.28"></a>
<span class="sourceLineNo">029</span>import org.slf4j.Marker;<a name="line.29"></a>
<span class="sourceLineNo">030</span><a name="line.30"></a>
<span class="sourceLineNo">031</span>/**<a name="line.31"></a>
<span class="sourceLineNo">032</span> * Log4j/SLF4J bridge to create SLF4J Markers based on name or based on existing SLF4J Markers.<a name="line.32"></a>
<span class="sourceLineNo">033</span> */<a name="line.33"></a>
<span class="sourceLineNo">034</span>public class Log4jMarkerFactory implements IMarkerFactory {<a name="line.34"></a>
<span class="sourceLineNo">035</span><a name="line.35"></a>
<span class="sourceLineNo">036</span> private static final Logger LOGGER = StatusLogger.getLogger();<a name="line.36"></a>
<span class="sourceLineNo">037</span><a name="line.37"></a>
<span class="sourceLineNo">038</span> private final ConcurrentMap&lt;String, Marker&gt; markerMap = new ConcurrentHashMap&lt;&gt;();<a name="line.38"></a>
<span class="sourceLineNo">039</span><a name="line.39"></a>
<span class="sourceLineNo">040</span> /**<a name="line.40"></a>
<span class="sourceLineNo">041</span> * Returns a Log4j Marker that is compatible with SLF4J.<a name="line.41"></a>
<span class="sourceLineNo">042</span> * @param name The name of the Marker.<a name="line.42"></a>
<span class="sourceLineNo">043</span> * @return A Marker.<a name="line.43"></a>
<span class="sourceLineNo">044</span> */<a name="line.44"></a>
<span class="sourceLineNo">045</span> @Override<a name="line.45"></a>
<span class="sourceLineNo">046</span> public Marker getMarker(final String name) {<a name="line.46"></a>
<span class="sourceLineNo">047</span> if (name == null) {<a name="line.47"></a>
<span class="sourceLineNo">048</span> throw new IllegalArgumentException("Marker name must not be null");<a name="line.48"></a>
<span class="sourceLineNo">049</span> }<a name="line.49"></a>
<span class="sourceLineNo">050</span> final Marker marker = markerMap.get(name);<a name="line.50"></a>
<span class="sourceLineNo">051</span> if (marker != null) {<a name="line.51"></a>
<span class="sourceLineNo">052</span> return marker;<a name="line.52"></a>
<span class="sourceLineNo">053</span> }<a name="line.53"></a>
<span class="sourceLineNo">054</span> final org.apache.logging.log4j.Marker log4jMarker = MarkerManager.getMarker(name);<a name="line.54"></a>
<span class="sourceLineNo">055</span> return addMarkerIfAbsent(name, log4jMarker);<a name="line.55"></a>
<span class="sourceLineNo">056</span> }<a name="line.56"></a>
<span class="sourceLineNo">057</span><a name="line.57"></a>
<span class="sourceLineNo">058</span> private Marker addMarkerIfAbsent(final String name, final org.apache.logging.log4j.Marker log4jMarker) {<a name="line.58"></a>
<span class="sourceLineNo">059</span> final Marker marker = new Log4jMarker(log4jMarker);<a name="line.59"></a>
<span class="sourceLineNo">060</span> final Marker existing = markerMap.putIfAbsent(name, marker);<a name="line.60"></a>
<span class="sourceLineNo">061</span> return existing == null ? marker : existing;<a name="line.61"></a>
<span class="sourceLineNo">062</span> }<a name="line.62"></a>
<span class="sourceLineNo">063</span><a name="line.63"></a>
<span class="sourceLineNo">064</span> /**<a name="line.64"></a>
<span class="sourceLineNo">065</span> * Returns a Log4j Marker converted from an existing custom SLF4J Marker.<a name="line.65"></a>
<span class="sourceLineNo">066</span> * @param marker The SLF4J Marker to convert.<a name="line.66"></a>
<span class="sourceLineNo">067</span> * @return A converted Log4j/SLF4J Marker.<a name="line.67"></a>
<span class="sourceLineNo">068</span> * @since 2.1<a name="line.68"></a>
<span class="sourceLineNo">069</span> */<a name="line.69"></a>
<span class="sourceLineNo">070</span> public Marker getMarker(final Marker marker) {<a name="line.70"></a>
<span class="sourceLineNo">071</span> if (marker == null) {<a name="line.71"></a>
<span class="sourceLineNo">072</span> throw new IllegalArgumentException("Marker must not be null");<a name="line.72"></a>
<span class="sourceLineNo">073</span> }<a name="line.73"></a>
<span class="sourceLineNo">074</span> final Marker m = markerMap.get(marker.getName());<a name="line.74"></a>
<span class="sourceLineNo">075</span> if (m != null) {<a name="line.75"></a>
<span class="sourceLineNo">076</span> return m;<a name="line.76"></a>
<span class="sourceLineNo">077</span> }<a name="line.77"></a>
<span class="sourceLineNo">078</span> return addMarkerIfAbsent(marker.getName(), convertMarker(marker));<a name="line.78"></a>
<span class="sourceLineNo">079</span> }<a name="line.79"></a>
<span class="sourceLineNo">080</span><a name="line.80"></a>
<span class="sourceLineNo">081</span> private static org.apache.logging.log4j.Marker convertMarker(final Marker original) {<a name="line.81"></a>
<span class="sourceLineNo">082</span> if (original == null) {<a name="line.82"></a>
<span class="sourceLineNo">083</span> throw new IllegalArgumentException("Marker must not be null");<a name="line.83"></a>
<span class="sourceLineNo">084</span> }<a name="line.84"></a>
<span class="sourceLineNo">085</span> return convertMarker(original, new ArrayList&lt;Marker&gt;());<a name="line.85"></a>
<span class="sourceLineNo">086</span> }<a name="line.86"></a>
<span class="sourceLineNo">087</span><a name="line.87"></a>
<span class="sourceLineNo">088</span> private static org.apache.logging.log4j.Marker convertMarker(final Marker original,<a name="line.88"></a>
<span class="sourceLineNo">089</span> final Collection&lt;Marker&gt; visited) {<a name="line.89"></a>
<span class="sourceLineNo">090</span> final org.apache.logging.log4j.Marker marker = MarkerManager.getMarker(original.getName());<a name="line.90"></a>
<span class="sourceLineNo">091</span> if (original.hasReferences()) {<a name="line.91"></a>
<span class="sourceLineNo">092</span> final Iterator&lt;Marker&gt; it = original.iterator();<a name="line.92"></a>
<span class="sourceLineNo">093</span> while (it.hasNext()) {<a name="line.93"></a>
<span class="sourceLineNo">094</span> final Marker next = it.next();<a name="line.94"></a>
<span class="sourceLineNo">095</span> if (visited.contains(next)) {<a name="line.95"></a>
<span class="sourceLineNo">096</span> LOGGER.warn("Found a cycle in Marker [{}]. Cycle will be broken.", next.getName());<a name="line.96"></a>
<span class="sourceLineNo">097</span> } else {<a name="line.97"></a>
<span class="sourceLineNo">098</span> visited.add(next);<a name="line.98"></a>
<span class="sourceLineNo">099</span> marker.addParents(convertMarker(next, visited));<a name="line.99"></a>
<span class="sourceLineNo">100</span> }<a name="line.100"></a>
<span class="sourceLineNo">101</span> }<a name="line.101"></a>
<span class="sourceLineNo">102</span> }<a name="line.102"></a>
<span class="sourceLineNo">103</span> return marker;<a name="line.103"></a>
<span class="sourceLineNo">104</span> }<a name="line.104"></a>
<span class="sourceLineNo">105</span><a name="line.105"></a>
<span class="sourceLineNo">106</span> /**<a name="line.106"></a>
<span class="sourceLineNo">107</span> * Returns true if the Marker exists.<a name="line.107"></a>
<span class="sourceLineNo">108</span> * @param name The Marker name.<a name="line.108"></a>
<span class="sourceLineNo">109</span> * @return {@code true} if the Marker exists, {@code false} otherwise.<a name="line.109"></a>
<span class="sourceLineNo">110</span> */<a name="line.110"></a>
<span class="sourceLineNo">111</span> @Override<a name="line.111"></a>
<span class="sourceLineNo">112</span> public boolean exists(final String name) {<a name="line.112"></a>
<span class="sourceLineNo">113</span> return markerMap.containsKey(name);<a name="line.113"></a>
<span class="sourceLineNo">114</span> }<a name="line.114"></a>
<span class="sourceLineNo">115</span><a name="line.115"></a>
<span class="sourceLineNo">116</span> /**<a name="line.116"></a>
<span class="sourceLineNo">117</span> * Log4j does not support detached Markers. This method always returns false.<a name="line.117"></a>
<span class="sourceLineNo">118</span> * @param name The Marker name.<a name="line.118"></a>
<span class="sourceLineNo">119</span> * @return {@code false}<a name="line.119"></a>
<span class="sourceLineNo">120</span> */<a name="line.120"></a>
<span class="sourceLineNo">121</span> @Override<a name="line.121"></a>
<span class="sourceLineNo">122</span> public boolean detachMarker(final String name) {<a name="line.122"></a>
<span class="sourceLineNo">123</span> return false;<a name="line.123"></a>
<span class="sourceLineNo">124</span> }<a name="line.124"></a>
<span class="sourceLineNo">125</span><a name="line.125"></a>
<span class="sourceLineNo">126</span> /**<a name="line.126"></a>
<span class="sourceLineNo">127</span> * Log4j does not support detached Markers for performance reasons. The returned Marker is attached.<a name="line.127"></a>
<span class="sourceLineNo">128</span> * @param name The Marker name.<a name="line.128"></a>
<span class="sourceLineNo">129</span> * @return The named Marker (unmodified).<a name="line.129"></a>
<span class="sourceLineNo">130</span> */<a name="line.130"></a>
<span class="sourceLineNo">131</span> @Override<a name="line.131"></a>
<span class="sourceLineNo">132</span> public Marker getDetachedMarker(final String name) {<a name="line.132"></a>
<span class="sourceLineNo">133</span> LOGGER.warn("Log4j does not support detached Markers. Returned Marker [{}] will be unchanged.", name);<a name="line.133"></a>
<span class="sourceLineNo">134</span> return getMarker(name);<a name="line.134"></a>
<span class="sourceLineNo">135</span> }<a name="line.135"></a>
<span class="sourceLineNo">136</span><a name="line.136"></a>
<span class="sourceLineNo">137</span><a name="line.137"></a>
<span class="sourceLineNo">138</span>}<a name="line.138"></a>
</pre>
</div>
</body>
</html>