-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathDocumentList.java
More file actions
977 lines (870 loc) · 34 KB
/
DocumentList.java
File metadata and controls
977 lines (870 loc) · 34 KB
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
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
/* Copyright (c) 2008 Google Inc.
*
* Licensed 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.
*/
package sample.docs;
import com.google.gdata.client.GoogleAuthTokenFactory.UserToken;
import com.google.gdata.client.GoogleService;
import com.google.gdata.client.Query;
import com.google.gdata.client.docs.DocsService;
import com.google.gdata.data.MediaContent;
import com.google.gdata.data.PlainTextConstruct;
import com.google.gdata.data.acl.AclEntry;
import com.google.gdata.data.acl.AclFeed;
import com.google.gdata.data.acl.AclRole;
import com.google.gdata.data.acl.AclScope;
import com.google.gdata.data.docs.DocumentEntry;
import com.google.gdata.data.docs.DocumentListEntry;
import com.google.gdata.data.docs.DocumentListFeed;
import com.google.gdata.data.docs.FolderEntry;
import com.google.gdata.data.docs.PresentationEntry;
import com.google.gdata.data.docs.RevisionFeed;
import com.google.gdata.data.docs.SpreadsheetEntry;
import com.google.gdata.data.media.MediaSource;
import com.google.gdata.util.AuthenticationException;
import com.google.gdata.util.ServiceException;
import java.io.File;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.InputStream;
import java.net.MalformedURLException;
import java.net.URL;
import java.util.HashMap;
import java.util.Iterator;
import java.util.Map;
import java.util.Set;
/**
* An application that serves as a sample to show how the Documents List Service
* can be used to search your documents, upload and download files, change
* sharing permission, file documents in folders, and view revisions history.
*
*
*
*/
public class DocumentList {
public DocsService service;
public GoogleService spreadsheetsService;
public static final String DEFAULT_AUTH_PROTOCOL = "https";
public static final String DEFAULT_AUTH_HOST = "docs.google.com";
public static final String DEFAULT_PROTOCOL = "http";
public static final String DEFAULT_HOST = "docs.google.com";
public static final String SPREADSHEETS_SERVICE_NAME = "wise";
public static final String SPREADSHEETS_HOST = "spreadsheets.google.com";
private final String URL_FEED = "/feeds";
private final String URL_DOWNLOAD = "/download";
private final String URL_DOCLIST_FEED = "/private/full";
private final String URL_DEFAULT = "/default";
private final String URL_FOLDERS = "/contents";
private final String URL_ACL = "/acl";
private final String URL_REVISIONS = "/revisions";
private final String URL_CATEGORY_DOCUMENT = "/-/document";
private final String URL_CATEGORY_SPREADSHEET = "/-/spreadsheet";
private final String URL_CATEGORY_PDF = "/-/pdf";
private final String URL_CATEGORY_PRESENTATION = "/-/presentation";
private final String URL_CATEGORY_STARRED = "/-/starred";
private final String URL_CATEGORY_TRASHED = "/-/trashed";
private final String URL_CATEGORY_FOLDER = "/-/folder";
private final String URL_CATEGORY_EXPORT = "/Export";
private final String PARAMETER_SHOW_FOLDERS = "showfolders=true";
private String applicationName;
private String authProtocol;
private String authHost;
private String protocol;
private String host;
private String username;
private String password;
private String authSubToken;
private final Map<String, String> DOWNLOAD_DOCUMENT_FORMATS;
{
DOWNLOAD_DOCUMENT_FORMATS = new HashMap<String, String>();
DOWNLOAD_DOCUMENT_FORMATS.put("doc", "doc");
DOWNLOAD_DOCUMENT_FORMATS.put("txt", "txt");
DOWNLOAD_DOCUMENT_FORMATS.put("odt", "odt");
DOWNLOAD_DOCUMENT_FORMATS.put("pdf", "pdf");
DOWNLOAD_DOCUMENT_FORMATS.put("png", "png");
DOWNLOAD_DOCUMENT_FORMATS.put("rtf", "rtf");
DOWNLOAD_DOCUMENT_FORMATS.put("html", "html");
DOWNLOAD_DOCUMENT_FORMATS.put("zip", "zip");
}
private final Map<String, String> DOWNLOAD_PRESENTATION_FORMATS;
{
DOWNLOAD_PRESENTATION_FORMATS = new HashMap<String, String>();
DOWNLOAD_PRESENTATION_FORMATS.put("pdf", "pdf");
DOWNLOAD_PRESENTATION_FORMATS.put("png", "png");
DOWNLOAD_PRESENTATION_FORMATS.put("ppt", "ppt");
DOWNLOAD_PRESENTATION_FORMATS.put("swf", "swf");
DOWNLOAD_PRESENTATION_FORMATS.put("txt", "txt");
}
private final Map<String, String> DOWNLOAD_SPREADSHEET_FORMATS;
{
DOWNLOAD_SPREADSHEET_FORMATS = new HashMap<String, String>();
DOWNLOAD_SPREADSHEET_FORMATS.put("xls", "xls");
DOWNLOAD_SPREADSHEET_FORMATS.put("ods", "ods");
DOWNLOAD_SPREADSHEET_FORMATS.put("pdf", "pdf");
DOWNLOAD_SPREADSHEET_FORMATS.put("csv", "csv");
DOWNLOAD_SPREADSHEET_FORMATS.put("tsv", "tsv");
DOWNLOAD_SPREADSHEET_FORMATS.put("html", "html");
}
/**
* Constructor.
*
* @param applicationName name of the application.
*
* @throws DocumentListException
*/
public DocumentList(String applicationName) throws DocumentListException {
this(applicationName, DEFAULT_AUTH_PROTOCOL, DEFAULT_AUTH_HOST, DEFAULT_PROTOCOL, DEFAULT_HOST);
}
/**
* Constructor
*
* @param applicationName name of the application
* @param authProtocol the protocol to use for authentication
* @param authHost the host to use for authentication
* @param protocol the protocol to use for the http calls.
* @param host the host that contains the feeds
*
* @throws DocumentListException
*/
public DocumentList(String applicationName, String authProtocol, String authHost,
String protocol, String host) throws DocumentListException {
if (authProtocol == null || authHost == null || protocol == null || host == null) {
throw new DocumentListException("null passed in required parameters");
}
service = new DocsService(applicationName);
// Creating a spreadsheets service is necessary for downloading spreadsheets
spreadsheetsService = new GoogleService(SPREADSHEETS_SERVICE_NAME, applicationName);
this.applicationName = applicationName;
this.authProtocol = authProtocol;
this.authHost = authHost;
this.protocol = protocol;
this.host = host;
}
/**
* Set user credentials based on a username and password.
*
* @param user username to log in with.
* @param pass password for the user logging in.
*
* @throws AuthenticationException
* @throws DocumentListException
*/
public void login(String user, String pass) throws AuthenticationException,
DocumentListException {
if (user == null || pass == null) {
throw new DocumentListException("null login credentials");
}
this.username = user;
this.password = pass;
this.authSubToken = "";
service.setUserCredentials(user, pass);
spreadsheetsService.setUserCredentials(user, pass);
}
/**
* Allow a user to login using an AuthSub token.
*
* @param token the token to be used when logging in.
*
* @throws AuthenticationException
* @throws DocumentListException
*/
public void loginWithAuthSubToken(String token) throws AuthenticationException,
DocumentListException {
if (token == null) {
throw new DocumentListException("null login credentials");
}
this.authSubToken = token;
this.username = "";
this.password = "";
service.setAuthSubToken(token);
spreadsheetsService.setAuthSubToken(token);
}
/**
* Create a new item in the DocList.
*
* @param title the title of the document to be created.
* @param type the type of the document to be created. One of "spreadsheet",
* "presentation", or "document".
*
* @throws DocumentListException
* @throws ServiceException
* @throws IOException
* @throws MalformedURLException
*/
public DocumentListEntry createNew(String title, String type) throws MalformedURLException,
IOException, ServiceException,
DocumentListException {
if (title == null || type == null) {
throw new DocumentListException("null title or type");
}
DocumentListEntry newEntry = null;
if (type.equals("document")) {
newEntry = new DocumentEntry();
} else if (type.equals("presentation")) {
newEntry = new PresentationEntry();
} else if (type.equals("spreadsheet")) {
newEntry = new SpreadsheetEntry();
} else if (type.equals("folder")) {
newEntry = new FolderEntry();
}
newEntry.setTitle(new PlainTextConstruct(title));
return service.insert(buildUrl(URL_DEFAULT + URL_DOCLIST_FEED), newEntry);
}
/**
* Gets a feed containing the documents.
*
* @param category what types of documents to list:
* "all": lists all the doc objects (documents, spreadsheets, presentations)
* "folders": lists all doc objects including folders.
* "documents": lists only documents.
* "spreadsheets": lists only spreadsheets.
* "pdfs": lists only pdfs.
* "presentations": lists only presentations.
* "starred": lists only starred objects.
* "trashed": lists trashed objects.
*
* @throws IOException
* @throws MalformedURLException
* @throws ServiceException
* @throws DocumentListException
*/
public DocumentListFeed getDocsListFeed(String category) throws IOException,
MalformedURLException, ServiceException, DocumentListException {
if (category == null) {
throw new DocumentListException("null category");
}
URL url;
if (category.equals("all")) {
url = buildUrl(URL_DEFAULT + URL_DOCLIST_FEED);
} else if (category.equals("folders")) {
String[] parameters = {PARAMETER_SHOW_FOLDERS};
url = buildUrl(URL_DEFAULT + URL_DOCLIST_FEED + URL_CATEGORY_FOLDER, parameters);
} else if (category.equals("documents")) {
url = buildUrl(URL_DEFAULT + URL_DOCLIST_FEED + URL_CATEGORY_DOCUMENT);
} else if (category.equals("spreadsheets")) {
url = buildUrl(URL_DEFAULT + URL_DOCLIST_FEED + URL_CATEGORY_SPREADSHEET);
} else if (category.equals("pdfs")) {
url = buildUrl(URL_DEFAULT + URL_DOCLIST_FEED + URL_CATEGORY_PDF);
} else if (category.equals("presentations")) {
url = buildUrl(URL_DEFAULT + URL_DOCLIST_FEED + URL_CATEGORY_PRESENTATION);
} else if (category.equals("starred")) {
url = buildUrl(URL_DEFAULT + URL_DOCLIST_FEED + URL_CATEGORY_STARRED);
} else if (category.equals("trashed")) {
url = buildUrl(URL_DEFAULT + URL_DOCLIST_FEED + URL_CATEGORY_TRASHED);
} else {
return null;
}
return service.getFeed(url, DocumentListFeed.class);
}
/**
* Gets the entry for the provided object id.
*
* @param resourceId the resource id of the object to fetch an entry for.
*
* @throws IOException
* @throws MalformedURLException
* @throws ServiceException
* @throws DocumentListException
*/
public DocumentListEntry getDocsListEntry(String resourceId) throws IOException,
MalformedURLException, ServiceException, DocumentListException {
if (resourceId == null) {
throw new DocumentListException("null resourceId");
}
URL url = buildUrl(URL_DEFAULT + URL_DOCLIST_FEED + "/" + resourceId);
return service.getEntry(url, DocumentListEntry.class);
}
/**
* Gets the feed for all the objects contained in a folder.
*
* @param folderResourceId the resource id of the folder to return the feed
* for the contents.
*
* @throws IOException
* @throws MalformedURLException
* @throws ServiceException
* @throws DocumentListException
*/
public DocumentListFeed getFolderDocsListFeed(String folderResourceId) throws IOException,
MalformedURLException, ServiceException, DocumentListException {
if (folderResourceId == null) {
throw new DocumentListException("null folderResourceId");
}
URL url = buildUrl(URL_DEFAULT + URL_DOCLIST_FEED + "/" + folderResourceId
+ URL_FOLDERS);
return service.getFeed(url, DocumentListFeed.class);
}
/**
* Gets a feed containing the documents.
*
* @param resourceId the resource id of the object to fetch revisions for.
*
* @throws IOException
* @throws MalformedURLException
* @throws ServiceException
* @throws DocumentListException
*/
public RevisionFeed getRevisionsFeed(String resourceId) throws IOException,
MalformedURLException, ServiceException, DocumentListException {
if (resourceId == null) {
throw new DocumentListException("null resourceId");
}
URL url = buildUrl(URL_DEFAULT + URL_DOCLIST_FEED + "/" + resourceId
+ URL_REVISIONS);
return service.getFeed(url, RevisionFeed.class);
}
/**
* Search the documents, and return a feed of docs that match.
*
* @param searchParameters parameters to be used in searching criteria.
*
* @throws IOException
* @throws MalformedURLException
* @throws ServiceException
* @throws DocumentListException
*/
public DocumentListFeed search(Map<String, String> searchParameters) throws IOException,
MalformedURLException, ServiceException, DocumentListException {
return search(searchParameters, null);
}
/**
* Search the documents, and return a feed of docs that match.
*
* @param searchParameters parameters to be used in searching criteria.
* accepted parameters are:
* "q": Typical search query
* "alt":
* "author":
* "updated-min": Lower bound on the last time a document' content was changed.
* "updated-max": Upper bound on the last time a document' content was changed.
* "edited-min": Lower bound on the last time a document was edited by the
* current user. This value corresponds to the app:edited value in the
* Atom entry, which represents changes to the document's content or metadata.
* "edited-max": Upper bound on the last time a document was edited by the
* current user. This value corresponds to the app:edited value in the
* Atom entry, which represents changes to the document's content or metadata.
* "title": Specifies the search terms for the title of a document.
* This parameter used without title-exact will only submit partial queries, not exact
* queries.
* "title-exact": Specifies whether the title query should be taken as an exact string.
* Meaningless without title. Possible values are true and false.
* "opened-min": Bounds on the last time a document was opened by the current user.
* Use the RFC 3339 timestamp format. For example: 2005-08-09T10:57:00-08:00
* "opened-max": Bounds on the last time a document was opened by the current user.
* Use the RFC 3339 timestamp format. For example: 2005-08-09T10:57:00-08:00
* "owner": Searches for documents with a specific owner.
* Use the email address of the owner.
* "writer": Searches for documents which can be written to by specific users.
* Use a single email address or a comma separated list of email addresses.
* "reader": Searches for documents which can be read by specific users.
* Use a single email address or a comma separated list of email addresses.
* "showfolders": Specifies whether the query should return folders as well as documents.
* Possible values are true and false.
* @param category define the category to search. (documents, spreadsheets, presentations,
* starred, trashed, folders)
*
* @throws IOException
* @throws MalformedURLException
* @throws ServiceException
* @throws DocumentListException
*/
public DocumentListFeed search(Map<String, String> searchParameters, String category)
throws IOException, MalformedURLException, ServiceException, DocumentListException {
if (searchParameters == null) {
throw new DocumentListException("searchParameters null");
}
URL url;
if (category == null || category.equals("")) {
url = buildUrl(URL_DEFAULT + URL_DOCLIST_FEED);
} else if (category.equals("documents")) {
url = buildUrl(URL_DEFAULT + URL_DOCLIST_FEED + URL_CATEGORY_DOCUMENT);
} else if (category.equals("spreadsheets")) {
url = buildUrl(URL_DEFAULT + URL_DOCLIST_FEED + URL_CATEGORY_SPREADSHEET);
} else if (category.equals("presentations")) {
url = buildUrl(URL_DEFAULT + URL_DOCLIST_FEED + URL_CATEGORY_PRESENTATION);
} else if (category.equals("starred")) {
url = buildUrl(URL_DEFAULT + URL_DOCLIST_FEED + URL_CATEGORY_STARRED);
} else if (category.equals("trashed")) {
url = buildUrl(URL_DEFAULT + URL_DOCLIST_FEED + URL_CATEGORY_TRASHED);
} else if (category.equals("folders")) {
url = buildUrl(URL_DEFAULT + URL_DOCLIST_FEED + URL_CATEGORY_FOLDER);
} else {
throw new DocumentListException("invaild category");
}
Query qry = new Query(url);
for (String key : searchParameters.keySet()) {
qry.setStringCustomParameter(key, searchParameters.get(key));
}
return service.query(qry, DocumentListFeed.class);
}
/**
* Upload a file.
*
* @param filepath path to uploaded file.
* @param title title to use for uploaded file.
*
* @throws ServiceException when the request causes an error in the Doclist
* service.
* @throws IOException when an error occurs in communication with the Doclist
* service.
* @throws DocumentListException
*/
public DocumentListEntry uploadFile(String filepath, String title) throws IOException,
ServiceException, DocumentListException {
if (filepath == null || title == null) {
throw new DocumentListException("null passed in for required parameters");
}
File file = new File(filepath);
String mimeType = DocumentListEntry.MediaType.fromFileName(file.getName())
.getMimeType();
DocumentEntry newDocument = new DocumentEntry();
newDocument.setFile(file, mimeType);
newDocument.setTitle(new PlainTextConstruct(title));
return service
.insert(buildUrl(URL_DEFAULT + URL_DOCLIST_FEED), newDocument);
}
/**
* Trash an object.
*
* @param resourceId the resource id of object to be trashed.
* @param delete true to delete the permanently, false to move it to the
* trash.
*
* @throws IOException
* @throws MalformedURLException
* @throws ServiceException
* @throws DocumentListException
*/
public void trashObject(String resourceId, boolean delete) throws IOException,
MalformedURLException, ServiceException, DocumentListException {
if (resourceId == null) {
throw new DocumentListException("null resourceId");
}
String feedUrl = URL_DEFAULT + URL_DOCLIST_FEED + "/" + resourceId;
if (delete) {
feedUrl += "?delete=true";
}
service.delete(buildUrl(feedUrl), getDocsListEntry(resourceId).getEtag());
}
/**
* Remove an object from a folder.
*
* @param resourceId the resource id of an object to be removed from the
* folder.
* @param folderResourceId the resource id of the folder to remove the object
* from.
*
* @throws IOException
* @throws MalformedURLException
* @throws ServiceException
* @throws DocumentListException
*/
public void removeFromFolder(String resourceId, String folderResourceId)
throws IOException, MalformedURLException, ServiceException,
DocumentListException {
if (resourceId == null || folderResourceId == null) {
throw new DocumentListException("null passed in for required parameters");
}
URL url = buildUrl(URL_DEFAULT + URL_DOCLIST_FEED + "/" + folderResourceId
+ URL_FOLDERS + "/" + resourceId);
service.delete(url, getDocsListEntry(resourceId).getEtag());
}
/**
* Downloads a file.
*
* @param exportUrl the full url of the export link to download the file from.
* @param filepath path and name of the object to be saved as.
*
* @throws IOException
* @throws MalformedURLException
* @throws ServiceException
* @throws DocumentListException
*/
public void downloadFile(URL exportUrl, String filepath) throws IOException,
MalformedURLException, ServiceException, DocumentListException {
if (exportUrl == null || filepath == null) {
throw new DocumentListException("null passed in for required parameters");
}
MediaContent mc = new MediaContent();
mc.setUri(exportUrl.toString());
MediaSource ms = service.getMedia(mc);
InputStream inStream = null;
FileOutputStream outStream = null;
try {
inStream = ms.getInputStream();
outStream = new FileOutputStream(filepath);
int c;
while ((c = inStream.read()) != -1) {
outStream.write(c);
}
} finally {
if (inStream != null) {
inStream.close();
}
if (outStream != null) {
outStream.flush();
outStream.close();
}
}
}
/**
* Downloads a spreadsheet file.
*
* @param filepath path and name of the object to be saved as.
* @param resourceId the resource id of the object to be downloaded.
* @param format format to download the file to. The following file types are
* supported: spreadsheets: "ods", "pdf", "xls", "csv", "html", "tsv"
*
* @throws IOException
* @throws MalformedURLException
* @throws ServiceException
* @throws DocumentListException
*/
public void downloadSpreadsheet(String resourceId, String filepath,
String format) throws IOException, MalformedURLException,
ServiceException, DocumentListException {
if (resourceId == null || filepath == null || format == null) {
throw new DocumentListException("null passed in for required parameters");
}
UserToken docsToken = (UserToken) service.getAuthTokenFactory()
.getAuthToken();
UserToken spreadsheetsToken = (UserToken) spreadsheetsService
.getAuthTokenFactory().getAuthToken();
service.setUserToken(spreadsheetsToken.getValue());
HashMap<String, String> parameters = new HashMap<String, String>();
parameters
.put("key", resourceId.substring(resourceId.lastIndexOf(':') + 1));
parameters.put("exportFormat", format);
// If exporting to .csv or .tsv, add the gid parameter to specify which
// sheet to export
if (format.equals(DOWNLOAD_SPREADSHEET_FORMATS.get("csv"))
|| format.equals(DOWNLOAD_SPREADSHEET_FORMATS.get("tsv"))) {
parameters.put("gid", "0"); // download only the first sheet
}
URL url = buildUrl(SPREADSHEETS_HOST, URL_DOWNLOAD + "/spreadsheets"
+ URL_CATEGORY_EXPORT, parameters);
downloadFile(url, filepath);
// Restore docs token for our DocList client
service.setUserToken(docsToken.getValue());
}
/**
* Downloads a document.
*
* @param filepath path and name of the object to be saved as.
* @param resourceId the resource id of the object to be downloaded.
* @param format format to download the file to. The following file types are
* supported: documents: "doc", "txt", "odt", "png", "pdf", "rtf",
* "html"
*
* @throws IOException
* @throws MalformedURLException
* @throws ServiceException
* @throws DocumentListException
*/
public void downloadDocument(String resourceId, String filepath, String format)
throws IOException, MalformedURLException, ServiceException,
DocumentListException {
if (resourceId == null || filepath == null || format == null) {
throw new DocumentListException("null passed in for required parameters");
}
String[] parameters = {"docID=" + resourceId, "exportFormat=" + format};
URL url = buildUrl(URL_DOWNLOAD + "/documents" + URL_CATEGORY_EXPORT,
parameters);
downloadFile(url, filepath);
}
/**
* Downloads a presentation.
*
* @param filepath path and name of the object to be saved as.
* @param resourceId the resource id of the object to be downloaded.
* @param format format to download the file to. The following file types are
* supported: presentations: "pdf", "ppt", "png", "swf", "txt"
*
* @throws IOException
* @throws MalformedURLException
* @throws ServiceException
* @throws DocumentListException
*/
public void downloadPresentation(String resourceId, String filepath,
String format) throws IOException, MalformedURLException,
ServiceException, DocumentListException {
if (resourceId == null || filepath == null || format == null) {
throw new DocumentListException("null passed in for required parameters");
}
String[] parameters = {"docID=" + resourceId, "exportFormat=" + format};
URL url = buildUrl(URL_DOWNLOAD + "/presentations" + URL_CATEGORY_EXPORT,
parameters);
downloadFile(url, filepath);
}
/**
* Moves a object to a folder.
*
* @param resourceId the resource id of the object to be moved to the folder.
* @param folderId the id of the folder to move the object to.
*
* @throws IOException
* @throws MalformedURLException
* @throws ServiceException
* @throws DocumentListException
*/
public DocumentListEntry moveObjectToFolder(String resourceId, String folderId)
throws IOException, MalformedURLException, ServiceException, DocumentListException {
if (resourceId == null || folderId == null) {
throw new DocumentListException("null passed in for required parameters");
}
DocumentListEntry doc = new DocumentListEntry();
doc.setId(buildUrl(URL_DEFAULT + URL_DOCLIST_FEED + "/" + resourceId).toString());
URL url = buildUrl(URL_DEFAULT + URL_DOCLIST_FEED + "/" + folderId + URL_FOLDERS);
return service.insert(url, doc);
}
/**
* Gets the access control list for a object.
*
* @param resourceId the resource id of the object to retrieve the ACL for.
*
* @throws IOException
* @throws MalformedURLException
* @throws ServiceException
* @throws DocumentListException
*/
public AclFeed getAclFeed(String resourceId) throws IOException,
MalformedURLException, ServiceException, DocumentListException {
if (resourceId == null) {
throw new DocumentListException("null resourceId");
}
URL url = buildUrl(URL_DEFAULT + URL_DOCLIST_FEED + "/" + resourceId
+ URL_ACL);
return service.getFeed(url, AclFeed.class);
}
/**
* Add an ACL role to an object.
*
* @param role the role of the ACL to be added to the object.
* @param scope the scope for the ACL.
* @param resourceId the resource id of the object to set the ACL for.
*
* @throws IOException
* @throws MalformedURLException
* @throws ServiceException
* @throws DocumentListException
*/
public AclEntry addAclRole(AclRole role, AclScope scope, String resourceId)
throws IOException, MalformedURLException, ServiceException,
DocumentListException {
if (role == null || scope == null || resourceId == null) {
throw new DocumentListException("null passed in for required parameters");
}
AclEntry entry = new AclEntry();
entry.setRole(role);
entry.setScope(scope);
URL url = buildUrl(URL_DEFAULT + URL_DOCLIST_FEED + "/" + resourceId + URL_ACL);
return service.insert(url, entry);
}
/**
* Change the ACL role of a file.
*
* @param role the new role of the ACL to be updated.
* @param scope the new scope for the ACL.
* @param resourceId the resource id of the object to be updated.
*
* @throws IOException
* @throws MalformedURLException
* @throws ServiceException
* @throws DocumentListException
*/
public AclEntry changeAclRole(AclRole role, AclScope scope, String resourceId) throws IOException,
MalformedURLException, ServiceException, DocumentListException {
if (role == null || scope == null || resourceId == null) {
throw new DocumentListException("null passed in for required parameters");
}
URL url = buildUrl(URL_DEFAULT + URL_DOCLIST_FEED + "/" + resourceId
+ URL_ACL);
return service.update(url, scope, role);
}
/**
* Remove an ACL role from a object.
*
* @param scope scope of the ACL to be removed.
* @param email email address to remove the role of.
* @param resourceId the resource id of the object to remove the role from.
*
* @throws IOException
* @throws MalformedURLException
* @throws ServiceException
* @throws DocumentListException
*/
public void removeAclRole(String scope, String email, String resourceId) throws IOException,
MalformedURLException, ServiceException, DocumentListException {
if (scope == null || email == null || resourceId == null) {
throw new DocumentListException("null passed in for required parameters");
}
URL url = buildUrl(URL_DEFAULT + URL_DOCLIST_FEED + "/" + resourceId
+ URL_ACL + "/" + scope + "%3A" + email);
service.delete(url);
}
/**
* Returns the format code based on a file extension, and object id.
*
* @param resourceId the resource id of the object you want the format for.
* @param ext extension of the file you want the format for.
*
* @throws DocumentListException
*/
public String getDownloadFormat(String resourceId, String ext) throws DocumentListException {
if (resourceId == null || ext == null) {
throw new DocumentListException("null passed in for required parameters");
}
if (resourceId.indexOf("document") == 0) {
if (DOWNLOAD_DOCUMENT_FORMATS.containsKey(ext)) {
return DOWNLOAD_DOCUMENT_FORMATS.get(ext);
}
} else if (resourceId.indexOf("presentation") == 0) {
if (DOWNLOAD_PRESENTATION_FORMATS.containsKey(ext)) {
return DOWNLOAD_PRESENTATION_FORMATS.get(ext);
}
} else if (resourceId.indexOf("spreadsheet") == 0) {
if (DOWNLOAD_SPREADSHEET_FORMATS.containsKey(ext)) {
return DOWNLOAD_SPREADSHEET_FORMATS.get(ext);
}
}
throw new DocumentListException("invalid document type");
}
/**
* Gets the suffix of the resourceId. If the resourceId is
* "document:dh3bw3j_0f7xmjhd8", "dh3bw3j_0f7xmjhd8" will be returned.
*
* @param resourceId the resource id to extract the suffix from.
*
* @throws DocumentListException
*/
public String getResourceIdSuffix(String resourceId) throws DocumentListException {
if (resourceId == null) {
throw new DocumentListException("null resourceId");
}
if (resourceId.indexOf("%3A") != -1) {
return resourceId.substring(resourceId.lastIndexOf("%3A") + 3);
} else if (resourceId.indexOf(":") != -1) {
return resourceId.substring(resourceId.lastIndexOf(":") + 1);
}
throw new DocumentListException("Bad resourceId");
}
/**
* Gets the prefix of the resourceId. If the resourceId is
* "document:dh3bw3j_0f7xmjhd8", "document" will be returned.
*
* @param resourceId the resource id to extract the suffix from.
*
* @throws DocumentListException
*/
public String getResourceIdPrefix(String resourceId) throws DocumentListException {
if (resourceId == null) {
throw new DocumentListException("null resourceId");
}
if (resourceId.indexOf("%3A") != -1) {
return resourceId.substring(0, resourceId.indexOf("%3A"));
} else if (resourceId.indexOf(":") != -1) {
return resourceId.substring(0, resourceId.indexOf(":"));
} else {
throw new DocumentListException("Bad resourceId");
}
}
/**
* Builds a URL from a patch.
*
* @param path the path to add to the protocol/host
*
* @throws MalformedURLException
* @throws DocumentListException
*/
private URL buildUrl(String path) throws MalformedURLException, DocumentListException {
if (path == null) {
throw new DocumentListException("null path");
}
return buildUrl(path, null);
}
/**
* Builds a URL with parameters.
*
* @param path the path to add to the protocol/host
* @param parameters parameters to be added to the URL.
*
* @throws MalformedURLException
* @throws DocumentListException
*/
private URL buildUrl(String path, String[] parameters)
throws MalformedURLException, DocumentListException {
if (path == null) {
throw new DocumentListException("null path");
}
return buildUrl(host, path, parameters);
}
/**
* Builds a URL with parameters.
*
* @param domain the domain of the server
* @param path the path to add to the protocol/host
* @param parameters parameters to be added to the URL.
*
* @throws MalformedURLException
* @throws DocumentListException
*/
private URL buildUrl(String domain, String path, String[] parameters)
throws MalformedURLException, DocumentListException {
if (path == null) {
throw new DocumentListException("null path");
}
StringBuffer url = new StringBuffer();
url.append(protocol + "://" + domain + URL_FEED + path);
if (parameters != null && parameters.length > 0) {
url.append("?");
for (int i = 0; i < parameters.length; i++) {
url.append(parameters[i]);
if (i != (parameters.length - 1)) {
url.append("&");
}
}
}
return new URL(url.toString());
}
/**
* Builds a URL with parameters.
*
* @param domain the domain of the server
* @param path the path to add to the protocol/host
* @param parameters parameters to be added to the URL as key value pairs.
*
* @throws MalformedURLException
* @throws DocumentListException
*/
private URL buildUrl(String domain, String path, Map<String, String> parameters)
throws MalformedURLException, DocumentListException {
if (path == null) {
throw new DocumentListException("null path");
}
StringBuffer url = new StringBuffer();
url.append(protocol + "://" + domain + URL_FEED + path);
if (parameters != null && parameters.size() > 0) {
Set<Map.Entry<String, String>> params = parameters.entrySet();
Iterator<Map.Entry<String, String>> itr = params.iterator();
url.append("?");
while (itr.hasNext()) {
Map.Entry<String, String> entry = itr.next();
url.append(entry.getKey() + "=" + entry.getValue());
if (itr.hasNext()) {
url.append("&");
}
}
}
return new URL(url.toString());
}
}