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 * The DatagramSocketFactory interface provides a means for the
026 * programmer to control the creation of datagram sockets and
027 * provide his own DatagramSocket implementations for use by all
028 * classes derived from
029 * {@link org.apache.commons.net.DatagramSocketClient}
030 * .
031 * This allows you to provide your own DatagramSocket implementations and
032 * to perform security checks or browser capability requests before
033 * creating a DatagramSocket.
034 *
035 *
036 ***/
037
038public interface DatagramSocketFactory
039{
040
041    /***
042     * Creates a DatagramSocket on the local host at the first available port.
043     * @return the socket
044     *
045     * @throws SocketException If the socket could not be created.
046     ***/
047    public DatagramSocket createDatagramSocket() throws SocketException;
048
049    /***
050     * Creates a DatagramSocket on the local host at a specified port.
051     *
052     * @param port The port to use for the socket.
053     * @return the socket
054     * @throws SocketException If the socket could not be created.
055     ***/
056    public DatagramSocket createDatagramSocket(int port) throws SocketException;
057
058    /***
059     * Creates a DatagramSocket at the specified address on the local host
060     * at a specified port.
061     *
062     * @param port The port to use for the socket.
063     * @param laddr  The local address to use.
064     * @return the socket
065     * @throws SocketException If the socket could not be created.
066     ***/
067    public DatagramSocket createDatagramSocket(int port, InetAddress laddr)
068    throws SocketException;
069}