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 package org.apache.logging.log4j.core.net;
18
19 import org.apache.logging.log4j.core.Layout;
20 import org.apache.logging.log4j.core.appender.OutputStreamManager;
21
22 import java.io.OutputStream;
23 import java.io.Serializable;
24 import java.net.InetAddress;
25 import java.util.HashMap;
26 import java.util.Map;
27
28 /**
29 * Abstract base class for managing sockets.
30 */
31 public abstract class AbstractSocketManager extends OutputStreamManager {
32
33 /**
34 * The internet address of the host.
35 */
36 protected final InetAddress address;
37 /**
38 * The name of the host.
39 */
40 protected final String host;
41 /**
42 * The port on the host.
43 */
44 protected final int port;
45
46 /**
47 * The Constructor.
48 * @param name The unique name of this connection.
49 * @param os The OutputStream to manage.
50 * @param addr The internet address.
51 * @param host The target host name.
52 * @param port The target port number.
53 */
54 public AbstractSocketManager(final String name, final OutputStream os, final InetAddress addr, final String host,
55 final int port, final Layout<? extends Serializable> layout) {
56 super(os, name, layout);
57 this.address = addr;
58 this.host = host;
59 this.port = port;
60 }
61
62 /**
63 * AbstractSocketManager's content format is specified by:<p/>
64 * Key: "port" Value: provided "port" param<p/>
65 * Key: "address" Value: provided "address" param
66 * @return Map of content format keys supporting AbstractSocketManager
67 */
68 @Override
69 public Map<String, String> getContentFormat()
70 {
71 final Map<String, String> result = new HashMap<String, String>(super.getContentFormat());
72 result.put("port", Integer.toString(port));
73 result.put("address", address.getHostAddress());
74
75 return result;
76 }
77 }