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