1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17 package org.apache.logging.log4j.core.appender;
18
19 import org.apache.logging.log4j.core.Filter;
20 import org.apache.logging.log4j.core.Layout;
21 import org.apache.logging.log4j.core.config.Configuration;
22 import org.apache.logging.log4j.core.config.plugins.Plugin;
23 import org.apache.logging.log4j.core.config.plugins.PluginAttr;
24 import org.apache.logging.log4j.core.config.plugins.PluginConfiguration;
25 import org.apache.logging.log4j.core.config.plugins.PluginElement;
26 import org.apache.logging.log4j.core.config.plugins.PluginFactory;
27 import org.apache.logging.log4j.core.layout.SerializedLayout;
28 import org.apache.logging.log4j.core.net.AbstractSocketManager;
29 import org.apache.logging.log4j.core.net.Advertiser;
30 import org.apache.logging.log4j.core.net.DatagramSocketManager;
31 import org.apache.logging.log4j.core.net.Protocol;
32 import org.apache.logging.log4j.core.net.TCPSocketManager;
33 import org.apache.logging.log4j.util.EnglishEnums;
34
35 import java.io.Serializable;
36 import java.util.HashMap;
37 import java.util.Map;
38
39
40
41
42 @Plugin(name = "Socket", category = "Core", elementType = "appender", printObject = true)
43 public class SocketAppender<T extends Serializable> extends AbstractOutputStreamAppender<T> {
44 private Object advertisement;
45 private final Advertiser advertiser;
46
47 protected SocketAppender(final String name, final Layout<T> layout, final Filter filter,
48 final AbstractSocketManager manager, final boolean handleException,
49 final boolean immediateFlush, Advertiser advertiser) {
50 super(name, layout, filter, handleException, immediateFlush, manager);
51 if (advertiser != null)
52 {
53 Map<String, String> configuration = new HashMap<String, String>(layout.getContentFormat());
54 configuration.putAll(manager.getContentFormat());
55 configuration.put("contentType", layout.getContentType());
56 configuration.put("name", name);
57 advertisement = advertiser.advertise(configuration);
58 }
59 this.advertiser = advertiser;
60 }
61
62 @Override
63 public void stop() {
64 super.stop();
65 if (advertiser != null) {
66 advertiser.unadvertise(advertisement);
67 }
68 }
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87 @PluginFactory
88 public static <S extends Serializable> SocketAppender<S> createAppender(@PluginAttr("host") final String host,
89 @PluginAttr("port") final String portNum,
90 @PluginAttr("protocol") final String protocol,
91 @PluginAttr("reconnectionDelay") final String delay,
92 @PluginAttr("immediateFail") final String immediateFail,
93 @PluginAttr("name") final String name,
94 @PluginAttr("immediateFlush") final String immediateFlush,
95 @PluginAttr("suppressExceptions") final String suppress,
96 @PluginElement("layout") Layout<S> layout,
97 @PluginElement("filters") final Filter filter,
98 @PluginAttr("advertise") final String advertise,
99 @PluginConfiguration final Configuration config) {
100
101 boolean isFlush = immediateFlush == null ? true : Boolean.valueOf(immediateFlush);
102 boolean isAdvertise = advertise == null ? false : Boolean.valueOf(advertise);
103 final boolean handleExceptions = suppress == null ? true : Boolean.valueOf(suppress);
104 final boolean fail = immediateFail == null ? true : Boolean.valueOf(immediateFail);
105 final int reconnectDelay = delay == null ? 0 : Integer.parseInt(delay);
106 final int port = portNum == null ? 0 : Integer.parseInt(portNum);
107 if (layout == null) {
108 @SuppressWarnings({"unchecked", "UnnecessaryLocalVariable"})
109 Layout<S> l = (Layout<S>) SerializedLayout.createLayout();
110 layout = l;
111 }
112
113 if (name == null) {
114 LOGGER.error("No name provided for SocketAppender");
115 return null;
116 }
117
118 final String prot = protocol != null ? protocol : Protocol.TCP.name();
119 final Protocol p = EnglishEnums.valueOf(Protocol.class, protocol);
120 if (p.equals(Protocol.UDP)) {
121 isFlush = true;
122 }
123
124 final AbstractSocketManager manager = createSocketManager(p, host, port, reconnectDelay, fail, layout);
125 if (manager == null) {
126 return null;
127 }
128
129 return new SocketAppender<S>(name, layout, filter, manager, handleExceptions, isFlush,
130 isAdvertise ? config.getAdvertiser() : null);
131 }
132
133 protected static AbstractSocketManager createSocketManager(final Protocol p, final String host, final int port,
134 final int delay, final boolean immediateFail,
135 final Layout layout) {
136 switch (p) {
137 case TCP:
138 return TCPSocketManager.getSocketManager(host, port, delay, immediateFail, layout);
139 case UDP:
140 return DatagramSocketManager.getSocketManager(host, port, layout);
141 default:
142 return null;
143 }
144 }
145 }