View Javadoc

1   /*
2    * ====================================================================
3    * Licensed to the Apache Software Foundation (ASF) under one
4    * or more contributor license agreements.  See the NOTICE file
5    * distributed with this work for additional information
6    * regarding copyright ownership.  The ASF licenses this file
7    * to you under the Apache License, Version 2.0 (the
8    * "License"); you may not use this file except in compliance
9    * with the License.  You may obtain a copy of the License at
10   *
11   *   http://www.apache.org/licenses/LICENSE-2.0
12   *
13   * Unless required by applicable law or agreed to in writing,
14   * software distributed under the License is distributed on an
15   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16   * KIND, either express or implied.  See the License for the
17   * specific language governing permissions and limitations
18   * under the License.
19   * ====================================================================
20   *
21   * This software consists of voluntary contributions made by many
22   * individuals on behalf of the Apache Software Foundation.  For more
23   * information on the Apache Software Foundation, please see
24   * <http://www.apache.org/>.
25   *
26   */
27  
28  package org.apache.http.conn.scheme;
29  
30  import java.io.IOException;
31  import java.net.InetAddress;
32  import java.net.InetSocketAddress;
33  import java.net.Socket;
34  import java.net.SocketTimeoutException;
35  import java.net.UnknownHostException;
36  
37  import org.apache.http.annotation.Immutable;
38  import org.apache.http.conn.ConnectTimeoutException;
39  import org.apache.http.params.HttpConnectionParams;
40  import org.apache.http.params.HttpParams;
41  import org.apache.http.util.Args;
42  
43  /**
44   * The default class for creating plain (unencrypted) sockets.
45   *
46   * @since 4.0
47   *
48   * @deprecated (4.3) use {@link org.apache.http.conn.socket.PlainConnectionSocketFactory}
49   */
50  @Immutable
51  @Deprecated
52  public class PlainSocketFactory implements SocketFactory, SchemeSocketFactory {
53  
54      private final HostNameResolver nameResolver;
55  
56      /**
57       * Gets the default factory.
58       *
59       * @return the default factory
60       */
61      public static PlainSocketFactory getSocketFactory() {
62          return new PlainSocketFactory();
63      }
64  
65      /**
66       * @deprecated (4.1) use {@link org.apache.http.conn.DnsResolver}
67       */
68      @Deprecated
69      public PlainSocketFactory(final HostNameResolver nameResolver) {
70          super();
71          this.nameResolver = nameResolver;
72      }
73  
74      public PlainSocketFactory() {
75          super();
76          this.nameResolver = null;
77      }
78  
79      /**
80       * @param params Optional parameters. Parameters passed to this method will have no effect.
81       *               This method will create a unconnected instance of {@link Socket} class
82       *               using default constructor.
83       *
84       * @since 4.1
85       */
86      public Socket createSocket(final HttpParams params) {
87          return new Socket();
88      }
89  
90      public Socket createSocket() {
91          return new Socket();
92      }
93  
94      /**
95       * @since 4.1
96       */
97      public Socket connectSocket(
98              final Socket socket,
99              final InetSocketAddress remoteAddress,
100             final InetSocketAddress localAddress,
101             final HttpParams params) throws IOException, ConnectTimeoutException {
102         Args.notNull(remoteAddress, "Remote address");
103         Args.notNull(params, "HTTP parameters");
104         Socket sock = socket;
105         if (sock == null) {
106             sock = createSocket();
107         }
108         if (localAddress != null) {
109             sock.setReuseAddress(HttpConnectionParams.getSoReuseaddr(params));
110             sock.bind(localAddress);
111         }
112         final int connTimeout = HttpConnectionParams.getConnectionTimeout(params);
113         final int soTimeout = HttpConnectionParams.getSoTimeout(params);
114 
115         try {
116             sock.setSoTimeout(soTimeout);
117             sock.connect(remoteAddress, connTimeout);
118         } catch (final SocketTimeoutException ex) {
119             throw new ConnectTimeoutException("Connect to " + remoteAddress + " timed out");
120         }
121         return sock;
122     }
123 
124     /**
125      * Checks whether a socket connection is secure.
126      * This factory creates plain socket connections
127      * which are not considered secure.
128      *
129      * @param sock      the connected socket
130      *
131      * @return  {@code false}
132      */
133     public final boolean isSecure(final Socket sock) {
134         return false;
135     }
136 
137     /**
138      * @deprecated (4.1)  Use {@link #connectSocket(Socket, InetSocketAddress, InetSocketAddress, HttpParams)}
139      */
140     @Deprecated
141     public Socket connectSocket(
142             final Socket socket,
143             final String host, final int port,
144             final InetAddress localAddress, final int localPort,
145             final HttpParams params) throws IOException, UnknownHostException, ConnectTimeoutException {
146         InetSocketAddress local = null;
147         if (localAddress != null || localPort > 0) {
148             local = new InetSocketAddress(localAddress, localPort > 0 ? localPort : 0);
149         }
150         final InetAddress remoteAddress;
151         if (this.nameResolver != null) {
152             remoteAddress = this.nameResolver.resolve(host);
153         } else {
154             remoteAddress = InetAddress.getByName(host);
155         }
156         final InetSocketAddress remote = new InetSocketAddress(remoteAddress, port);
157         return connectSocket(socket, remote, local, params);
158     }
159 
160 }