All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.eclipse.jetty.client.HttpClient Maven / Gradle / Ivy

There is a newer version: 1.0-rc5
Show newest version
// ========================================================================
// Copyright (c) 2006-2009 Mort Bay Consulting Pty. Ltd.
// ------------------------------------------------------------------------
// All rights reserved. This program and the accompanying materials
// are made available under the terms of the Eclipse Public License v1.0
// and Apache License v2.0 which accompanies this distribution.
// The Eclipse Public License is available at
// http://www.eclipse.org/legal/epl-v10.html
// The Apache License v2.0 is available at
// http://www.opensource.org/licenses/apache2.0.php
// You may elect to redistribute this code under either of these licenses.
// ========================================================================

package org.eclipse.jetty.client;

import java.io.ByteArrayInputStream;
import java.io.ByteArrayOutputStream;
import java.io.IOException;
import java.io.InputStream;
import java.net.UnknownHostException;
import java.security.KeyStore;
import java.security.SecureRandom;
import java.security.Security;
import java.util.Enumeration;
import java.util.LinkedList;
import java.util.Map;
import java.util.Set;
import java.util.concurrent.ConcurrentHashMap;
import java.util.concurrent.ConcurrentMap;
import javax.net.ssl.KeyManager;
import javax.net.ssl.KeyManagerFactory;
import javax.net.ssl.SSLContext;
import javax.net.ssl.TrustManager;
import javax.net.ssl.TrustManagerFactory;
import javax.net.ssl.X509TrustManager;

import org.eclipse.jetty.client.security.Authentication;
import org.eclipse.jetty.client.security.RealmResolver;
import org.eclipse.jetty.client.security.SecurityListener;
import org.eclipse.jetty.http.HttpBuffers;
import org.eclipse.jetty.http.HttpSchemes;
import org.eclipse.jetty.http.security.Password;
import org.eclipse.jetty.io.Buffer;
import org.eclipse.jetty.io.ByteArrayBuffer;
import org.eclipse.jetty.io.nio.DirectNIOBuffer;
import org.eclipse.jetty.io.nio.IndirectNIOBuffer;
import org.eclipse.jetty.util.Attributes;
import org.eclipse.jetty.util.AttributesMap;
import org.eclipse.jetty.util.component.LifeCycle;
import org.eclipse.jetty.util.log.Log;
import org.eclipse.jetty.util.resource.Resource;
import org.eclipse.jetty.util.thread.QueuedThreadPool;
import org.eclipse.jetty.util.thread.ThreadPool;
import org.eclipse.jetty.util.thread.Timeout;

