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 */
017
018package org.apache.commons.net;
019
020import java.net.DatagramSocket;
021import java.net.InetAddress;
022import java.net.SocketException;
023
024/**
025 * Implements the DatagramSocketFactory interface by simply wrapping the {@link DatagramSocket} constructors. It is the default DatagramSocketFactory used by
026 * {@link org.apache.commons.net.DatagramSocketClient} implementations.
027 *
028 * @see DatagramSocketFactory
029 * @see DatagramSocketClient
030 * @see DatagramSocketClient#setDatagramSocketFactory
031 */
032
033public class DefaultDatagramSocketFactory implements DatagramSocketFactory {
034
035    /**
036     * Creates a DatagramSocket on the local host at the first available port.
037     *
038     * @return a new DatagramSocket
039     * @throws SocketException If the socket could not be created.
040     */
041    @Override
042    public DatagramSocket createDatagramSocket() throws SocketException {
043        return new DatagramSocket();
044    }
045
046    /**
047     * Creates a DatagramSocket on the local host at a specified port.
048     *
049     * @param port The port to use for the socket.
050     * @return a new DatagramSocket
051     * @throws SocketException If the socket could not be created.
052     */
053    @Override
054    public DatagramSocket createDatagramSocket(final int port) throws SocketException {
055        return new DatagramSocket(port);
056    }
057
058    /**
059     * Creates a DatagramSocket at the specified address on the local host at a specified port.
060     *
061     * @param port  The port to use for the socket.
062     * @param localAddress The local address to use.
063     * @return a new DatagramSocket
064     * @throws SocketException If the socket could not be created.
065     */
066    @Override
067    public DatagramSocket createDatagramSocket(final int port, final InetAddress localAddress) throws SocketException {
068        return new DatagramSocket(port, localAddress);
069    }
070}