1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
|
<!-- Links to Codesite stylesheet; for help in editing/previewing article only -->
<title>Using Proxy servers</title>
<!-- Article Begins -->
<h1>Living Vicariously: Using Proxy Servers with the Google data API Client Libraries</h1>
<em>Jeff Fisher, Google data APIs team
<br>June 2007</em>
<ul>
<li><a href="#introduction">Introduction: Why proxy?</a></li>
<li><a href="#java">Java</a></li>
<li><a href="#dotnet">.NET</a></li>
<li><a href="#conclusion">Conclusion</a></li>
</ul>
<a name="introduction"><h3>Introduction: Why proxy?</h3></a>
<p class="para">A proxy server is a computer (or service on a computer) that makes requests for a number of client computers on their behalf, typically to external resources. This article is concerned with HTTP proxy servers as HTTP is the protocol used to access the public APIs for Google's web services. By extension, HTTPS or SSL proxies are also of interest when making HTTP requests that contain sensitive information such as private user data or passwords. Many large companies today use HTTP proxies to control what websites or information employees can view on the internet. Public libraries and schools have also been known to implement proxies for this purpose. There are also a number of publicly available proxy servers that can be used to anonymously access web content.</p>
<p class="para">Potential issues faced when using a proxy server depend on what software is being used and how it is configured. A proxy is considered to be "transparent" if it does not alter the request from the client or the response from the server in any way other than is necessary for proxy identification and authentication. However, a large number of proxy servers do alter either the request or the response in ways that a developer should be aware of. In particular, certain proxies will alter the content-type of the response or strip out HTTP keep-alive headers from being sent to the outside server hosting the resource.</p>
<p class="para">So why would a developer want to use an HTTP or SSL proxy? Generally, there are
two reasons for this: it is required by some corporate infrastructure, or, the
developer wishes to debug an application that uses a web service. The
first reason is entirely unavoidable if the rules for the network the developer
is working on prohibit non-proxied web or SSL connections to external websites.
The latter reason is reported frequently in our support forums by developers trying to
troubleshoot issues when dealing with a Google web service. There are
special-purpose "debugging" proxies such as <a href="http://www.fiddlertool.com/fiddler/" title="Fiddler">Fiddler</a> and <a href="http://www.xk72.com/charles/" title="Charles">Charles</a> that are geared towards this exact situation. For more information on this use of a proxy
server, you may want to read our article <a href="http://code.google.com/" title="On the Wire: Tools for API Developers">On the Wire: Tools for API Developers</a>.</p>
<p class="para">For some applications, adding in proxy server support can be difficult.
Fortunately, most of the client libraries for the Google data API can be made to
work with an HTTP proxy server after some slight code modifications. This article
is intended to serve as a starting point for a developer who would like to use a
proxy server for the web requests made by their application.</p>
<a name="java"><h3>Java</h3></a>
<p class="para">Using an HTTP proxy with the Java client library is easy thanks to Sun's use of system properties to manage connection settings.</p>
<p class="para">For example, if your corporate proxy server were running on "my.proxy.domain.com", on port 3128, you could add the following to your code before creating a service object for Google Calendar, Google Spreadsheets, etc.</p>
<pre>
System.setProperty("http.proxyHost", "my.proxy.domain.com");
System.setProperty("http.proxyPort", "3128");
</pre>
<p class="para">Alternatively, this can be done on the command line when starting your servlet environment:</p>
<pre>
java -Dhttp.proxyHost=my.proxy.domain.com -Dhttp.proxyPort=3128
</pre>
<p class="para">With more recent versions of the JSSE package, this can be extended to SSL proxies as well. If the same proxy server in the previous example was running an SSL proxy on port 3129, the necessary code would be:</p>
<pre>
System.setProperty("https.proxyHost", "my.proxy.domain.com");
System.setProperty("https.proxyPort", "3129");
</pre>
<p class="para">This can also be done from the command line in the same fashion as with the HTTP proxy.</p>
<a name="dotnet"><h3>.NET</h3></a>
<p class="para">To use an HTTP proxy with the .NET client library is not as trivial as with the Java client, but it can be accomplished in a similar way when creating the service object for a particular product.</p>
<p class="para">For example, we might want to use a proxy to interact with the Google Calendar service:</p>
<pre>
using System.Net;
CalendarService service = new CalendarService("CalendarSampleApp");
query.Uri = new Uri(calendarURI);
GDataRequestFactory requestFactory = (GDataRequestFactory) service.RequestFactory;
IWebProxy iProxy = WebRequest.DefaultWebProxy;
WebProxy myProxy = new WebProxy(iProxy.GetProxy(query.Uri));
// potentially, setup credentials on the proxy here
myProxy.Credentials = CredentialCache.DefaultCredentials;
myProxy.UseDefaultCredentials = true;
requestFactory.Proxy = myProxy;
</pre>
<p class="para">This should detect the necessary proxy from your Internet connection settings--a nice feature of the .NET library. However, if you do not trust it to discover the proxy properly, you can also set it by changing the code to:</p>
<pre>
using System.Net;
CalendarService service = new CalendarService("CalendarSampleApp");
GDataRequestFactory requestFactory = (GDataRequestFactory) service.RequestFactory;
WebProxy myProxy = new WebProxy("http://my.proxy.example.com:3128/",true);
// potentially, setup credentials on the proxy here
myProxy.Credentials = CredentialCache.DefaultCredentials;
myProxy.UseDefaultCredentials = true;
requestFactory.Proxy = myProxy;
</pre>
<a name="conclusion"><h3>Conclusion</h3></a>
<p class="para">This article has discussed how to have some of the Google data API client libraries work with an HTTP proxy server. Developers working behind a proxy server mandated by network policy can still use these libraries. Developers can also employ a proxy server to help debug their code by having the proxy server record the contents of HTTP requests and responses being sent to and from a Google web service. There are more advanced use cases of a proxy server and other client libraries not covered by this tutorial. Developers needing additional help are encouraged to participate in our public support groups linked below.</p>
<p class="para">For additional information on the client libraries used in this article, visit the following pages:</p>
<ul>
<li><a href="http://code.google.com/p/gdata-java-client/">Java</a></li>
<li><a href="http://code.google.com/p/google-gdata/">.NET</a></li>
</ul>
<p class="para">Other Resources:</p>
<ul>
<li><a href="http://groups.google.com/group/google-help-dataapi">Google data APIs support group</a></li>
<li><a href="http://code.google.com/p/gdata-objectivec-client/wiki/GDataObjCIntroduction">Objective-C introduction wiki page</a> - briefly discusses catching errors from a proxy server and authenticating with a user dialog. </li>
</ul>
<!-- Article Ends -->
|
