<HTML>
<BODY BGCOLOR="white">
<PRE>
<FONT color="green">001</FONT>    /*<a name="line.1"></a>
<FONT color="green">002</FONT>     * Licensed to the Apache Software Foundation (ASF) under one or more<a name="line.2"></a>
<FONT color="green">003</FONT>     * contributor license agreements. See the NOTICE file distributed with<a name="line.3"></a>
<FONT color="green">004</FONT>     * this work for additional information regarding copyright ownership.<a name="line.4"></a>
<FONT color="green">005</FONT>     * The ASF licenses this file to You under the Apache license, Version 2.0<a name="line.5"></a>
<FONT color="green">006</FONT>     * (the "License"); you may not use this file except in compliance with<a name="line.6"></a>
<FONT color="green">007</FONT>     * the License. You may obtain a copy of the License at<a name="line.7"></a>
<FONT color="green">008</FONT>     *<a name="line.8"></a>
<FONT color="green">009</FONT>     *      http://www.apache.org/licenses/LICENSE-2.0<a name="line.9"></a>
<FONT color="green">010</FONT>     *<a name="line.10"></a>
<FONT color="green">011</FONT>     * Unless required by applicable law or agreed to in writing, software<a name="line.11"></a>
<FONT color="green">012</FONT>     * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.12"></a>
<FONT color="green">013</FONT>     * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.13"></a>
<FONT color="green">014</FONT>     * See the license for the specific language governing permissions and<a name="line.14"></a>
<FONT color="green">015</FONT>     * limitations under the license.<a name="line.15"></a>
<FONT color="green">016</FONT>     */<a name="line.16"></a>
<FONT color="green">017</FONT>    package org.apache.logging.log4j.core.appender.rewrite;<a name="line.17"></a>
<FONT color="green">018</FONT>    <a name="line.18"></a>
<FONT color="green">019</FONT>    import org.apache.logging.log4j.Logger;<a name="line.19"></a>
<FONT color="green">020</FONT>    import org.apache.logging.log4j.core.LogEvent;<a name="line.20"></a>
<FONT color="green">021</FONT>    import org.apache.logging.log4j.core.config.plugins.Plugin;<a name="line.21"></a>
<FONT color="green">022</FONT>    import org.apache.logging.log4j.core.config.plugins.PluginAttr;<a name="line.22"></a>
<FONT color="green">023</FONT>    import org.apache.logging.log4j.core.config.plugins.PluginElement;<a name="line.23"></a>
<FONT color="green">024</FONT>    import org.apache.logging.log4j.core.config.plugins.PluginFactory;<a name="line.24"></a>
<FONT color="green">025</FONT>    import org.apache.logging.log4j.core.helpers.KeyValuePair;<a name="line.25"></a>
<FONT color="green">026</FONT>    import org.apache.logging.log4j.core.impl.Log4jLogEvent;<a name="line.26"></a>
<FONT color="green">027</FONT>    import org.apache.logging.log4j.message.MapMessage;<a name="line.27"></a>
<FONT color="green">028</FONT>    import org.apache.logging.log4j.message.Message;<a name="line.28"></a>
<FONT color="green">029</FONT>    import org.apache.logging.log4j.status.StatusLogger;<a name="line.29"></a>
<FONT color="green">030</FONT>    <a name="line.30"></a>
<FONT color="green">031</FONT>    import java.util.HashMap;<a name="line.31"></a>
<FONT color="green">032</FONT>    import java.util.Map;<a name="line.32"></a>
<FONT color="green">033</FONT>    <a name="line.33"></a>
<FONT color="green">034</FONT>    /**<a name="line.34"></a>
<FONT color="green">035</FONT>     * This policy modifies events by replacing or possibly adding keys and values to the MapMessage.<a name="line.35"></a>
<FONT color="green">036</FONT>     */<a name="line.36"></a>
<FONT color="green">037</FONT>    @Plugin(name = "MapRewritePolicy", type = "Core", elementType = "rewritePolicy", printObject = true)<a name="line.37"></a>
<FONT color="green">038</FONT>    public final class MapRewritePolicy implements RewritePolicy {<a name="line.38"></a>
<FONT color="green">039</FONT>        /**<a name="line.39"></a>
<FONT color="green">040</FONT>         * Allow subclasses access to the status logger without creating another instance.<a name="line.40"></a>
<FONT color="green">041</FONT>         */<a name="line.41"></a>
<FONT color="green">042</FONT>        protected static final Logger LOGGER = StatusLogger.getLogger();<a name="line.42"></a>
<FONT color="green">043</FONT>    <a name="line.43"></a>
<FONT color="green">044</FONT>        private final Map&lt;String, String&gt; map;<a name="line.44"></a>
<FONT color="green">045</FONT>    <a name="line.45"></a>
<FONT color="green">046</FONT>        private final Mode mode;<a name="line.46"></a>
<FONT color="green">047</FONT>    <a name="line.47"></a>
<FONT color="green">048</FONT>        private MapRewritePolicy(Map&lt;String, String&gt; map, Mode mode) {<a name="line.48"></a>
<FONT color="green">049</FONT>            this.map = map;<a name="line.49"></a>
<FONT color="green">050</FONT>            this.mode = mode;<a name="line.50"></a>
<FONT color="green">051</FONT>        }<a name="line.51"></a>
<FONT color="green">052</FONT>    <a name="line.52"></a>
<FONT color="green">053</FONT>        /**<a name="line.53"></a>
<FONT color="green">054</FONT>         * Rewrite the event.<a name="line.54"></a>
<FONT color="green">055</FONT>         * @param source a logging event that may be returned or<a name="line.55"></a>
<FONT color="green">056</FONT>         * used to create a new logging event.<a name="line.56"></a>
<FONT color="green">057</FONT>         * @return The LogEvent after rewriting.<a name="line.57"></a>
<FONT color="green">058</FONT>         */<a name="line.58"></a>
<FONT color="green">059</FONT>        public LogEvent rewrite(LogEvent source) {<a name="line.59"></a>
<FONT color="green">060</FONT>            Message msg = source.getMessage();<a name="line.60"></a>
<FONT color="green">061</FONT>            if (msg == null || !(msg instanceof MapMessage)) {<a name="line.61"></a>
<FONT color="green">062</FONT>                return source;<a name="line.62"></a>
<FONT color="green">063</FONT>            }<a name="line.63"></a>
<FONT color="green">064</FONT>    <a name="line.64"></a>
<FONT color="green">065</FONT>            Map&lt;String, String&gt; newMap = new HashMap&lt;String, String&gt;(((MapMessage) msg).getData());<a name="line.65"></a>
<FONT color="green">066</FONT>            switch (mode) {<a name="line.66"></a>
<FONT color="green">067</FONT>                case Add: {<a name="line.67"></a>
<FONT color="green">068</FONT>                    newMap.putAll(map);<a name="line.68"></a>
<FONT color="green">069</FONT>                    break;<a name="line.69"></a>
<FONT color="green">070</FONT>                }<a name="line.70"></a>
<FONT color="green">071</FONT>                default: {<a name="line.71"></a>
<FONT color="green">072</FONT>                    for (Map.Entry&lt;String, String&gt; entry : map.entrySet()) {<a name="line.72"></a>
<FONT color="green">073</FONT>                        if (newMap.containsKey(entry.getKey())) {<a name="line.73"></a>
<FONT color="green">074</FONT>                            newMap.put(entry.getKey(), entry.getValue());<a name="line.74"></a>
<FONT color="green">075</FONT>                        }<a name="line.75"></a>
<FONT color="green">076</FONT>                    }<a name="line.76"></a>
<FONT color="green">077</FONT>                }<a name="line.77"></a>
<FONT color="green">078</FONT>            }<a name="line.78"></a>
<FONT color="green">079</FONT>            newMap.putAll(map);<a name="line.79"></a>
<FONT color="green">080</FONT>            MapMessage message = ((MapMessage) msg).newInstance(newMap);<a name="line.80"></a>
<FONT color="green">081</FONT>            return new Log4jLogEvent(source.getLoggerName(), source.getMarker(), source.getFQCN(), source.getLevel(),<a name="line.81"></a>
<FONT color="green">082</FONT>                message, source.getThrown(), source.getContextMap(), source.getContextStack(), source.getThreadName(),<a name="line.82"></a>
<FONT color="green">083</FONT>                source.getSource(), source.getMillis());<a name="line.83"></a>
<FONT color="green">084</FONT>        }<a name="line.84"></a>
<FONT color="green">085</FONT>    <a name="line.85"></a>
<FONT color="green">086</FONT>        /**<a name="line.86"></a>
<FONT color="green">087</FONT>         * An enumeration to identify whether keys not in the MapMessage should be added or whether only existing<a name="line.87"></a>
<FONT color="green">088</FONT>         * keys should be updated.<a name="line.88"></a>
<FONT color="green">089</FONT>         */<a name="line.89"></a>
<FONT color="green">090</FONT>        public enum Mode {<a name="line.90"></a>
<FONT color="green">091</FONT>            /**<a name="line.91"></a>
<FONT color="green">092</FONT>             * Keys should be added.<a name="line.92"></a>
<FONT color="green">093</FONT>             */<a name="line.93"></a>
<FONT color="green">094</FONT>            Add,<a name="line.94"></a>
<FONT color="green">095</FONT>            /**<a name="line.95"></a>
<FONT color="green">096</FONT>             * Keys should be updated.<a name="line.96"></a>
<FONT color="green">097</FONT>             */<a name="line.97"></a>
<FONT color="green">098</FONT>            Update<a name="line.98"></a>
<FONT color="green">099</FONT>        }<a name="line.99"></a>
<FONT color="green">100</FONT>    <a name="line.100"></a>
<FONT color="green">101</FONT>        @Override<a name="line.101"></a>
<FONT color="green">102</FONT>        public String toString() {<a name="line.102"></a>
<FONT color="green">103</FONT>            StringBuilder sb = new StringBuilder();<a name="line.103"></a>
<FONT color="green">104</FONT>            sb.append("mode=").append(mode);<a name="line.104"></a>
<FONT color="green">105</FONT>            sb.append(" {");<a name="line.105"></a>
<FONT color="green">106</FONT>            boolean first = true;<a name="line.106"></a>
<FONT color="green">107</FONT>            for (Map.Entry&lt;String, String&gt; entry : map.entrySet()) {<a name="line.107"></a>
<FONT color="green">108</FONT>                if (!first) {<a name="line.108"></a>
<FONT color="green">109</FONT>                    sb.append(", ");<a name="line.109"></a>
<FONT color="green">110</FONT>                }<a name="line.110"></a>
<FONT color="green">111</FONT>                sb.append(entry.getKey()).append("=").append(entry.getValue());<a name="line.111"></a>
<FONT color="green">112</FONT>                first = false;<a name="line.112"></a>
<FONT color="green">113</FONT>            }<a name="line.113"></a>
<FONT color="green">114</FONT>            sb.append("}");<a name="line.114"></a>
<FONT color="green">115</FONT>            return sb.toString();<a name="line.115"></a>
<FONT color="green">116</FONT>        }<a name="line.116"></a>
<FONT color="green">117</FONT>    <a name="line.117"></a>
<FONT color="green">118</FONT>        /**<a name="line.118"></a>
<FONT color="green">119</FONT>         * The factory method to create the MapRewritePolicy.<a name="line.119"></a>
<FONT color="green">120</FONT>         * @param mode The string representation of the Mode.<a name="line.120"></a>
<FONT color="green">121</FONT>         * @param pairs key/value pairs for the new Map keys and values.<a name="line.121"></a>
<FONT color="green">122</FONT>         * @return The MapRewritePolicy.<a name="line.122"></a>
<FONT color="green">123</FONT>         */<a name="line.123"></a>
<FONT color="green">124</FONT>        @PluginFactory<a name="line.124"></a>
<FONT color="green">125</FONT>        public static MapRewritePolicy createPolicy(@PluginAttr("mode") String mode,<a name="line.125"></a>
<FONT color="green">126</FONT>                                                    @PluginElement("KeyValuePair") KeyValuePair[] pairs) {<a name="line.126"></a>
<FONT color="green">127</FONT>            Mode op;<a name="line.127"></a>
<FONT color="green">128</FONT>            if (mode == null) {<a name="line.128"></a>
<FONT color="green">129</FONT>                op = Mode.Add;<a name="line.129"></a>
<FONT color="green">130</FONT>            } else {<a name="line.130"></a>
<FONT color="green">131</FONT>                op = Mode.valueOf(mode);<a name="line.131"></a>
<FONT color="green">132</FONT>                if (op == null) {<a name="line.132"></a>
<FONT color="green">133</FONT>                    LOGGER.error("Undefined mode " + mode);<a name="line.133"></a>
<FONT color="green">134</FONT>                    return null;<a name="line.134"></a>
<FONT color="green">135</FONT>                }<a name="line.135"></a>
<FONT color="green">136</FONT>            }<a name="line.136"></a>
<FONT color="green">137</FONT>            if (pairs == null || pairs.length == 0) {<a name="line.137"></a>
<FONT color="green">138</FONT>                LOGGER.error("keys and values must be specified for the MapRewritePolicy");<a name="line.138"></a>
<FONT color="green">139</FONT>                return null;<a name="line.139"></a>
<FONT color="green">140</FONT>            }<a name="line.140"></a>
<FONT color="green">141</FONT>            Map&lt;String, String&gt; map = new HashMap&lt;String, String&gt;();<a name="line.141"></a>
<FONT color="green">142</FONT>            for (KeyValuePair pair : pairs) {<a name="line.142"></a>
<FONT color="green">143</FONT>                String key = pair.getKey();<a name="line.143"></a>
<FONT color="green">144</FONT>                if (key == null) {<a name="line.144"></a>
<FONT color="green">145</FONT>                    LOGGER.error("A null key is not valid in MapRewritePolicy");<a name="line.145"></a>
<FONT color="green">146</FONT>                    continue;<a name="line.146"></a>
<FONT color="green">147</FONT>                }<a name="line.147"></a>
<FONT color="green">148</FONT>                String value = pair.getValue();<a name="line.148"></a>
<FONT color="green">149</FONT>                if (value == null) {<a name="line.149"></a>
<FONT color="green">150</FONT>                    LOGGER.error("A null value for key " + key + " is not allowed in MapRewritePolicy");<a name="line.150"></a>
<FONT color="green">151</FONT>                    continue;<a name="line.151"></a>
<FONT color="green">152</FONT>                }<a name="line.152"></a>
<FONT color="green">153</FONT>                map.put(pair.getKey(), pair.getValue());<a name="line.153"></a>
<FONT color="green">154</FONT>            }<a name="line.154"></a>
<FONT color="green">155</FONT>            if (map.size() == 0) {<a name="line.155"></a>
<FONT color="green">156</FONT>                LOGGER.error("MapRewritePolicy is not configured with any valid key value pairs");<a name="line.156"></a>
<FONT color="green">157</FONT>                return null;<a name="line.157"></a>
<FONT color="green">158</FONT>            }<a name="line.158"></a>
<FONT color="green">159</FONT>            return new MapRewritePolicy(map, op);<a name="line.159"></a>
<FONT color="green">160</FONT>        }<a name="line.160"></a>
<FONT color="green">161</FONT>    }<a name="line.161"></a>


</PRE>
</BODY>
</HTML>