/**
 * Http Client.
 * 

* HttpClient is the main active component of the client API implementation. * It is the opposite of the Connectors in standard Jetty, in that it listens * for responses rather than requests. Just like the connectors, there is a * blocking socket version and a non-blocking NIO version (implemented as nested classes * selected by {@link #setConnectorType(int)}). *

* The an instance of {@link HttpExchange} is passed to the {@link #send(HttpExchange)} method * to send a request. The exchange contains both the headers and content (source) of the request * plus the callbacks to handle responses. A HttpClient can have many exchanges outstanding * and they may be queued on the {@link HttpDestination} waiting for a {@link HttpConnection}, * queued in the {@link HttpConnection} waiting to be transmitted or pipelined on the actual * TCP/IP connection waiting for a response. *

* The {@link HttpDestination} class is an aggregation of {@link HttpConnection}s for the * same host, port and protocol. A destination may limit the number of connections * open and they provide a pool of open connections that may be reused. Connections may also * be allocated from a destination, so that multiple request sources are not multiplexed * over the same connection. * * @see HttpExchange * @see HttpDestination */ public class HttpClient extends HttpBuffers implements Attributes { public static final int CONNECTOR_SOCKET = 0; public static final int CONNECTOR_SELECT_CHANNEL = 2; private int _connectorType = CONNECTOR_SELECT_CHANNEL; private boolean _useDirectBuffers = true; private int _maxConnectionsPerAddress = Integer.MAX_VALUE; private ConcurrentMap _destinations = new ConcurrentHashMap(); ThreadPool _threadPool; Connector _connector; private long _idleTimeout = 20000; private long _timeout = 320000; private int _connectTimeout = 75000; private Timeout _timeoutQ = new Timeout(); private Timeout _idleTimeoutQ = new Timeout(); private Address _proxy; private Authentication _proxyAuthentication; private Set _noProxy; private int _maxRetries = 3; private int _maxRedirects = 20; private LinkedList _registeredListeners; private String _keyStoreLocation; private InputStream _keyStoreInputStream; private String _keyStoreType = "JKS"; private String _keyStorePassword; private String _keyManagerAlgorithm = (Security.getProperty("ssl.KeyManagerFactory.algorithm")==null?"SunX509":Security.getProperty("ssl.KeyManagerFactory.algorithm")); private String _keyManagerPassword; private String _trustStoreLocation; private InputStream _trustStoreInputStream; private String _trustStoreType = "JKS"; private String _trustStorePassword; private String _trustManagerAlgorithm = (Security.getProperty("ssl.TrustManagerFactory.algorithm")==null?"SunX509":Security.getProperty("ssl.TrustManagerFactory.algorithm")); private String _protocol = "TLS"; private String _provider; private String _secureRandomAlgorithm; private SSLContext _sslContext; private RealmResolver _realmResolver; private AttributesMap _attributes=new AttributesMap(); /* ------------------------------------------------------------------------------- */ public void dump() { try { for (Map.Entry entry : _destinations.entrySet()) { Log.info("\n" + entry.getKey() + ":"); entry.getValue().dump(); } } catch(Exception e) { Log.warn(e); } } /* ------------------------------------------------------------------------------- */ public void send(HttpExchange exchange) throws IOException { boolean ssl = HttpSchemes.HTTPS_BUFFER.equalsIgnoreCase(exchange.getScheme()); exchange.setStatus(HttpExchange.STATUS_WAITING_FOR_CONNECTION); HttpDestination destination = getDestination(exchange.getAddress(), ssl); destination.send(exchange); } /* ------------------------------------------------------------ */ /** * @return the threadPool */ public ThreadPool getThreadPool() { return _threadPool; } /* ------------------------------------------------------------ */ /** * @param threadPool the threadPool to set */ public void setThreadPool(ThreadPool threadPool) { _threadPool = threadPool; } /* ------------------------------------------------------------ */ /** * @param name * @return Attribute associated with client */ public Object getAttribute(String name) { return _attributes.getAttribute(name); } /* ------------------------------------------------------------ */ /** * @return names of attributes associated with client */ public Enumeration getAttributeNames() { return _attributes.getAttributeNames(); } /* ------------------------------------------------------------ */ /** * @param name */ public void removeAttribute(String name) { _attributes.removeAttribute(name); } /* ------------------------------------------------------------ */ /** * Set an attribute on the HttpClient. * Attributes are not used by the client, but are provided for * so that users of a shared HttpClient may share other structures. * @param name * @param attribute */ public void setAttribute(String name, Object attribute) { _attributes.setAttribute(name,attribute); } /* ------------------------------------------------------------ */ public void clearAttributes() { _attributes.clearAttributes(); } /* ------------------------------------------------------------------------------- */ public HttpDestination getDestination(Address remote, boolean ssl) throws UnknownHostException, IOException { if (remote == null) throw new UnknownHostException("Remote socket address cannot be null."); HttpDestination destination = _destinations.get(remote); if (destination == null) { destination = new HttpDestination(this, remote, ssl, _maxConnectionsPerAddress); if (_proxy != null && (_noProxy == null || !_noProxy.contains(remote.getHost()))) { destination.setProxy(_proxy); if (_proxyAuthentication != null) destination.setProxyAuthentication(_proxyAuthentication); } HttpDestination other =_destinations.putIfAbsent(remote, destination); if (other!=null) destination=other; } return destination; } /* ------------------------------------------------------------ */ public void schedule(Timeout.Task task) { _timeoutQ.schedule(task); } public void schedule(Timeout.Task task, long timeout) { _timeoutQ.schedule(task, timeout); } /* ------------------------------------------------------------ */ public void scheduleIdle(Timeout.Task task) { _idleTimeoutQ.schedule(task); } /* ------------------------------------------------------------ */ public void cancel(Timeout.Task task) { task.cancel(); } /* ------------------------------------------------------------ */ /** * Get whether the connector can use direct NIO buffers. */ public boolean getUseDirectBuffers() { return _useDirectBuffers; } /* ------------------------------------------------------------ */ /** Set a RealmResolver for client Authentication. * If a realmResolver is set, then the HttpDestinations created by * this client will instantiate a {@link SecurityListener} so that * BASIC and DIGEST authentication can be performed. * @param resolver */ public void setRealmResolver(RealmResolver resolver) { _realmResolver = resolver; } /* ------------------------------------------------------------ */ /** * returns the SecurityRealmResolver reg_realmResolveristered with the HttpClient or null * * @return the SecurityRealmResolver reg_realmResolveristered with the HttpClient or null */ public RealmResolver getRealmResolver() { return _realmResolver; } /* ------------------------------------------------------------ */ public boolean hasRealms() { return _realmResolver == null ? false : true; } /** * Registers a listener that can listen to the stream of execution between the client and the * server and influence events. Sequential calls to the method wrapper sequentially wrap the preceding * listener in a delegation model. *

* NOTE: the SecurityListener is a special listener which doesn't need to be added via this * mechanic, if you register security realms then it will automatically be added as the top listener of the * delegation stack. * * @param listenerClass */ public void registerListener(String listenerClass) { if (_registeredListeners == null) { _registeredListeners = new LinkedList(); } _registeredListeners.add(listenerClass); } /* ------------------------------------------------------------ */ public LinkedList getRegisteredListeners() { return _registeredListeners; } /* ------------------------------------------------------------ */ /** * Set to use NIO direct buffers. * * @param direct If True (the default), the connector can use NIO direct * buffers. Some JVMs have memory management issues (bugs) with * direct buffers. */ public void setUseDirectBuffers(boolean direct) { _useDirectBuffers = direct; } /* ------------------------------------------------------------ */ /** * Get the type of connector (socket, blocking or select) in use. */ public int getConnectorType() { return _connectorType; } /* ------------------------------------------------------------ */ public void setConnectorType(int connectorType) { this._connectorType = connectorType; } /* ------------------------------------------------------------ */ /** * @see org.eclipse.jetty.http.HttpBuffers#newRequestBuffer(int) */ @Override protected Buffer newRequestBuffer(int size) { if (_connectorType == CONNECTOR_SOCKET) return new ByteArrayBuffer(size); return _useDirectBuffers?new DirectNIOBuffer(size):new IndirectNIOBuffer(size); } /* ------------------------------------------------------------ */ /** * @see org.eclipse.jetty.http.HttpBuffers#newRequestHeader(int) */ @Override protected Buffer newRequestHeader(int size) { if (_connectorType == CONNECTOR_SOCKET) return new ByteArrayBuffer(size); return new IndirectNIOBuffer(size); } /* ------------------------------------------------------------ */ /** * @see org.eclipse.jetty.http.HttpBuffers#newResponseBuffer(int) */ @Override protected Buffer newResponseBuffer(int size) { if (_connectorType == CONNECTOR_SOCKET) return new ByteArrayBuffer(size); return _useDirectBuffers?new DirectNIOBuffer(size):new IndirectNIOBuffer(size); } /* ------------------------------------------------------------ */ /** * @see org.eclipse.jetty.http.HttpBuffers#newResponseHeader(int) */ @Override protected Buffer newResponseHeader(int size) { if (_connectorType == CONNECTOR_SOCKET) return new ByteArrayBuffer(size); return new IndirectNIOBuffer(size); } /* ------------------------------------------------------------------------------- */ @Override protected boolean isRequestHeader(Buffer buffer) { if (_connectorType == CONNECTOR_SOCKET) return buffer instanceof ByteArrayBuffer; return buffer instanceof IndirectNIOBuffer; } /* ------------------------------------------------------------------------------- */ @Override protected boolean isResponseHeader(Buffer buffer) { if (_connectorType == CONNECTOR_SOCKET) return buffer instanceof ByteArrayBuffer; return buffer instanceof IndirectNIOBuffer; } /* ------------------------------------------------------------ */ public int getMaxConnectionsPerAddress() { return _maxConnectionsPerAddress; } /* ------------------------------------------------------------ */ public void setMaxConnectionsPerAddress(int maxConnectionsPerAddress) { _maxConnectionsPerAddress = maxConnectionsPerAddress; } /* ------------------------------------------------------------ */ @Override protected void doStart() throws Exception { super.doStart(); _timeoutQ.setDuration(_timeout); _timeoutQ.setNow(); _idleTimeoutQ.setDuration(_idleTimeout); _idleTimeoutQ.setNow(); if (_threadPool == null) { QueuedThreadPool pool = new QueuedThreadPool(); pool.setMaxThreads(16); pool.setDaemon(true); pool.setName("HttpClient"); _threadPool = pool; } if (_threadPool instanceof LifeCycle) { ((LifeCycle)_threadPool).start(); } if (_connectorType == CONNECTOR_SELECT_CHANNEL) { _connector = new SelectConnector(this); } else { _connector = new SocketConnector(this); } _connector.start(); _threadPool.dispatch(new Runnable() { public void run() { while (isRunning()) { _timeoutQ.tick(System.currentTimeMillis()); _idleTimeoutQ.tick(_timeoutQ.getNow()); try { Thread.sleep(200); } catch (InterruptedException e) { } } } }); } /* ------------------------------------------------------------ */ long getNow() { return _timeoutQ.getNow(); } /* ------------------------------------------------------------ */ @Override protected void doStop() throws Exception { _connector.stop(); _connector = null; if (_threadPool instanceof LifeCycle) { ((LifeCycle)_threadPool).stop(); } for (HttpDestination destination : _destinations.values()) { destination.close(); } _timeoutQ.cancelAll(); _idleTimeoutQ.cancelAll(); super.doStop(); } /* ------------------------------------------------------------ */ interface Connector extends LifeCycle { public void startConnection(HttpDestination destination) throws IOException; } /** * if a keystore location has been provided then client will attempt to use it as the keystore, * otherwise we simply ignore certificates and run with a loose ssl context. * * @return the SSL context * @throws IOException */ protected SSLContext getSSLContext() throws IOException { if (_sslContext == null) { if (_keyStoreInputStream == null && _keyStoreLocation == null) { _sslContext = getLooseSSLContext(); } else { _sslContext = getStrictSSLContext(); } } return _sslContext; } protected SSLContext getStrictSSLContext() throws IOException { try { if (_trustStoreInputStream == null && _trustStoreLocation == null) { _trustStoreLocation = _keyStoreLocation; _trustStoreInputStream = _keyStoreInputStream; _trustStoreType = _keyStoreType; } InputStream keyStoreInputStream = null; InputStream trustStoreInputStream = null; // It's the same stream and we cannot read it twice, so we read it once in memory if (_keyStoreInputStream != null && _keyStoreInputStream == _trustStoreInputStream) { ByteArrayOutputStream baos = new ByteArrayOutputStream(); byte[] buffer = new byte[1024]; int read; while ((read = _keyStoreInputStream.read(buffer)) >= 0) baos.write(buffer, 0, read); _keyStoreInputStream.close(); keyStoreInputStream = new ByteArrayInputStream(baos.toByteArray()); trustStoreInputStream = new ByteArrayInputStream(baos.toByteArray()); } if (keyStoreInputStream == null) keyStoreInputStream = _keyStoreInputStream == null ? Resource.newResource(_keyStoreLocation).getInputStream() : _keyStoreInputStream; KeyStore keyStore = KeyStore.getInstance(_keyStoreType); keyStore.load(keyStoreInputStream, _keyStorePassword == null ? null : _keyStorePassword.toCharArray()); keyStoreInputStream.close(); KeyManagerFactory keyManagerFactory = KeyManagerFactory.getInstance(_keyManagerAlgorithm); keyManagerFactory.init(keyStore, _keyManagerPassword == null ? null : _keyManagerPassword.toCharArray()); KeyManager[] keyManagers = keyManagerFactory.getKeyManagers(); if (trustStoreInputStream == null) trustStoreInputStream = _trustStoreInputStream == null ? Resource.newResource(_trustStoreLocation).getInputStream() : _trustStoreInputStream; KeyStore trustStore = KeyStore.getInstance(_trustStoreType); trustStore.load(trustStoreInputStream, _trustStorePassword == null ? null : _trustStorePassword.toCharArray()); trustStoreInputStream.close(); TrustManagerFactory trustManagerFactory = TrustManagerFactory.getInstance(_trustManagerAlgorithm); trustManagerFactory.init(trustStore); TrustManager[] trustManagers = trustManagerFactory.getTrustManagers(); SecureRandom secureRandom = _secureRandomAlgorithm == null ? null : SecureRandom.getInstance(_secureRandomAlgorithm); SSLContext context = _provider == null ? SSLContext.getInstance(_protocol) : SSLContext.getInstance(_protocol, _provider); context.init(keyManagers, trustManagers, secureRandom); return context; } catch (Exception x) { throw (IOException)new IOException("Error generating SSLContext for keystore " + _keyStoreLocation).initCause(x); } } protected SSLContext getLooseSSLContext() throws IOException { // Create a trust manager that does not validate certificate chains TrustManager[] trustAllCerts = new TrustManager[]{new X509TrustManager() { public java.security.cert.X509Certificate[] getAcceptedIssuers() { return null; } public void checkClientTrusted(java.security.cert.X509Certificate[] certs, String authType) { } public void checkServerTrusted(java.security.cert.X509Certificate[] certs, String authType) { } }}; // Install the all-trusting trust manager try { SSLContext sslContext = SSLContext.getInstance(_protocol); sslContext.init(null, trustAllCerts, null); return sslContext; } catch (Exception x) { throw (IOException)new IOException("Error generating loose SSLContext").initCause(x); } } /* ------------------------------------------------------------ */ /** * @return the period in milliseconds a {@link HttpConnection} can be idle for before it is closed. */ public long getIdleTimeout() { return _idleTimeout; } /* ------------------------------------------------------------ */ /** * @param ms the period in milliseconds a {@link HttpConnection} can be idle for before it is closed. */ public void setIdleTimeout(long ms) { _idleTimeout = ms; } /** * @return the period in ms that an exchange will wait for a response from the server. * @deprecated use {@link #getTimeout()} instead. */ @Deprecated public int getSoTimeout() { return Long.valueOf(getTimeout()).intValue(); } /** * @deprecated use {@link #setTimeout(long)} instead. * @param timeout the period in ms that an exchange will wait for a response from the server. */ @Deprecated public void setSoTimeout(int timeout) { setTimeout(timeout); } /* ------------------------------------------------------------ */ /** * @return the period in ms that an exchange will wait for a response from the server. */ public long getTimeout() { return _timeout; } /* ------------------------------------------------------------ */ /** * @param timeout the period in ms that an exchange will wait for a response from the server. */ public void setTimeout(long timeout) { _timeout = timeout; } /** * @return the period in ms before timing out an attempt to connect */ public int getConnectTimeout() { return _connectTimeout; } /** * @param connectTimeout the period in ms before timing out an attempt to connect */ public void setConnectTimeout(int connectTimeout) { this._connectTimeout = connectTimeout; } /* ------------------------------------------------------------ */ public Address getProxy() { return _proxy; } /* ------------------------------------------------------------ */ public void setProxy(Address proxy) { this._proxy = proxy; } /* ------------------------------------------------------------ */ public Authentication getProxyAuthentication() { return _proxyAuthentication; } /* ------------------------------------------------------------ */ public void setProxyAuthentication(Authentication authentication) { _proxyAuthentication = authentication; } /* ------------------------------------------------------------ */ public boolean isProxied() { return this._proxy != null; } /* ------------------------------------------------------------ */ public Set getNoProxy() { return _noProxy; } /* ------------------------------------------------------------ */ public void setNoProxy(Set noProxyAddresses) { _noProxy = noProxyAddresses; } /* ------------------------------------------------------------ */ public int maxRetries() { return _maxRetries; } /* ------------------------------------------------------------ */ public void setMaxRetries(int retries) { _maxRetries = retries; } /* ------------------------------------------------------------ */ public int maxRedirects() { return _maxRedirects; } /* ------------------------------------------------------------ */ public void setMaxRedirects(int redirects) { _maxRedirects = redirects; } /* ------------------------------------------------------------ */ public String getTrustStoreLocation() { return _trustStoreLocation; } /* ------------------------------------------------------------ */ public void setTrustStoreLocation(String trustStoreLocation) { this._trustStoreLocation = trustStoreLocation; } public InputStream getTrustStoreInputStream() { return _trustStoreInputStream; } public void setTrustStoreInputStream(InputStream trustStoreInputStream) { this._trustStoreInputStream = trustStoreInputStream; } /* ------------------------------------------------------------ */ public String getKeyStoreLocation() { return _keyStoreLocation; } /* ------------------------------------------------------------ */ public void setKeyStoreLocation(String keyStoreLocation) { this._keyStoreLocation = keyStoreLocation; } public InputStream getKeyStoreInputStream() { return _keyStoreInputStream; } public void setKeyStoreInputStream(InputStream keyStoreInputStream) { this._keyStoreInputStream = keyStoreInputStream; } /* ------------------------------------------------------------ */ public void setKeyStorePassword(String keyStorePassword) { this._keyStorePassword = new Password(keyStorePassword).toString(); } /* ------------------------------------------------------------ */ public void setKeyManagerPassword(String keyManagerPassword) { this._keyManagerPassword = new Password(keyManagerPassword).toString(); } /* ------------------------------------------------------------ */ public void setTrustStorePassword(String trustStorePassword) { this._trustStorePassword = new Password(trustStorePassword).toString(); } /* ------------------------------------------------------------ */ public String getKeyStoreType() { return this._keyStoreType; } /* ------------------------------------------------------------ */ public void setKeyStoreType(String keyStoreType) { this._keyStoreType = keyStoreType; } /* ------------------------------------------------------------ */ public String getTrustStoreType() { return this._trustStoreType; } /* ------------------------------------------------------------ */ public void setTrustStoreType(String trustStoreType) { this._trustStoreType = trustStoreType; } /* ------------------------------------------------------------ */ public String getKeyManagerAlgorithm() { return _keyManagerAlgorithm; } /* ------------------------------------------------------------ */ public void setKeyManagerAlgorithm(String keyManagerAlgorithm) { this._keyManagerAlgorithm = keyManagerAlgorithm; } /* ------------------------------------------------------------ */ public String getTrustManagerAlgorithm() { return _trustManagerAlgorithm; } /* ------------------------------------------------------------ */ public void setTrustManagerAlgorithm(String trustManagerAlgorithm) { this._trustManagerAlgorithm = trustManagerAlgorithm; } /* ------------------------------------------------------------ */ public String getProtocol() { return _protocol; } /* ------------------------------------------------------------ */ public void setProtocol(String protocol) { this._protocol = protocol; } /* ------------------------------------------------------------ */ public String getProvider() { return _provider; } /* ------------------------------------------------------------ */ public void setProvider(String provider) { this._provider = provider; } /* ------------------------------------------------------------ */ public String getSecureRandomAlgorithm() { return _secureRandomAlgorithm; } /* ------------------------------------------------------------ */ public void setSecureRandomAlgorithm(String secureRandomAlgorithm) { this._secureRandomAlgorithm = secureRandomAlgorithm; } }





© 2015 - 2024 Weber Informatics LLC | Privacy Policy