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.ftp;
19  
20  import java.io.IOException;
21  import java.net.InetAddress;
22  import java.net.Socket;
23  import java.net.UnknownHostException;
24  
25  import javax.net.SocketFactory;
26  import javax.net.ssl.SSLContext;
27  
28  /**
29   *
30   * Socket factory for FTPS connections.
31   *
32   * @since 2.0
33   */
34  public class FTPSSocketFactory extends SocketFactory {
35  
36      private final SSLContext context;
37  
38      /**
39       * Constructs a new instance.
40       *
41       * @param context The SSL context.
42       */
43      public FTPSSocketFactory(final SSLContext context) {
44          this.context = context;
45      }
46  
47      /**
48       * @param port the port
49       * @return the socket
50       * @throws IOException on error
51       * @deprecated (2.2) use {@link FTPSServerSocketFactory#createServerSocket(int)}.
52       */
53      @Deprecated
54      public java.net.ServerSocket createServerSocket(final int port) throws IOException {
55          return init(context.getServerSocketFactory().createServerSocket(port));
56      }
57  
58      /**
59       * @param port    the port
60       * @param backlog the backlog
61       * @return the socket
62       * @throws IOException on error
63       * @deprecated (2.2) use {@link FTPSServerSocketFactory#createServerSocket(int, int)}.
64       */
65      @Deprecated
66      public java.net.ServerSocket createServerSocket(final int port, final int backlog) throws IOException {
67          return init(context.getServerSocketFactory().createServerSocket(port, backlog));
68      }
69  
70      /**
71       * @param port      the port
72       * @param backlog   the backlog
73       * @param ifAddress the interface
74       * @return the socket
75       * @throws IOException on error
76       * @deprecated (2.2) use {@link FTPSServerSocketFactory#createServerSocket(int, int, InetAddress)}.
77       */
78      @Deprecated
79      public java.net.ServerSocket createServerSocket(final int port, final int backlog, final InetAddress ifAddress) throws IOException {
80          return init(context.getServerSocketFactory().createServerSocket(port, backlog, ifAddress));
81      }
82  
83      // Override the default implementation
84      @Override
85      public Socket createSocket() throws IOException {
86          return context.getSocketFactory().createSocket();
87      }
88  
89      @Override
90      public Socket createSocket(final InetAddress address, final int port) throws IOException {
91          return context.getSocketFactory().createSocket(address, port);
92      }
93  
94      // DEPRECATED METHODS - for API compatibility only - DO NOT USE
95  
96      @Override
97      public Socket createSocket(final InetAddress address, final int port, final InetAddress localAddress, final int localPort) throws IOException {
98          return context.getSocketFactory().createSocket(address, port, localAddress, localPort);
99      }
100 
101     @Override
102     public Socket createSocket(final String address, final int port) throws UnknownHostException, IOException {
103         return context.getSocketFactory().createSocket(address, port);
104     }
105 
106     @Override
107     public Socket createSocket(final String address, final int port, final InetAddress localAddress, final int localPort)
108             throws UnknownHostException, IOException {
109         return context.getSocketFactory().createSocket(address, port, localAddress, localPort);
110     }
111 
112     /**
113      * @param socket the socket
114      * @return the socket
115      * @throws IOException on error
116      * @deprecated (2.2) use {@link FTPSServerSocketFactory#init(java.net.ServerSocket)}
117      */
118     @Deprecated
119     public java.net.ServerSocket init(final java.net.ServerSocket socket) throws IOException {
120         ((javax.net.ssl.SSLServerSocket) socket).setUseClientMode(true);
121         return socket;
122     }
123 
124 }