-
Notifications
You must be signed in to change notification settings - Fork 2k
/
BlobRequest.java
1041 lines (914 loc) · 43.3 KB
/
BlobRequest.java
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
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/**
* Copyright Microsoft Corporation
*
* 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 com.microsoft.windowsazure.services.blob.client;
import java.io.IOException;
import java.io.StringWriter;
import java.io.UnsupportedEncodingException;
import java.net.HttpURLConnection;
import java.net.URI;
import java.net.URISyntaxException;
import java.util.HashMap;
import javax.xml.stream.XMLOutputFactory;
import javax.xml.stream.XMLStreamException;
import javax.xml.stream.XMLStreamWriter;
import com.microsoft.windowsazure.services.core.storage.AccessCondition;
import com.microsoft.windowsazure.services.core.storage.Constants;
import com.microsoft.windowsazure.services.core.storage.OperationContext;
import com.microsoft.windowsazure.services.core.storage.StorageException;
import com.microsoft.windowsazure.services.core.storage.utils.UriQueryBuilder;
import com.microsoft.windowsazure.services.core.storage.utils.Utility;
import com.microsoft.windowsazure.services.core.storage.utils.implementation.BaseRequest;
import com.microsoft.windowsazure.services.core.storage.utils.implementation.LeaseAction;
/**
* RESERVED FOR INTERNAL USE. Provides a set of methods for constructing requests for blob operations.
*/
final class BlobRequest {
/**
* Adds the metadata.
*
* @param request
* The request.
* @param metadata
* The metadata.
*/
public static void addMetadata(final HttpURLConnection request, final HashMap<String, String> metadata,
final OperationContext opContext) {
BaseRequest.addMetadata(request, metadata, opContext);
}
/**
* Adds the metadata.
*
* @param request
* The request.
* @param name
* The metadata name.
* @param value
* The metadata value.
*/
public static void addMetadata(final HttpURLConnection request, final String name, final String value,
final OperationContext opContext) {
BaseRequest.addMetadata(request, name, value, opContext);
}
/**
* Creates a request to copy a blob, Sign with 0 length.
*
* @param uri
* The absolute URI to the container.
* @param timeout
* The server timeout interval.
* @param source
* The canonical path to the source blob, in the form /<account-name>/<container-name>/<blob-name>.
* @param sourceSnapshotID
* The snapshot version, if the source blob is a snapshot.
* @param sourceAccessConditionType
* A type of condition to check on the source blob.
* @param sourceAccessConditionValue
* The value of the condition to check on the source blob
* @param blobOptions
* the options to use for the request.
* @param opContext
* a tracking object for the request
* @return a HttpURLConnection configured for the operation.
* @throws StorageException
* an exception representing any error which occurred during the operation.
* @throws IllegalArgumentException
* @throws IOException
* @throws URISyntaxException
*/
public static HttpURLConnection copyFrom(final URI uri, final int timeout, String source,
final String sourceSnapshotID, final AccessCondition sourceAccessCondition,
final AccessCondition destinationAccessCondition, final BlobRequestOptions blobOptions,
final OperationContext opContext) throws StorageException, IOException, URISyntaxException {
if (sourceSnapshotID != null) {
source = source.concat("?snapshot=");
source = source.concat(sourceSnapshotID);
}
final HttpURLConnection request = BaseRequest.createURLConnection(uri, timeout, null, opContext);
request.setFixedLengthStreamingMode(0);
request.setDoOutput(true);
request.setRequestMethod("PUT");
request.setRequestProperty(Constants.HeaderConstants.COPY_SOURCE_HEADER, source);
if (sourceAccessCondition != null) {
sourceAccessCondition.applyConditionToRequest(request, true);
}
if (destinationAccessCondition != null) {
destinationAccessCondition.applyConditionToRequest(request);
}
return request;
}
/**
* Generates a web request to abort a copy operation.
*
* @param uri
* The absolute URI to the container.
* @param timeout
* The server timeout interval.
* @param copyId
* A <code>String</code> object that identifying the copy operation.
* @param accessCondition
* The access condition to apply to the request. Only lease conditions are supported for this operation.
* @param blobOptions
* the options to use for the request.
* @param opContext
* a tracking object for the request
* @return a HttpURLConnection configured for the operation.
* @throws StorageException
* an exception representing any error which occurred during the operation.
* @throws IllegalArgumentException
* @throws IOException
* @throws URISyntaxException
*/
public static HttpURLConnection abortCopy(final URI uri, final int timeout, final String copyId,
final AccessCondition accessCondition, final BlobRequestOptions blobOptions,
final OperationContext opContext) throws StorageException, IOException, URISyntaxException {
final UriQueryBuilder builder = new UriQueryBuilder();
builder.add("comp", "copy");
builder.add("copyid", copyId);
final HttpURLConnection request = BaseRequest.createURLConnection(uri, timeout, builder, opContext);
request.setFixedLengthStreamingMode(0);
request.setDoOutput(true);
request.setRequestMethod("PUT");
request.setRequestProperty("x-ms-copy-action", "abort");
if (accessCondition != null) {
accessCondition.applyConditionToRequest(request, true);
}
return request;
}
/**
* Creates the web request.
*
* @param uri
* The absolute URI to the container.
* @param timeout
* The server timeout interval.
* @param query
* The query builder to use.
* @param blobOptions
* the options to use for the request.
* @param opContext
* a tracking object for the request
* @return a HttpURLConnection configured for the operation.
* @throws StorageException
* an exception representing any error which occurred during the operation.
* @throws IllegalArgumentException
*/
private static HttpURLConnection createURLConnection(final URI uri, final int timeout, final UriQueryBuilder query,
final BlobRequestOptions blobOptions, final OperationContext opContext) throws IOException,
URISyntaxException, StorageException {
return BaseRequest.createURLConnection(uri, timeout, query, opContext);
}
/**
* Constructs a HttpURLConnection to delete the blob, Sign with no length specified.
*
* @param uri
* The absolute URI to the blob
* @param timeout
* The server timeout interval
* @param snapshotVersion
* The snapshot version, if the blob is a snapshot.
* @param deleteSnapshotsOption
* A set of options indicating whether to delete only blobs, only snapshots, or both.
* @param accessCondition
* An {@link AccessCondition} object that represents the access conditions for the blob.
* @param blobOptions
* the options to use for the request.
* @param opContext
* a tracking object for the request
* @return a HttpURLConnection to use to perform the operation.
* @throws IOException
* if there is an error opening the connection
* @throws URISyntaxException
* if the resource URI is invalid
* @throws StorageException
* an exception representing any error which occurred during the operation.
* @throws IllegalArgumentException
*/
public static HttpURLConnection delete(final URI uri, final int timeout, final String snapshotVersion,
final DeleteSnapshotsOption deleteSnapshotsOption, final AccessCondition accessCondition,
final BlobRequestOptions blobOptions, final OperationContext opContext) throws IOException,
URISyntaxException, StorageException {
if (snapshotVersion != null && deleteSnapshotsOption != DeleteSnapshotsOption.NONE) {
throw new IllegalArgumentException(String.format(
"The option '%s' must be 'None' to delete a specific snapshot specified by '%s'",
"deleteSnapshotsOption", "snapshot"));
}
final UriQueryBuilder builder = new UriQueryBuilder();
BaseRequest.addSnapshot(builder, snapshotVersion);
final HttpURLConnection request = BaseRequest.delete(uri, timeout, builder, opContext);
if (accessCondition != null) {
accessCondition.applyConditionToRequest(request);
}
switch (deleteSnapshotsOption) {
case NONE:
// nop
break;
case INCLUDE_SNAPSHOTS:
request.setRequestProperty(Constants.HeaderConstants.DELETE_SNAPSHOT_HEADER,
BlobConstants.INCLUDE_SNAPSHOTS_VALUE);
break;
case DELETE_SNAPSHOTS_ONLY:
request.setRequestProperty(Constants.HeaderConstants.DELETE_SNAPSHOT_HEADER,
BlobConstants.SNAPSHOTS_ONLY_VALUE);
break;
default:
break;
}
return request;
}
/**
* Constructs a HttpURLConnection to download the blob, Sign with no length specified.
*
* @param uri
* The absolute URI to the blob
* @param timeout
* The server timeout interval
* @param snapshotVersion
* The snapshot version, if the blob is a snapshot.
* @param offset
* The offset at which to begin returning content.
* @param count
* The number of bytes to return.
* @param accessCondition
* An {@link AccessCondition} object that represents the access conditions for the blob.
* @param blobOptions
* the options to use for the request.
* @param opContext
* a tracking object for the request
* @return a HttpURLConnection to use to perform the operation.
* @throws IOException
* if there is an error opening the connection
* @throws URISyntaxException
* if the resource URI is invalid
* @throws StorageException
* an exception representing any error which occurred during the operation.
* @throws IllegalArgumentException
*/
public static HttpURLConnection get(final URI uri, final int timeout, final String snapshotVersion,
final long offset, final long count, final AccessCondition accessCondition,
final BlobRequestOptions blobOptions, final OperationContext opContext) throws IOException,
URISyntaxException, StorageException {
final HttpURLConnection request = get(uri, timeout, snapshotVersion, accessCondition, blobOptions, opContext);
final String rangeHeaderValue = String.format(Utility.LOCALE_US, Constants.HeaderConstants.RANGE_HEADER_FORMAT,
offset, offset + count - 1);
request.setRequestProperty(Constants.HeaderConstants.STORAGE_RANGE_HEADER, rangeHeaderValue);
return request;
}
/**
* Constructs a HttpURLConnection to download the blob, Sign with no length specified.
*
* @param uri
* The absolute URI to the blob
* @param timeout
* The server timeout interval
* @param snapshotVersion
* The snapshot version, if the blob is a snapshot.
* @param accessCondition
* An {@link AccessCondition} object that represents the access conditions for the blob.
* @param blobOptions
* the options to use for the request.
* @param opContext
* a tracking object for the request
* @return a HttpURLConnection to use to perform the operation.
* @throws IOException
* if there is an error opening the connection
* @throws URISyntaxException
* if the resource URI is invalid
* @throws StorageException
* an exception representing any error which occurred during the operation.
* @throws IllegalArgumentException
*/
public static HttpURLConnection get(final URI uri, final int timeout, final String snapshotVersion,
final AccessCondition accessCondition, final BlobRequestOptions blobOptions,
final OperationContext opContext) throws IOException, URISyntaxException, StorageException {
final UriQueryBuilder builder = new UriQueryBuilder();
BaseRequest.addSnapshot(builder, snapshotVersion);
final HttpURLConnection request = BaseRequest.createURLConnection(uri, timeout, builder, opContext);
request.setRequestMethod("GET");
if (accessCondition != null) {
accessCondition.applyConditionToRequest(request);
}
return request;
}
/**
* Constructs a HttpURLConnection to return a list of the block blobs blocks. Sign with no length specified.
*
* @param uri
* The absolute URI to the blob
* @param timeout
* The server timeout interval
* @param snapshotVersion
* The snapshot version, if the blob is a snapshot.
* @param blockFilter
* The types of blocks to include in the list: committed, uncommitted, or both.
* @param accessCondition
* An {@link AccessCondition} object that represents the access conditions for the blob.
* @param blobOptions
* the options to use for the request.
* @param opContext
* a tracking object for the request
* @return a HttpURLConnection to use to perform the operation.
* @throws IOException
* if there is an error opening the connection
* @throws URISyntaxException
* if the resource URI is invalid
* @throws StorageException
* an exception representing any error which occurred during the operation.
* @throws IllegalArgumentException
*/
public static HttpURLConnection getBlockList(final URI uri, final int timeout, final String snapshotVersion,
final BlockListingFilter blockFilter, final AccessCondition accessCondition,
final BlobRequestOptions blobOptions, final OperationContext opContext) throws StorageException,
IOException, URISyntaxException {
final UriQueryBuilder builder = new UriQueryBuilder();
builder.add("comp", "blocklist");
builder.add("blocklisttype", blockFilter.toString());
BaseRequest.addSnapshot(builder, snapshotVersion);
final HttpURLConnection request = BaseRequest.createURLConnection(uri, timeout, builder, opContext);
request.setRequestMethod("GET");
if (accessCondition != null) {
accessCondition.applyConditionToRequest(request);
}
return request;
}
/**
* Constructs a HttpURLConnection to return a list of the PageBlob's page ranges. Sign with no length specified.
*
* @param uri
* The absolute URI to the blob
* @param timeout
* The server timeout interval
* @param snapshotVersion
* The snapshot version, if the blob is a snapshot.
* @param accessCondition
* An {@link AccessCondition} object that represents the access conditions for the blob.
* @param blobOptions
* the options to use for the request.
* @param opContext
* a tracking object for the request
* @return a HttpURLConnection to use to perform the operation.
* @throws IOException
* if there is an error opening the connection
* @throws URISyntaxException
* if the resource URI is invalid
* @throws StorageException
* an exception representing any error which occurred during the operation.
* @throws IllegalArgumentException
*/
public static HttpURLConnection getPageRanges(final URI uri, final int timeout, final String snapshotVersion,
final AccessCondition accessCondition, final BlobRequestOptions blobOptions,
final OperationContext opContext) throws StorageException, IOException, URISyntaxException {
final UriQueryBuilder builder = new UriQueryBuilder();
builder.add("comp", "pagelist");
BaseRequest.addSnapshot(builder, snapshotVersion);
final HttpURLConnection request = BlobRequest
.createURLConnection(uri, timeout, builder, blobOptions, opContext);
request.setRequestMethod("GET");
if (accessCondition != null) {
accessCondition.applyConditionToRequest(request);
}
BaseRequest.addOptionalHeader(request, BlobConstants.SNAPSHOT, snapshotVersion);
return request;
}
/**
* Constructs a HttpURLConnection to return the blob's system properties, Sign with no length specified.
*
* @param uri
* The absolute URI to the blob
* @param timeout
* The server timeout interval
* @param snapshotVersion
* The snapshot version, if the blob is a snapshot.
* @param accessCondition
* An {@link AccessCondition} object that represents the access conditions for the blob.
* @param blobOptions
* the options to use for the request.
* @param opContext
* a tracking object for the request
* @return a HttpURLConnection to use to perform the operation.
* @throws IOException
* if there is an error opening the connection
* @throws URISyntaxException
* if the resource URI is invalid
* @throws StorageException
* an exception representing any error which occurred during the operation.
* @throws IllegalArgumentException
*/
public static HttpURLConnection getProperties(final URI uri, final int timeout, final String snapshotVersion,
final AccessCondition accessCondition, final BlobRequestOptions blobOptions,
final OperationContext opContext) throws StorageException, IOException, URISyntaxException {
final UriQueryBuilder builder = new UriQueryBuilder();
BaseRequest.addSnapshot(builder, snapshotVersion);
final HttpURLConnection request = BaseRequest.getProperties(uri, timeout, builder, opContext);
if (accessCondition != null) {
accessCondition.applyConditionToRequest(request);
}
return request;
}
/**
* Constructs a HttpURLConnection to Acquire,Release,Break, or Renew a blob lease. Sign with 0 length.
*
* @param uri
* The absolute URI to the blob
* @param timeout
* The server timeout interval
* @param action
* the LeaseAction to perform
*
* @param visibilityTimeoutInSeconds
* Specifies the the span of time for which to acquire the lease, in seconds.
* If null, an infinite lease will be acquired. If not null, this must be greater than zero.
*
* @param proposedLeaseId
* A <code>String</code> that represents the proposed lease ID for the new lease,
* or null if no lease ID is proposed.
*
* @param breakPeriodInSeconds
* Specifies the amount of time to allow the lease to remain, in seconds.
* If null, the break period is the remainder of the current lease, or zero for infinite leases.
*
* @param accessCondition
* An {@link AccessCondition} object that represents the access conditions for the blob.
* @param blobOptions
* the options to use for the request.
* @param opContext
* a tracking object for the request
* @return a HttpURLConnection to use to perform the operation.
* @throws IOException
* if there is an error opening the connection
* @throws URISyntaxException
* if the resource URI is invalid
* @throws StorageException
* an exception representing any error which occurred during the operation.
* @throws IllegalArgumentException
*/
public static HttpURLConnection lease(final URI uri, final int timeout, final LeaseAction action,
final Integer leaseTimeInSeconds, final String proposedLeaseId, final Integer breakPeriodInSeconds,
final AccessCondition accessCondition, final BlobRequestOptions blobOptions,
final OperationContext opContext) throws IOException, URISyntaxException, StorageException {
final UriQueryBuilder builder = new UriQueryBuilder();
builder.add("comp", "lease");
final HttpURLConnection request = BlobRequest
.createURLConnection(uri, timeout, builder, blobOptions, opContext);
request.setDoOutput(true);
request.setRequestMethod("PUT");
request.setFixedLengthStreamingMode(0);
request.setRequestProperty("x-ms-lease-action", action.toString());
if (leaseTimeInSeconds != null) {
request.setRequestProperty("x-ms-lease-duration", leaseTimeInSeconds.toString());
}
else {
request.setRequestProperty("x-ms-lease-duration", "-1");
}
if (proposedLeaseId != null) {
request.setRequestProperty("x-ms-proposed-lease-id", proposedLeaseId);
}
if (accessCondition != null) {
accessCondition.applyConditionToRequest(request);
}
return request;
}
/**
* Constructs a HttpURLConnection to list blobs. Sign with no length specified.
*
* @param uri
* The absolute URI to the blob
* @param timeout
* The server timeout interval
* @param listingContext
* A set of parameters for the listing operation.
* @param blobOptions
* the options to use for the request.
* @param opContext
* a tracking object for the request
* @return a HttpURLConnection configured for the operation.
* @throws IOException
* if there is an error opening the connection
* @throws URISyntaxException
* if the resource URI is invalid
* @throws StorageException
* an exception representing any error which occurred during the operation.
* @throws IllegalArgumentException
* */
public static HttpURLConnection list(final URI uri, final int timeout, final BlobListingContext listingContext,
final BlobRequestOptions blobOptions, final OperationContext opContext) throws URISyntaxException,
IOException, StorageException {
final UriQueryBuilder builder = ContainerRequest.getContainerUriQueryBuilder();
builder.add("comp", "list");
if (listingContext != null) {
if (!Utility.isNullOrEmpty(listingContext.getPrefix())) {
builder.add("prefix", listingContext.getPrefix());
}
if (!Utility.isNullOrEmpty(listingContext.getDelimiter())) {
builder.add("delimiter", listingContext.getDelimiter());
}
if (!Utility.isNullOrEmpty(listingContext.getMarker())) {
builder.add("marker", listingContext.getMarker());
}
if (listingContext.getMaxResults() != null && listingContext.getMaxResults() > 0) {
builder.add("maxresults", listingContext.getMaxResults().toString());
}
if (listingContext.getListingDetails().size() > 0) {
final StringBuilder sb = new StringBuilder();
boolean started = false;
if (listingContext.getListingDetails().contains(BlobListingDetails.SNAPSHOTS)) {
if (!started) {
started = true;
}
else {
sb.append(",");
}
sb.append("snapshots");
}
if (listingContext.getListingDetails().contains(BlobListingDetails.UNCOMMITTED_BLOBS)) {
if (!started) {
started = true;
}
else {
sb.append(",");
}
sb.append("uncommittedblobs");
}
if (listingContext.getListingDetails().contains(BlobListingDetails.METADATA)) {
if (!started) {
started = true;
}
else {
sb.append(",");
}
sb.append("metadata");
}
builder.add("include", sb.toString());
}
}
final HttpURLConnection request = BlobRequest
.createURLConnection(uri, timeout, builder, blobOptions, opContext);
request.setRequestMethod("GET");
return request;
}
/**
* Constructs a HttpURLConnection to upload a blob. Sign with blob length, or -1 for pageblob create.
*
* @param uri
* The absolute URI to the blob
* @param timeout
* The server timeout interval
* @param properties
* The properties to set for the blob.
* @param blobType
* The type of the blob.
* @param pageBlobSize
* For a page blob, the size of the blob. This parameter is ignored for block blobs.
* @param accessCondition
* An {@link AccessCondition} object that represents the access conditions for the blob.
* @param blobOptions
* the options to use for the request.
* @param opContext
* a tracking object for the request
* @return a HttpURLConnection to use to perform the operation.
* @throws IOException
* if there is an error opening the connection
* @throws URISyntaxException
* if the resource URI is invalid
* @throws StorageException
* an exception representing any error which occurred during the operation.
* @throws IllegalArgumentException
*/
public static HttpURLConnection put(final URI uri, final int timeout, final BlobProperties properties,
final BlobType blobType, final long pageBlobSize, final AccessCondition accessCondition,
final BlobRequestOptions blobOptions, final OperationContext opContext) throws IOException,
URISyntaxException, StorageException {
if (blobType == BlobType.UNSPECIFIED) {
throw new IllegalArgumentException("The blob type cannot be undefined.");
}
final HttpURLConnection request = BlobRequest.createURLConnection(uri, timeout, null, blobOptions, opContext);
request.setDoOutput(true);
request.setRequestMethod("PUT");
// use set optional header
BaseRequest.addOptionalHeader(request, Constants.HeaderConstants.CACHE_CONTROL, properties.getCacheControl());
BaseRequest.addOptionalHeader(request, Constants.HeaderConstants.CONTENT_TYPE, properties.getContentType());
BaseRequest.addOptionalHeader(request, Constants.HeaderConstants.CONTENT_MD5, properties.getContentMD5());
BaseRequest.addOptionalHeader(request, Constants.HeaderConstants.CONTENT_LANGUAGE,
properties.getContentLanguage());
BaseRequest.addOptionalHeader(request, Constants.HeaderConstants.CONTENT_ENCODING,
properties.getContentEncoding());
if (blobType == BlobType.PAGE_BLOB) {
request.setFixedLengthStreamingMode(0);
request.setRequestProperty(Constants.HeaderConstants.CONTENT_LENGTH, "0");
request.setRequestProperty(BlobConstants.BLOB_TYPE_HEADER, BlobConstants.PAGE_BLOB);
request.setRequestProperty(BlobConstants.SIZE, String.valueOf(pageBlobSize));
properties.setLength(pageBlobSize);
}
else {
request.setRequestProperty(BlobConstants.BLOB_TYPE_HEADER, BlobConstants.BLOCK_BLOB);
}
if (accessCondition != null) {
accessCondition.applyConditionToRequest(request);
}
return request;
}
/**
* Constructs a HttpURLConnection to upload a block. Sign with length of block data.
*
* @param uri
* The absolute URI to the blob
* @param timeout
* The server timeout interval
* @param blockId
* the Base64 ID for the block
* @param accessCondition
* An {@link AccessCondition} object that represents the access conditions for the blob.
* @param blobOptions
* the options to use for the request.
* @param opContext
* a tracking object for the request
* @return a HttpURLConnection to use to perform the operation.
* @throws IOException
* if there is an error opening the connection
* @throws URISyntaxException
* if the resource URI is invalid
* @throws StorageException
* an exception representing any error which occurred during the operation.
* @throws IllegalArgumentException
*/
public static HttpURLConnection putBlock(final URI uri, final int timeout, final String blockId,
final AccessCondition accessCondition, final BlobRequestOptions blobOptions,
final OperationContext opContext) throws IOException, URISyntaxException, StorageException {
final UriQueryBuilder builder = new UriQueryBuilder();
builder.add("comp", "block");
builder.add("blockid", blockId);
final HttpURLConnection request = BlobRequest
.createURLConnection(uri, timeout, builder, blobOptions, opContext);
request.setDoOutput(true);
request.setRequestMethod("PUT");
if (accessCondition != null) {
accessCondition.applyConditionToRequest(request);
}
return request;
}
/**
* Constructs a HttpURLConnection to set the blob's properties, Sign with zero length specified.
*
* @param uri
* The absolute URI to the blob
* @param timeout
* The server timeout interval
* @param accessCondition
* An {@link AccessCondition} object that represents the access conditions for the blob.
* @param blobOptions
* the options to use for the request.
* @param opContext
* a tracking object for the request
* @return a HttpURLConnection to use to perform the operation.
* @throws IOException
* if there is an error opening the connection
* @throws URISyntaxException
* if the resource URI is invalid
* @throws StorageException
* an exception representing any error which occurred during the operation.
* @throws IllegalArgumentException
*/
public static HttpURLConnection putBlockList(final URI uri, final int timeout, final BlobProperties properties,
final AccessCondition accessCondition, final BlobRequestOptions blobOptions,
final OperationContext opContext) throws IOException, URISyntaxException, StorageException {
final UriQueryBuilder builder = new UriQueryBuilder();
builder.add("comp", "blocklist");
final HttpURLConnection request = BlobRequest
.createURLConnection(uri, timeout, builder, blobOptions, opContext);
request.setDoOutput(true);
request.setRequestMethod("PUT");
if (accessCondition != null) {
accessCondition.applyConditionToRequest(request);
}
BaseRequest.addOptionalHeader(request, Constants.HeaderConstants.CACHE_CONTROL_HEADER,
properties.getCacheControl());
BaseRequest.addOptionalHeader(request, BlobConstants.CONTENT_ENCODING_HEADER, properties.getContentEncoding());
BaseRequest.addOptionalHeader(request, BlobConstants.CONTENT_LANGUAGE_HEADER, properties.getContentLanguage());
BaseRequest.addOptionalHeader(request, BlobConstants.BLOB_CONTENT_MD5_HEADER, properties.getContentMD5());
BaseRequest.addOptionalHeader(request, BlobConstants.CONTENT_TYPE_HEADER, properties.getContentType());
return request;
}
/**
* Constructs a HttpURLConnection to upload a block. Sign with page length for update, or 0 for clear.
*
* @param uri
* The absolute URI to the blob
* @param timeout
* The server timeout interval
* @param properties
* the page properties
* @param accessCondition
* An {@link AccessCondition} object that represents the access conditions for the blob.
* @param blobOptions
* the options to use for the request.
* @param opContext
* a tracking object for the request
* @return a HttpURLConnection to use to perform the operation.
* @throws IOException
* if there is an error opening the connection
* @throws URISyntaxException
* if the resource URI is invalid
* @throws StorageException
* an exception representing any error which occurred during the operation.
* @throws IllegalArgumentException
*/
public static HttpURLConnection putPage(final URI uri, final int timeout, final PageProperties properties,
final AccessCondition accessCondition, final BlobRequestOptions blobOptions,
final OperationContext opContext) throws IOException, URISyntaxException, StorageException {
final UriQueryBuilder builder = new UriQueryBuilder();
builder.add("comp", "page");
final HttpURLConnection request = BlobRequest
.createURLConnection(uri, timeout, builder, blobOptions, opContext);
request.setDoOutput(true);
request.setRequestMethod("PUT");
if (properties.getPageOperation() == PageOperationType.CLEAR) {
request.setFixedLengthStreamingMode(0);
}
// Page write is either update or clean; required
request.setRequestProperty(BlobConstants.PAGE_WRITE, properties.getPageOperation().toString());
request.setRequestProperty(Constants.HeaderConstants.STORAGE_RANGE_HEADER, properties.getRange().toString());
if (accessCondition != null) {
accessCondition.applyConditionToRequest(request);
}
return request;
}
/**
* Constructs a HttpURLConnection to set the blob's metadata, Sign with 0 length.
*
* @param uri
* The absolute URI to the blob
* @param timeout
* The server timeout interval
* @param accessCondition
* An {@link AccessCondition} object that represents the access conditions for the blob.
* @param blobOptions
* the options to use for the request.
* @param opContext
* a tracking object for the request
* @return a HttpURLConnection to use to perform the operation.
* @throws IOException
* if there is an error opening the connection
* @throws URISyntaxException
* if the resource URI is invalid
* @throws StorageException
* an exception representing any error which occurred during the operation.
* @throws IllegalArgumentException
*/
public static HttpURLConnection setMetadata(final URI uri, final int timeout,
final AccessCondition accessCondition, final BlobRequestOptions blobOptions,
final OperationContext opContext) throws IOException, URISyntaxException, StorageException {
final HttpURLConnection request = BaseRequest.setMetadata(uri, timeout, null, opContext);
if (accessCondition != null) {
accessCondition.applyConditionToRequest(request);
}
return request;
}
/**
* Constructs a HttpURLConnection to set the blob's properties, Sign with zero length specified.
*
* @param uri
* The absolute URI to the blob
* @param timeout
* The server timeout interval
* @param newBlobSize
* The new blob size, if the blob is a page blob. Set this parameter to null to keep the existing blob
* size.
* @param accessCondition
* An {@link AccessCondition} object that represents the access conditions for the blob.
* @param blobOptions
* the options to use for the request.
* @param opContext
* a tracking object for the request
* @return a HttpURLConnection to use to perform the operation.
* @throws IOException
* if there is an error opening the connection
* @throws URISyntaxException
* if the resource URI is invalid
* @throws StorageException
* an exception representing any error which occurred during the operation.
* @throws IllegalArgumentException
*/
public static HttpURLConnection setProperties(final URI uri, final int timeout, final BlobProperties properties,
final Long newBlobSize, final AccessCondition accessCondition, final BlobRequestOptions blobOptions,
final OperationContext opContext) throws IOException, URISyntaxException, StorageException {
final UriQueryBuilder builder = new UriQueryBuilder();
builder.add("comp", "properties");
final HttpURLConnection request = BlobRequest
.createURLConnection(uri, timeout, builder, blobOptions, opContext);
request.setFixedLengthStreamingMode(0);
request.setDoOutput(true);
request.setRequestMethod("PUT");
if (accessCondition != null) {
accessCondition.applyConditionToRequest(request);
}
if (newBlobSize != null) {
request.setRequestProperty(BlobConstants.SIZE, newBlobSize.toString());
properties.setLength(newBlobSize);
}
BaseRequest.addOptionalHeader(request, Constants.HeaderConstants.CACHE_CONTROL_HEADER,
properties.getCacheControl());
BaseRequest.addOptionalHeader(request, BlobConstants.CONTENT_ENCODING_HEADER, properties.getContentEncoding());
BaseRequest.addOptionalHeader(request, BlobConstants.CONTENT_LANGUAGE_HEADER, properties.getContentLanguage());
BaseRequest.addOptionalHeader(request, BlobConstants.BLOB_CONTENT_MD5_HEADER, properties.getContentMD5());
BaseRequest.addOptionalHeader(request, BlobConstants.CONTENT_TYPE_HEADER, properties.getContentType());
return request;
}
/**
* Constructs a HttpURLConnection to create a snapshot of the blob. Sign with 0 length.
*
* @param uri
* The absolute URI to the blob
* @param timeout
* The server timeout interval
* @param accessCondition
* An {@link AccessCondition} object that represents the access conditions for the blob.
* @param blobOptions
* the options to use for the request.
* @param opContext
* a tracking object for the request
* @return a HttpURLConnection to use to perform the operation.
* @throws IOException
* if there is an error opening the connection
* @throws URISyntaxException
* if the resource URI is invalid
* @throws StorageException
* an exception representing any error which occurred during the operation.
* @throws IllegalArgumentException
*/
public static HttpURLConnection snapshot(final URI uri, final int timeout, final AccessCondition accessCondition,
final BlobRequestOptions blobOptions, final OperationContext opContext) throws IOException,
URISyntaxException, StorageException {
final UriQueryBuilder builder = new UriQueryBuilder();
builder.add(Constants.HeaderConstants.COMP, BlobConstants.SNAPSHOT);
final HttpURLConnection request = BlobRequest
.createURLConnection(uri, timeout, builder, blobOptions, opContext);
request.setFixedLengthStreamingMode(0);
request.setDoOutput(true);
request.setRequestMethod("PUT");
if (accessCondition != null) {
accessCondition.applyConditionToRequest(request);
}
return request;
}
/**
* Writes a Block List and returns the corresponding UTF8 bytes.
*
* @param blockList
* the Iterable of BlockEntry to write
* @param opContext
* a tracking object for the request
* @return a byte array of the UTF8 bytes representing the serialized block list.
* @throws XMLStreamException
* if there is an error writing the block list.
* @throws StorageException
*/
public static byte[] writeBlockListToStream(final Iterable<BlockEntry> blockList, final OperationContext opContext)
throws XMLStreamException, StorageException {
final StringWriter outWriter = new StringWriter();
final XMLOutputFactory xmlOutFactoryInst = XMLOutputFactory.newInstance();