148ded2421114c4c87ef3f8005c9f793a5d077cbdMike Lockwood/* 248ded2421114c4c87ef3f8005c9f793a5d077cbdMike Lockwood * Copyright (c) 2006-2011 Christian Plattner. All rights reserved. 348ded2421114c4c87ef3f8005c9f793a5d077cbdMike Lockwood * Please refer to the LICENSE.txt for licensing details. 448ded2421114c4c87ef3f8005c9f793a5d077cbdMike Lockwood */ 548ded2421114c4c87ef3f8005c9f793a5d077cbdMike Lockwoodpackage ch.ethz.ssh2; 648ded2421114c4c87ef3f8005c9f793a5d077cbdMike Lockwood 748ded2421114c4c87ef3f8005c9f793a5d077cbdMike Lockwood/** 848ded2421114c4c87ef3f8005c9f793a5d077cbdMike Lockwood * A <code>HTTPProxyData</code> object is used to specify the needed connection data 948ded2421114c4c87ef3f8005c9f793a5d077cbdMike Lockwood * to connect through a HTTP proxy. 1048ded2421114c4c87ef3f8005c9f793a5d077cbdMike Lockwood * 1148ded2421114c4c87ef3f8005c9f793a5d077cbdMike Lockwood * @see Connection#setProxyData(ProxyData) 1248ded2421114c4c87ef3f8005c9f793a5d077cbdMike Lockwood * 1348ded2421114c4c87ef3f8005c9f793a5d077cbdMike Lockwood * @author Christian Plattner 1448ded2421114c4c87ef3f8005c9f793a5d077cbdMike Lockwood * @version 2.50, 03/15/10 1548ded2421114c4c87ef3f8005c9f793a5d077cbdMike Lockwood */ 1648ded2421114c4c87ef3f8005c9f793a5d077cbdMike Lockwood 1748ded2421114c4c87ef3f8005c9f793a5d077cbdMike Lockwoodpublic class HTTPProxyData implements ProxyData 1848ded2421114c4c87ef3f8005c9f793a5d077cbdMike Lockwood{ 1948ded2421114c4c87ef3f8005c9f793a5d077cbdMike Lockwood public final String proxyHost; 2048ded2421114c4c87ef3f8005c9f793a5d077cbdMike Lockwood public final int proxyPort; 2148ded2421114c4c87ef3f8005c9f793a5d077cbdMike Lockwood public final String proxyUser; 2248ded2421114c4c87ef3f8005c9f793a5d077cbdMike Lockwood public final String proxyPass; 2348ded2421114c4c87ef3f8005c9f793a5d077cbdMike Lockwood public final String[] requestHeaderLines; 2448ded2421114c4c87ef3f8005c9f793a5d077cbdMike Lockwood 2548ded2421114c4c87ef3f8005c9f793a5d077cbdMike Lockwood /** 2648ded2421114c4c87ef3f8005c9f793a5d077cbdMike Lockwood * Same as calling {@link #HTTPProxyData(String, int, String, String) HTTPProxyData(proxyHost, proxyPort, <code>null</code>, <code>null</code>)} 2748ded2421114c4c87ef3f8005c9f793a5d077cbdMike Lockwood * 2848ded2421114c4c87ef3f8005c9f793a5d077cbdMike Lockwood * @param proxyHost Proxy hostname. 2948ded2421114c4c87ef3f8005c9f793a5d077cbdMike Lockwood * @param proxyPort Proxy port. 3048ded2421114c4c87ef3f8005c9f793a5d077cbdMike Lockwood */ 3148ded2421114c4c87ef3f8005c9f793a5d077cbdMike Lockwood public HTTPProxyData(String proxyHost, int proxyPort) 3248ded2421114c4c87ef3f8005c9f793a5d077cbdMike Lockwood { 3348ded2421114c4c87ef3f8005c9f793a5d077cbdMike Lockwood this(proxyHost, proxyPort, null, null); 3448ded2421114c4c87ef3f8005c9f793a5d077cbdMike Lockwood } 3548ded2421114c4c87ef3f8005c9f793a5d077cbdMike Lockwood 3648ded2421114c4c87ef3f8005c9f793a5d077cbdMike Lockwood /** 3748ded2421114c4c87ef3f8005c9f793a5d077cbdMike Lockwood * Same as calling {@link #HTTPProxyData(String, int, String, String, String[]) HTTPProxyData(proxyHost, proxyPort, <code>null</code>, <code>null</code>, <code>null</code>)} 3848ded2421114c4c87ef3f8005c9f793a5d077cbdMike Lockwood * 3948ded2421114c4c87ef3f8005c9f793a5d077cbdMike Lockwood * @param proxyHost Proxy hostname. 4048ded2421114c4c87ef3f8005c9f793a5d077cbdMike Lockwood * @param proxyPort Proxy port. 4148ded2421114c4c87ef3f8005c9f793a5d077cbdMike Lockwood * @param proxyUser Username for basic authentication (<code>null</code> if no authentication is needed). 4248ded2421114c4c87ef3f8005c9f793a5d077cbdMike Lockwood * @param proxyPass Password for basic authentication (<code>null</code> if no authentication is needed). 4348ded2421114c4c87ef3f8005c9f793a5d077cbdMike Lockwood */ 4448ded2421114c4c87ef3f8005c9f793a5d077cbdMike Lockwood public HTTPProxyData(String proxyHost, int proxyPort, String proxyUser, String proxyPass) 4548ded2421114c4c87ef3f8005c9f793a5d077cbdMike Lockwood { 4648ded2421114c4c87ef3f8005c9f793a5d077cbdMike Lockwood this(proxyHost, proxyPort, proxyUser, proxyPass, null); 4748ded2421114c4c87ef3f8005c9f793a5d077cbdMike Lockwood } 4848ded2421114c4c87ef3f8005c9f793a5d077cbdMike Lockwood 4948ded2421114c4c87ef3f8005c9f793a5d077cbdMike Lockwood /** 5048ded2421114c4c87ef3f8005c9f793a5d077cbdMike Lockwood * Connection data for a HTTP proxy. It is possible to specify a username and password 5148ded2421114c4c87ef3f8005c9f793a5d077cbdMike Lockwood * if the proxy requires basic authentication. Also, additional request header lines can 5248ded2421114c4c87ef3f8005c9f793a5d077cbdMike Lockwood * be specified (e.g., "User-Agent: CERN-LineMode/2.15 libwww/2.17b3"). 5348ded2421114c4c87ef3f8005c9f793a5d077cbdMike Lockwood * <p> 5448ded2421114c4c87ef3f8005c9f793a5d077cbdMike Lockwood * Please note: if you want to use basic authentication, then both <code>proxyUser</code> 5548ded2421114c4c87ef3f8005c9f793a5d077cbdMike Lockwood * and <code>proxyPass</code> must be non-null. 5648ded2421114c4c87ef3f8005c9f793a5d077cbdMike Lockwood * <p> 5748ded2421114c4c87ef3f8005c9f793a5d077cbdMike Lockwood * Here is an example: 5848ded2421114c4c87ef3f8005c9f793a5d077cbdMike Lockwood * <p> 5948ded2421114c4c87ef3f8005c9f793a5d077cbdMike Lockwood * <code> 6048ded2421114c4c87ef3f8005c9f793a5d077cbdMike Lockwood * new HTTPProxyData("192.168.1.1", "3128", "proxyuser", "secret", new String[] {"User-Agent: GanymedBasedClient/1.0", "X-My-Proxy-Option: something"}); 6148ded2421114c4c87ef3f8005c9f793a5d077cbdMike Lockwood * </code> 6248ded2421114c4c87ef3f8005c9f793a5d077cbdMike Lockwood * 6348ded2421114c4c87ef3f8005c9f793a5d077cbdMike Lockwood * @param proxyHost Proxy hostname. 6448ded2421114c4c87ef3f8005c9f793a5d077cbdMike Lockwood * @param proxyPort Proxy port. 6548ded2421114c4c87ef3f8005c9f793a5d077cbdMike Lockwood * @param proxyUser Username for basic authentication (<code>null</code> if no authentication is needed). 6648ded2421114c4c87ef3f8005c9f793a5d077cbdMike Lockwood * @param proxyPass Password for basic authentication (<code>null</code> if no authentication is needed). 6748ded2421114c4c87ef3f8005c9f793a5d077cbdMike Lockwood * @param requestHeaderLines An array with additional request header lines (without end-of-line markers) 6848ded2421114c4c87ef3f8005c9f793a5d077cbdMike Lockwood * that have to be sent to the server. May be <code>null</code>. 6948ded2421114c4c87ef3f8005c9f793a5d077cbdMike Lockwood */ 7048ded2421114c4c87ef3f8005c9f793a5d077cbdMike Lockwood 7148ded2421114c4c87ef3f8005c9f793a5d077cbdMike Lockwood public HTTPProxyData(String proxyHost, int proxyPort, String proxyUser, String proxyPass, 7248ded2421114c4c87ef3f8005c9f793a5d077cbdMike Lockwood String[] requestHeaderLines) 7348ded2421114c4c87ef3f8005c9f793a5d077cbdMike Lockwood { 7448ded2421114c4c87ef3f8005c9f793a5d077cbdMike Lockwood if (proxyHost == null) 7548ded2421114c4c87ef3f8005c9f793a5d077cbdMike Lockwood throw new IllegalArgumentException("proxyHost must be non-null"); 7648ded2421114c4c87ef3f8005c9f793a5d077cbdMike Lockwood 7748ded2421114c4c87ef3f8005c9f793a5d077cbdMike Lockwood if (proxyPort < 0) 7848ded2421114c4c87ef3f8005c9f793a5d077cbdMike Lockwood throw new IllegalArgumentException("proxyPort must be non-negative"); 7948ded2421114c4c87ef3f8005c9f793a5d077cbdMike Lockwood 8048ded2421114c4c87ef3f8005c9f793a5d077cbdMike Lockwood this.proxyHost = proxyHost; 8148ded2421114c4c87ef3f8005c9f793a5d077cbdMike Lockwood this.proxyPort = proxyPort; 8248ded2421114c4c87ef3f8005c9f793a5d077cbdMike Lockwood this.proxyUser = proxyUser; 8348ded2421114c4c87ef3f8005c9f793a5d077cbdMike Lockwood this.proxyPass = proxyPass; 8448ded2421114c4c87ef3f8005c9f793a5d077cbdMike Lockwood this.requestHeaderLines = requestHeaderLines; 8548ded2421114c4c87ef3f8005c9f793a5d077cbdMike Lockwood } 8648ded2421114c4c87ef3f8005c9f793a5d077cbdMike Lockwood} 87