org.silvertunnel.netlib.adapter.httpclient.NetlibSocketFactory.java Source code

Introduction

Here is the source code for org.silvertunnel.netlib.adapter.httpclient.NetlibSocketFactory.java

Source

package org.silvertunnel.netlib.adapter.httpclient;

/*
 * ====================================================================
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 * ====================================================================
 *
 * This software consists of voluntary contributions made by many
 * individuals on behalf of the Apache Software Foundation.  For more
 * information on the Apache Software Foundation, please see
 * <http://www.apache.org/>.
 *
 */

import java.io.IOException;
import java.net.InetAddress;
import java.net.Socket;
import java.net.SocketTimeoutException;
import java.util.HashMap;
import java.util.Map;

import org.apache.http.conn.ConnectTimeoutException;
import org.apache.http.conn.scheme.SocketFactory;
import org.apache.http.params.HttpConnectionParams;
import org.apache.http.params.HttpParams;
import org.silvertunnel.netlib.api.NetLayer;
import org.silvertunnel.netlib.api.NetSocket;
import org.silvertunnel.netlib.api.impl.NetSocket2Socket;
import org.silvertunnel.netlib.api.util.TcpipNetAddress;
import org.silvertunnel.netlib.layer.mock.MockNetSocket;
import org.silvertunnel.netlib.layer.tcpip.TcpipNetLayer;

/**
 * The default class for creating plain (unencrypted) sockets.
 * <p>
 * The following parameters can be used to customize the behavior of this 
 * class: 
 * <ul>
 *  <li>{@link org.apache.http.params.CoreConnectionPNames#CONNECTION_TIMEOUT}</li>
 * </ul>
 *
 * @author Apache HttpClient
 * @author hapke
 */
public class NetlibSocketFactory implements SocketFactory {

    private NetLayer lowerNetLayer;

    public NetlibSocketFactory(NetLayer lowerNetLayer) {
        this.lowerNetLayer = lowerNetLayer;
    }

    /**
     * @return unconnected Socket
     */
    public Socket createSocket() throws IOException {
        long WAIT_ENDLESS = -1;
        return new NetSocket2Socket(new MockNetSocket(new byte[0], WAIT_ENDLESS));
    }

    /**
     * @param sock    will be ignored; can be null
     */
    public Socket connectSocket(Socket sock, String host, int port, InetAddress localAddress, int localPort,
            HttpParams params) throws IOException {

        if (host == null) {
            throw new IllegalArgumentException("Target host may not be null.");
        }
        if (params == null) {
            throw new IllegalArgumentException("Parameters may not be null.");
        }

        TcpipNetAddress localNetAddress = null;
        if ((localAddress != null) || (localPort > 0)) {
            // we need to bind explicitly
            if (localPort < 0) {
                localPort = 0; // indicates "any"
            }

            localNetAddress = new TcpipNetAddress(localAddress, localPort);
        }

        int timeoutInMs = HttpConnectionParams.getConnectionTimeout(params);

        // open connection without explicit DNS resolution
        Map<String, Object> localProperties = new HashMap<String, Object>();
        localProperties.put(TcpipNetLayer.TIMEOUT_IN_MS, new Integer(timeoutInMs));
        TcpipNetAddress remoteNetAddress = new TcpipNetAddress(host, port);

        try {
            NetSocket netSocket = lowerNetLayer.createNetSocket(localProperties, localNetAddress, remoteNetAddress);
            if (sock != null && sock instanceof NetSocket2Socket) {
                // change NetSocket of exiting wrapper 
                NetSocket2Socket netSocket2Socket = (NetSocket2Socket) sock;
                netSocket2Socket.setNetSocket(netSocket);
                return netSocket2Socket;
            } else {
                // create new wrapper
                return new NetSocket2Socket(netSocket);
            }

        } catch (SocketTimeoutException ex) {
            throw new ConnectTimeoutException("Connect to " + remoteNetAddress + " timed out");
        }
    }

    /**
     * Checks whether a socket connection is secure.
     * This factory creates plain socket connections
     * which are not considered secure.
     *
     * @param sock      the connected socket
     *
     * @return  <code>false</code>
     *
     * @throws IllegalArgumentException if the argument is invalid
     */
    public final boolean isSecure(Socket sock) throws IllegalArgumentException {

        if (sock == null) {
            throw new IllegalArgumentException("Socket may not be null.");
        }
        // This check is performed last since it calls a method implemented
        // by the argument object. getClass() is final in java.lang.Object.
        if (sock.isClosed()) {
            throw new IllegalArgumentException("Socket is closed.");
        }
        return false;
    }
}