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