/
CloudPageBlobBase.cs
427 lines (376 loc) · 16.2 KB
/
CloudPageBlobBase.cs
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
//-----------------------------------------------------------------------
// <copyright file="CloudPageBlobBase.cs" company="Microsoft">
// Copyright 2012 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.
// </copyright>
//-----------------------------------------------------------------------
namespace Microsoft.WindowsAzure.Storage.Blob
{
using System;
using System.Collections.Generic;
using System.Globalization;
using Microsoft.WindowsAzure.Storage.Auth;
using Microsoft.WindowsAzure.Storage.Blob.Protocol;
using Microsoft.WindowsAzure.Storage.Core;
using Microsoft.WindowsAzure.Storage.Core.Auth;
using Microsoft.WindowsAzure.Storage.Core.Util;
using Microsoft.WindowsAzure.Storage.Shared.Protocol;
/// <summary>
/// Represents a Windows Azure page blob.
/// </summary>
public sealed partial class CloudPageBlob : ICloudBlob
{
/// <summary>
/// Default is 4 MB.
/// </summary>
private int streamWriteSizeInBytes = Constants.DefaultWriteBlockSizeBytes;
/// <summary>
/// Default is 4 MB.
/// </summary>
private int streamMinimumReadSizeInBytes = Constants.DefaultWriteBlockSizeBytes;
/// <summary>
/// Initializes a new instance of the <see cref="CloudPageBlob"/> class using an absolute URI to the blob.
/// </summary>
/// <param name="blobAbsoluteUri">The absolute URI to the blob.</param>
public CloudPageBlob(Uri blobAbsoluteUri)
: this(blobAbsoluteUri, null /* credentials */)
{
}
/// <summary>
/// Initializes a new instance of the <see cref="CloudPageBlob"/> class using an absolute URI to the blob.
/// </summary>
/// <param name="blobAbsoluteUri">The absolute URI to the blob.</param>
/// <param name="credentials">The account credentials.</param>
public CloudPageBlob(Uri blobAbsoluteUri, StorageCredentials credentials)
: this(blobAbsoluteUri, null /* snapshotTime */, credentials)
{
}
/// <summary>
/// Initializes a new instance of the <see cref="CloudPageBlob"/> class using an absolute URI to the blob.
/// </summary>
/// <param name="blobAbsoluteUri">The absolute URI to the blob.</param>
/// <param name="snapshotTime">The snapshot timestamp, if the blob is a snapshot.</param>
/// <param name="credentials">The account credentials.</param>
public CloudPageBlob(Uri blobAbsoluteUri, DateTimeOffset? snapshotTime, StorageCredentials credentials)
{
this.attributes = new BlobAttributes();
this.SnapshotTime = snapshotTime;
this.ParseQueryAndVerify(blobAbsoluteUri, credentials);
this.Properties.BlobType = BlobType.PageBlob;
}
/// <summary>
/// Initializes a new instance of the <see cref="CloudPageBlob"/> class using the specified blob name and
/// the parent container reference.
/// If snapshotTime is not null, the blob instance represents a Snapshot.
/// </summary>
/// <param name="blobName">Name of the blob.</param>
/// <param name="snapshotTime">Snapshot time in case the blob is a snapshot.</param>
/// <param name="container">The reference to the parent container.</param>
internal CloudPageBlob(string blobName, DateTimeOffset? snapshotTime, CloudBlobContainer container)
{
CommonUtils.AssertNotNullOrEmpty("blobName", blobName);
CommonUtils.AssertNotNull("container", container);
this.attributes = new BlobAttributes();
this.Uri = NavigationHelper.AppendPathToUri(container.Uri, blobName);
this.ServiceClient = container.ServiceClient;
this.container = container;
this.SnapshotTime = snapshotTime;
this.Properties.BlobType = BlobType.PageBlob;
}
/// <summary>
/// Initializes a new instance of the <see cref="CloudPageBlob"/> class.
/// </summary>
/// <param name="attributes">The attributes.</param>
/// <param name="serviceClient">The service client.</param>
internal CloudPageBlob(BlobAttributes attributes, CloudBlobClient serviceClient)
{
this.attributes = attributes;
this.ServiceClient = serviceClient;
this.ParseQueryAndVerify(this.Uri, this.ServiceClient.Credentials);
this.Properties.BlobType = BlobType.PageBlob;
}
/// <summary>
/// Stores the <see cref="CloudBlobContainer"/> that contains this blob.
/// </summary>
private CloudBlobContainer container;
/// <summary>
/// Stores the name of this blob.
/// </summary>
private string name;
/// <summary>
/// Stores the blob's parent <see cref="CloudBlobDirectory"/>.
/// </summary>
private CloudBlobDirectory parent;
/// <summary>
/// Stores the blob's attributes.
/// </summary>
private readonly BlobAttributes attributes;
/// <summary>
/// Gets the <see cref="CloudBlobClient"/> object that represents the Blob service.
/// </summary>
/// <value>A client object that specifies the Blob service endpoint.</value>
public CloudBlobClient ServiceClient { get; private set; }
/// <summary>
/// Gets or sets the number of bytes to buffer when writing to a page blob stream.
/// </summary>
/// <value>The number of bytes to buffer, ranging from between 512 bytes and 4 MB inclusive.</value>
public int StreamWriteSizeInBytes
{
get
{
return this.streamWriteSizeInBytes;
}
set
{
CommonUtils.AssertInBounds("StreamWriteSizeInBytes", value, Constants.PageSize, Constants.MaxBlockSize);
this.streamWriteSizeInBytes = value;
}
}
/// <summary>
/// Gets or sets the minimum number of bytes to buffer when reading from a blob stream.
/// </summary>
/// <value>The minimum number of bytes to buffer, ranging from between 1 and 4 MB inclusive.</value>
public int StreamMinimumReadSizeInBytes
{
get
{
return this.streamMinimumReadSizeInBytes;
}
set
{
CommonUtils.AssertInBounds("StreamMinimumReadSizeInBytes", value, 1 * Constants.MB, Constants.MaxBlockSize);
this.streamMinimumReadSizeInBytes = value;
}
}
/// <summary>
/// Gets the blob's system properties.
/// </summary>
/// <value>The blob's properties.</value>
public BlobProperties Properties
{
get
{
return this.attributes.Properties;
}
}
/// <summary>
/// Gets the user-defined metadata for the blob.
/// </summary>
/// <value>The blob's metadata, as a collection of name-value pairs.</value>
public IDictionary<string, string> Metadata
{
get
{
return this.attributes.Metadata;
}
}
/// <summary>
/// Gets the blob's URI.
/// </summary>
/// <value>The absolute URI to the blob.</value>
public Uri Uri
{
get
{
return this.attributes.Uri;
}
private set
{
this.attributes.Uri = value;
}
}
/// <summary>
/// Gets the date and time that the blob snapshot was taken, if this blob is a snapshot.
/// </summary>
/// <value>The blob's snapshot time if the blob is a snapshot; otherwise, <c>null</c>.</value>
/// <remarks>
/// If the blob is not a snapshot, the value of this property is <c>null</c>.
/// </remarks>
public DateTimeOffset? SnapshotTime
{
get
{
return this.attributes.SnapshotTime;
}
private set
{
this.attributes.SnapshotTime = value;
}
}
/// <summary>
/// Gets the state of the most recent or pending copy operation.
/// </summary>
/// <value>A <see cref="CopyState"/> object containing the copy state, or null if no copy blob state exists for this blob.</value>
public CopyState CopyState
{
get
{
return this.attributes.CopyState;
}
private set
{
this.attributes.CopyState = value;
}
}
/// <summary>
/// Gets the type of the blob.
/// </summary>
/// <value>The type of the blob.</value>
public BlobType BlobType
{
get
{
return Blob.BlobType.PageBlob;
}
}
/// <summary>
/// Gets the blob's name.
/// </summary>
/// <value>The blob's name.</value>
public string Name
{
get
{
if (string.IsNullOrEmpty(this.name))
{
this.name = Uri.UnescapeDataString(NavigationHelper.GetBlobName(this.Uri, this.ServiceClient.UsePathStyleUris));
}
return this.name;
}
}
/// <summary>
/// Gets a <see cref="CloudBlobContainer"/> object representing the blob's container.
/// </summary>
/// <value>The blob's container.</value>
public CloudBlobContainer Container
{
get
{
if (this.container == null)
{
this.container = this.ServiceClient.GetContainerReference(
NavigationHelper.GetContainerName(this.Uri, this.ServiceClient.UsePathStyleUris));
}
return this.container;
}
}
/// <summary>
/// Gets the <see cref="CloudBlobDirectory"/> object representing the
/// virtual parent directory for the blob.
/// </summary>
/// <value>The blob's virtual parent directory.</value>
public CloudBlobDirectory Parent
{
get
{
if (this.parent == null)
{
Uri parentUri = NavigationHelper.GetParentAddress(
this.Uri,
this.ServiceClient.DefaultDelimiter,
this.ServiceClient.UsePathStyleUris);
if (parentUri != null)
{
this.parent = new CloudBlobDirectory(
parentUri.AbsoluteUri,
this.ServiceClient);
}
}
return this.parent;
}
}
#if !COMMON
/// <summary>
/// Returns a shared access signature for the blob.
/// </summary>
/// <param name="policy">The access policy for the shared access signature.</param>
/// <returns>A shared access signature.</returns>
public string GetSharedAccessSignature(SharedAccessBlobPolicy policy)
{
return this.GetSharedAccessSignature(policy, null /* groupPolicyIdentifier */);
}
/// <summary>
/// Returns a shared access signature for the blob.
/// </summary>
/// <param name="policy">The access policy for the shared access signature.</param>
/// <param name="groupPolicyIdentifier">A container-level access policy.</param>
/// <returns>A shared access signature.</returns>
public string GetSharedAccessSignature(SharedAccessBlobPolicy policy, string groupPolicyIdentifier)
{
if (!this.ServiceClient.Credentials.IsSharedKey)
{
string errorMessage = string.Format(CultureInfo.CurrentCulture, SR.CannotCreateSASWithoutAccountKey);
throw new InvalidOperationException(errorMessage);
}
if (this.SnapshotTime != null)
{
string errorMessage = string.Format(CultureInfo.CurrentCulture, SR.CannotCreateSASForSnapshot);
throw new NotSupportedException(errorMessage);
}
string resourceName = this.GetCanonicalName(true);
string signature = SharedAccessSignatureHelper.GetSharedAccessSignatureHashImpl(policy, groupPolicyIdentifier, resourceName, this.ServiceClient.Credentials);
string accountKeyName = this.ServiceClient.Credentials.KeyName;
// Future resource type changes from "c" => "container"
UriQueryBuilder builder = SharedAccessSignatureHelper.GetSharedAccessSignatureImpl(policy, groupPolicyIdentifier, "b", signature, accountKeyName);
return builder.ToString();
}
#endif
/// <summary>
/// Gets the canonical name of the blob, formatted as /<account-name>/<container-name>/<blob-name>.
/// If <c>ignoreSnapshotTime</c> is <c>false</c> and this blob is a snapshot, the canonical name is augmented with a
/// query of the form ?snapshot=<snapshot-time>.
/// <para>This is used by both Shared Access and Copy blob operations.</para>
/// </summary>
/// <param name="ignoreSnapshotTime">Indicates if the snapshot time is ignored.</param>
/// <returns>The canonical name of the blob.</returns>
private string GetCanonicalName(bool ignoreSnapshotTime)
{
string accountName = this.ServiceClient.Credentials.AccountName;
string containerName = this.Container.Name;
// Replace \ with / for uri compatibility when running under .net 4.5.
string blobName = this.Name.Replace('\\', '/');
string canonicalName = string.Format("/{0}/{1}/{2}", accountName, containerName, blobName);
if (!ignoreSnapshotTime && this.SnapshotTime != null)
{
canonicalName += "?snapshot=" + BlobRequest.ConvertDateTimeToSnapshotString(this.SnapshotTime.Value);
}
return canonicalName;
}
/// <summary>
/// Parse URI for SAS (Shared Access Signature) and snapshot information.
/// </summary>
/// <param name="address">The complete Uri.</param>
/// <param name="credentials">The credentials to use.</param>
private void ParseQueryAndVerify(Uri address, StorageCredentials credentials)
{
StorageCredentials parsedCredentials;
DateTimeOffset? parsedSnapshot;
this.Uri = NavigationHelper.ParseBlobQueryAndVerify(address, out parsedCredentials, out parsedSnapshot);
if ((parsedCredentials != null) && (credentials != null) && !parsedCredentials.Equals(credentials))
{
string error = string.Format(CultureInfo.CurrentCulture, SR.MultipleCredentialsProvided);
throw new ArgumentException(error);
}
if (parsedSnapshot.HasValue && this.SnapshotTime.HasValue && !parsedSnapshot.Value.Equals(this.SnapshotTime.Value))
{
string error = string.Format(CultureInfo.CurrentCulture, SR.MultipleSnapshotTimesProvided, parsedSnapshot, this.SnapshotTime);
throw new ArgumentException(error);
}
if (parsedSnapshot.HasValue)
{
this.SnapshotTime = parsedSnapshot;
}
this.ServiceClient = new CloudBlobClient(NavigationHelper.GetServiceClientBaseAddress(this.Uri, null /* usePathStyleUris */), credentials ?? parsedCredentials);
}
}
}