001/*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements. See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache license, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License. You may obtain a copy of the License at
008 *
009 *      http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the license for the specific language governing permissions and
015 * limitations under the license.
016 */
017package org.apache.logging.log4j.core.net;
018
019import org.apache.logging.log4j.core.Layout;
020import org.apache.logging.log4j.core.appender.ManagerFactory;
021import org.apache.logging.log4j.core.helpers.Strings;
022
023import java.io.OutputStream;
024import java.io.Serializable;
025import java.net.InetAddress;
026import java.net.UnknownHostException;
027import java.util.HashMap;
028import java.util.Map;
029
030/**
031 * Socket Manager for UDP connections.
032 */
033public class DatagramSocketManager extends AbstractSocketManager {
034
035    private static final DatagramSocketManagerFactory FACTORY = new DatagramSocketManagerFactory();
036
037    /**
038     * The Constructor.
039     * @param name The unique name of the connection.
040     * @param os The OutputStream.
041     * @param address
042     * @param host The host to connect to.
043     * @param port The port on the host.
044     * @param layout The layout
045     */
046    protected DatagramSocketManager(final String name, final OutputStream os, final InetAddress address, final String host,
047                final int port, final Layout<? extends Serializable> layout) {
048        super(name, os, address, host, port, layout);
049    }
050
051    /**
052     * Obtain a SocketManager.
053     * @param host The host to connect to.
054     * @param port The port on the host.
055     * @param layout The layout.
056     * @return A DatagramSocketManager.
057     */
058    public static DatagramSocketManager getSocketManager(final String host, final int port, final Layout<? extends Serializable> layout) {
059        if (Strings.isEmpty(host)) {
060            throw new IllegalArgumentException("A host name is required");
061        }
062        if (port <= 0) {
063            throw new IllegalArgumentException("A port value is required");
064        }
065        return (DatagramSocketManager) getManager("UDP:" + host + ":" + port, new FactoryData(host, port, layout),
066            FACTORY);
067    }
068
069    /**
070     * DatagramSocketManager's content format is specified by:<p/>
071     * Key: "protocol" Value: "udp"<p/>
072     * Key: "direction" Value: "out"
073     * @return Map of content format keys supporting DatagramSocketManager
074     */
075    @Override
076    public Map<String, String> getContentFormat()
077    {
078        final Map<String, String> result = new HashMap<String, String>(super.getContentFormat());
079        result.put("protocol", "udp");
080        result.put("direction", "out");
081
082        return result;
083    }
084
085    /**
086     * Data for the factory.
087     */
088    private static class FactoryData {
089        private final String host;
090        private final int port;
091        private final Layout<? extends Serializable> layout;
092
093        public FactoryData(final String host, final int port, final Layout<? extends Serializable> layout) {
094            this.host = host;
095            this.port = port;
096            this.layout = layout;
097        }
098    }
099
100    /**
101     * Factory to create the DatagramSocketManager.
102     */
103    private static class DatagramSocketManagerFactory implements ManagerFactory<DatagramSocketManager, FactoryData> {
104
105        @Override
106        public DatagramSocketManager createManager(final String name, final FactoryData data) {
107            InetAddress address;
108            final OutputStream os = new DatagramOutputStream(data.host, data.port, data.layout.getHeader(),
109                data.layout.getFooter());
110            try {
111                address = InetAddress.getByName(data.host);
112            } catch (final UnknownHostException ex) {
113                LOGGER.error("Could not find address of " + data.host, ex);
114                return null;
115            }
116            return new DatagramSocketManager(name, os, address, data.host, data.port, data.layout);
117        }
118    }
119}