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.Contract;
38  import org.apache.http.annotation.ThreadingBehavior;
39  import org.apache.http.conn.ConnectTimeoutException;
40  import org.apache.http.params.HttpConnectionParams;
41  import org.apache.http.params.HttpParams;
42  import org.apache.http.util.Args;
43  
44  /**
45   * The default class for creating plain (unencrypted) sockets.
46   *
47   * @since 4.0
48   *
49   * @deprecated (4.3) use {@link org.apache.http.conn.socket.PlainConnectionSocketFactory}
50   */
51  @Contract(threading = ThreadingBehavior.IMMUTABLE)
52  @Deprecated
53  public class PlainSocketFactory implements SocketFactory, SchemeSocketFactory {
54  
55      private final HostNameResolver nameResolver;
56  
57      /**
58       * Gets the default factory.
59       *
60       * @return the default factory
61       */
62      public static PlainSocketFactory getSocketFactory() {
63          return new PlainSocketFactory();
64      }
65  
66      /**
67       * @deprecated (4.1) use {@link org.apache.http.conn.DnsResolver}
68       */
69      @Deprecated
70      public PlainSocketFactory(final HostNameResolver nameResolver) {
71          super();
72          this.nameResolver = nameResolver;
73      }
74  
75      public PlainSocketFactory() {
76          super();
77          this.nameResolver = null;
78      }
79  
80      /**
81       * @param params Optional parameters. Parameters passed to this method will have no effect.
82       *               This method will create a unconnected instance of {@link Socket} class
83       *               using default constructor.
84       *
85       * @since 4.1
86       */
87      @Override
88      public Socket createSocket(final HttpParams params) {
89          return new Socket();
90      }
91  
92      @Override
93      public Socket createSocket() {
94          return new Socket();
95      }
96  
97      /**
98       * @since 4.1
99       */
100     @Override
101     public Socket connectSocket(
102             final Socket socket,
103             final InetSocketAddress remoteAddress,
104             final InetSocketAddress localAddress,
105             final HttpParams params) throws IOException, ConnectTimeoutException {
106         Args.notNull(remoteAddress, "Remote address");
107         Args.notNull(params, "HTTP parameters");
108         Socket sock = socket;
109         if (sock == null) {
110             sock = createSocket();
111         }
112         if (localAddress != null) {
113             sock.setReuseAddress(HttpConnectionParams.getSoReuseaddr(params));
114             sock.bind(localAddress);
115         }
116         final int connTimeout = HttpConnectionParams.getConnectionTimeout(params);
117         final int soTimeout = HttpConnectionParams.getSoTimeout(params);
118 
119         try {
120             sock.setSoTimeout(soTimeout);
121             sock.connect(remoteAddress, connTimeout);
122         } catch (final SocketTimeoutException ex) {
123             throw new ConnectTimeoutException("Connect to " + remoteAddress + " timed out");
124         }
125         return sock;
126     }
127 
128     /**
129      * Checks whether a socket connection is secure.
130      * This factory creates plain socket connections
131      * which are not considered secure.
132      *
133      * @param sock      the connected socket
134      *
135      * @return  {@code false}
136      */
137     @Override
138     public final boolean isSecure(final Socket sock) {
139         return false;
140     }
141 
142     /**
143      * @deprecated (4.1)  Use {@link #connectSocket(Socket, InetSocketAddress, InetSocketAddress, HttpParams)}
144      */
145     @Override
146     @Deprecated
147     public Socket connectSocket(
148             final Socket socket,
149             final String host, final int port,
150             final InetAddress localAddress, final int localPort,
151             final HttpParams params) throws IOException, UnknownHostException, ConnectTimeoutException {
152         InetSocketAddress local = null;
153         if (localAddress != null || localPort > 0) {
154             local = new InetSocketAddress(localAddress, localPort > 0 ? localPort : 0);
155         }
156         final InetAddress remoteAddress;
157         if (this.nameResolver != null) {
158             remoteAddress = this.nameResolver.resolve(host);
159         } else {
160             remoteAddress = InetAddress.getByName(host);
161         }
162         final InetSocketAddress remote = new InetSocketAddress(remoteAddress, port);
163         return connectSocket(socket, remote, local, params);
164     }
165 
166 }