View Javadoc
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    *      https://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  
18  package org.apache.commons.net;
19  
20  import java.net.DatagramSocket;
21  import java.net.InetAddress;
22  import java.net.SocketException;
23  
24  /**
25   * Implements the DatagramSocketFactory interface by simply wrapping the {@link DatagramSocket} constructors. It is the default DatagramSocketFactory used by
26   * {@link org.apache.commons.net.DatagramSocketClient} implementations.
27   *
28   * @see DatagramSocketFactory
29   * @see DatagramSocketClient
30   * @see DatagramSocketClient#setDatagramSocketFactory
31   */
32  public class DefaultDatagramSocketFactory implements DatagramSocketFactory {
33  
34      /**
35       * Constructs a new instance.
36       */
37      public DefaultDatagramSocketFactory() {
38          // empty
39      }
40  
41      /**
42       * Creates a DatagramSocket on the local host at the first available port.
43       *
44       * @return a new DatagramSocket
45       * @throws SocketException If the socket could not be created.
46       */
47      @Override
48      public DatagramSocket createDatagramSocket() throws SocketException {
49          return new DatagramSocket();
50      }
51  
52      /**
53       * Creates a DatagramSocket on the local host at a specified port.
54       *
55       * @param port The port to use for the socket.
56       * @return a new DatagramSocket
57       * @throws SocketException If the socket could not be created.
58       */
59      @Override
60      public DatagramSocket createDatagramSocket(final int port) throws SocketException {
61          return new DatagramSocket(port);
62      }
63  
64      /**
65       * Creates a DatagramSocket at the specified address on the local host at a specified port.
66       *
67       * @param port  The port to use for the socket.
68       * @param localAddress The local address to use.
69       * @return a new DatagramSocket
70       * @throws SocketException If the socket could not be created.
71       */
72      @Override
73      public DatagramSocket createDatagramSocket(final int port, final InetAddress localAddress) throws SocketException {
74          return new DatagramSocket(port, localAddress);
75      }
76  }