/// <summary>
/// Generates a <see cref="RESTCommand"/> for breaking a lease.
/// </summary>
/// <param name="breakPeriod">The amount of time to allow the lease to remain, rounded down to seconds.
/// If null, the break period is the remainder of the current lease, or zero for infinite leases.</param>
/// <param name="accessCondition">An object that represents the access conditions for the blob. If null, no condition is used.</param>
/// <param name="options">An object that specifies any additional options for the request.</param>
/// <returns>A <see cref="RESTCommand"/> implementing the break lease operation.</returns>
internal static RESTCommand <TimeSpan> BreakLeaseImpl(ICloudBlob blob, BlobAttributes attributes, TimeSpan?breakPeriod, AccessCondition accessCondition, BlobRequestOptions options)
{
int?breakSeconds = null;
if (breakPeriod.HasValue)
{
CommonUtils.AssertInBounds("breakPeriod", breakPeriod.Value, TimeSpan.FromSeconds(0), TimeSpan.MaxValue);
breakSeconds = (int)breakPeriod.Value.TotalSeconds;
}
RESTCommand <TimeSpan> putCmd = new RESTCommand <TimeSpan>(blob.ServiceClient.Credentials, attributes.Uri);
putCmd.ApplyRequestOptions(options);
putCmd.Handler = blob.ServiceClient.AuthenticationHandler;
putCmd.BuildClient = HttpClientFactory.BuildHttpClient;
putCmd.BuildRequest = (cmd, cnt, ctx) => BlobHttpRequestMessageFactory.Lease(cmd.Uri, cmd.ServerTimeoutInSeconds, LeaseAction.Break, null /* proposedLeaseId */, null /* leaseDuration */, breakSeconds, accessCondition, cnt, ctx);
putCmd.PreProcessResponse = (cmd, resp, ex, ctx) =>
{
HttpResponseParsers.ProcessExpectedStatusCodeNoException(HttpStatusCode.Accepted, resp, TimeSpan.Zero, cmd, ex, ctx);
int?remainingLeaseTime = BlobHttpResponseParsers.GetRemainingLeaseTime(resp);
if (!remainingLeaseTime.HasValue)
{
// Unexpected result from service.
throw new StorageException(cmd.CurrentResult, SR.LeaseTimeNotReceived, null /* inner */);
}
return(TimeSpan.FromSeconds(remainingLeaseTime.Value));
};
return(putCmd);
}
public async static void AcquireAndReleaseLeaseTest(BlobContext context, string containerName, string blobName)
{
CloudStorageAccount account = new CloudStorageAccount(new StorageCredentials(context.Account, context.Key), false);
CloudBlobClient client = new CloudBlobClient(new Uri(context.Address), account.Credentials);
CloudBlobContainer container = client.GetContainerReference(containerName);
CloudBlockBlob blob = container.GetBlockBlobReference(blobName);
BlobTestBase.UploadText(blob, "Text sent to cloud", Encoding.UTF8);
// acquire a release on the blob and check LeaseStatus to be "locked"
OperationContext opContext = new OperationContext();
HttpRequestMessage blobRequest = BlobHttpRequestMessageFactory.Lease(
blob.Uri,
context.Timeout,
LeaseAction.Acquire,
null /* proposed lease ID */,
60 /* lease duration */,
null /* break period */,
null /* access condition */,
null,
opContext,
SharedKeyCanonicalizer.Instance,
context.Credentials);
string leaseId = null;
using (HttpResponseMessage response = await BlobTestUtils.GetResponse(blobRequest, context))
{
leaseId = HttpResponseParsers.GetHeader(response, "x-ms-lease-id");
Assert.AreEqual <HttpStatusCode>(response.StatusCode, HttpStatusCode.Created);
}
blob.FetchAttributes();
Assert.AreEqual <LeaseStatus>(blob.Properties.LeaseStatus, LeaseStatus.Locked);
// release the release on the blob and check LeaseStatus to be "unlocked"
opContext = new OperationContext();
blobRequest = BlobHttpRequestMessageFactory.Lease(
blob.Uri,
context.Timeout,
LeaseAction.Release,
null /* proposed lease ID */,
null /* lease duration */,
null /* break period */,
AccessCondition.GenerateLeaseCondition(leaseId),
null,
opContext,
SharedKeyCanonicalizer.Instance,
context.Credentials);
using (HttpResponseMessage response = await BlobTestUtils.GetResponse(blobRequest, context))
{
Assert.AreEqual <HttpStatusCode>(response.StatusCode, HttpStatusCode.OK);
}
blob.FetchAttributes();
Assert.AreEqual <LeaseStatus>(blob.Properties.LeaseStatus, LeaseStatus.Unlocked);
blob.Delete();
}
/// <summary>
/// Generates and validates a request to break a lease.
/// </summary>
/// <param name="context">The blob context.</param>
/// <param name="containerName">The container name.</param>
/// <param name="blobName">The blob name.</param>
/// <param name="breakPeriod">The break period.</param>
/// <returns>A web request for the operation.</returns>
public static HttpRequestMessage BreakLeaseRequest(BlobContext context, string containerName, string blobName, int?breakPeriod, AccessCondition accessCondition)
{
HttpRequestMessage request;
OperationContext opContext = new OperationContext();
if (blobName != null)
{
// blob lease
Uri uri = BlobTests.ConstructPutUri(context.Address, containerName, blobName);
request = BlobHttpRequestMessageFactory.Lease(
uri,
context.Timeout,
LeaseAction.Break,
null /* proposed lease ID */,
null /* lease duration */,
breakPeriod,
accessCondition,
null,
opContext,
SharedKeyCanonicalizer.Instance,
context.Credentials);
}
else
{
// container lease
Uri uri = BlobClientTests.ConstructUri(context.Address, containerName);
request = ContainerHttpRequestMessageFactory.Lease(
uri,
context.Timeout,
LeaseAction.Break,
null /* proposed lease ID */,
null /* lease duration */,
breakPeriod,
accessCondition,
null,
opContext,
SharedKeyCanonicalizer.Instance,
context.Credentials);
}
Assert.IsNotNull(request);
Assert.AreEqual(HttpMethod.Put, request.Method);
BlobTestUtils.VersionHeader(request, false);
BlobTestUtils.LeaseIdHeader(request, null);
BlobTestUtils.LeaseActionHeader(request, "break");
BlobTestUtils.LeaseDurationHeader(request, null);
BlobTestUtils.ProposedLeaseIdHeader(request, null);
BlobTestUtils.BreakPeriodHeader(request, breakPeriod.HasValue ? breakPeriod.Value.ToString() : null);
return(request);
}
/// <summary>
/// Generates a <see cref="RESTCommand"/> for releasing a lease.
/// </summary>
/// <param name="accessCondition">An object that represents the access conditions for the blob. If null, no condition is used.</param>
/// <param name="options">An object that specifies any additional options for the request.</param>
/// <returns>A <see cref="RESTCommand"/> implementing the release lease operation.</returns>
internal static RESTCommand <NullType> ReleaseLeaseImpl(ICloudBlob blob, BlobAttributes attributes, AccessCondition accessCondition, BlobRequestOptions options)
{
CommonUtils.AssertNotNull("accessCondition", accessCondition);
if (accessCondition.LeaseId == null)
{
throw new ArgumentException(SR.MissingLeaseIDReleasing, "accessCondition");
}
RESTCommand <NullType> putCmd = new RESTCommand <NullType>(blob.ServiceClient.Credentials, attributes.Uri);
putCmd.ApplyRequestOptions(options);
putCmd.Handler = blob.ServiceClient.AuthenticationHandler;
putCmd.BuildClient = HttpClientFactory.BuildHttpClient;
putCmd.BuildRequest = (cmd, cnt, ctx) => BlobHttpRequestMessageFactory.Lease(cmd.Uri, cmd.ServerTimeoutInSeconds, LeaseAction.Release, null /* proposedLeaseId */, null /* leaseDuration */, null /* leaseBreakPeriod */, accessCondition, cnt, ctx);
putCmd.PreProcessResponse = (cmd, resp, ex, ctx) => HttpResponseParsers.ProcessExpectedStatusCodeNoException(HttpStatusCode.OK, resp, NullType.Value, cmd, ex, ctx);
return(putCmd);
}
/// <summary>
/// Generates a <see cref="RESTCommand"/> for acquiring a lease.
/// </summary>
/// <param name="leaseTime">A <see cref="TimeSpan"/> representing the span of time for which to acquire the lease,
/// which will be rounded down to seconds. If null, an infinite lease will be acquired. If not null, this must be
/// greater than zero.</param>
/// <param name="proposedLeaseId">A string representing the proposed lease ID for the new lease, or null if no lease ID is proposed.</param>
/// <param name="accessCondition">An object that represents the access conditions for the blob. If null, no condition is used.</param>
/// <param name="options">An object that specifies any additional options for the request.</param>
/// <returns>A <see cref="RESTCommand"/> implementing the acquire lease operation.</returns>
internal static RESTCommand <string> AcquireLeaseImpl(ICloudBlob blob, BlobAttributes attributes, TimeSpan?leaseTime, string proposedLeaseId, AccessCondition accessCondition, BlobRequestOptions options)
{
int leaseDuration = -1;
if (leaseTime.HasValue)
{
CommonUtils.AssertInBounds("leaseTime", leaseTime.Value, TimeSpan.FromSeconds(1), TimeSpan.MaxValue);
leaseDuration = (int)leaseTime.Value.TotalSeconds;
}
RESTCommand <string> putCmd = new RESTCommand <string>(blob.ServiceClient.Credentials, attributes.Uri);
putCmd.ApplyRequestOptions(options);
putCmd.Handler = blob.ServiceClient.AuthenticationHandler;
putCmd.BuildClient = HttpClientFactory.BuildHttpClient;
putCmd.BuildRequest = (cmd, cnt, ctx) => BlobHttpRequestMessageFactory.Lease(cmd.Uri, cmd.ServerTimeoutInSeconds, LeaseAction.Acquire, proposedLeaseId, leaseDuration, null /* leaseBreakPeriod */, accessCondition, cnt, ctx);
putCmd.PreProcessResponse = (cmd, resp, ex, ctx) =>
{
HttpResponseParsers.ProcessExpectedStatusCodeNoException(HttpStatusCode.Created, resp, null /* retVal */, cmd, ex, ctx);
return(BlobHttpResponseParsers.GetLeaseId(resp));
};
return(putCmd);
}
/// <summary>
/// Generates a <see cref="RESTCommand"/> for releasing a lease.
/// </summary>
/// <param name="blob">The blob object that is calling this method.</param>
/// <param name="attributes">The blob's attributes.</param>
/// <param name="accessCondition">An object that represents the access conditions for the blob. If null, no condition is used.</param>
/// <param name="options">An object that specifies additional options for the request.</param>
/// <returns>A <see cref="RESTCommand"/> implementing the release lease operation.</returns>
internal static RESTCommand <NullType> ReleaseLeaseImpl(ICloudBlob blob, BlobAttributes attributes, AccessCondition accessCondition, BlobRequestOptions options)
{
CommonUtility.AssertNotNull("accessCondition", accessCondition);
if (accessCondition.LeaseId == null)
{
throw new ArgumentException(SR.MissingLeaseIDReleasing, "accessCondition");
}
RESTCommand <NullType> putCmd = new RESTCommand <NullType>(blob.ServiceClient.Credentials, attributes.StorageUri);
options.ApplyToStorageCommand(putCmd);
putCmd.Handler = blob.ServiceClient.AuthenticationHandler;
putCmd.BuildClient = HttpClientFactory.BuildHttpClient;
putCmd.BuildRequest = (cmd, uri, builder, cnt, serverTimeout, ctx) => BlobHttpRequestMessageFactory.Lease(uri, serverTimeout, LeaseAction.Release, null /* proposedLeaseId */, null /* leaseDuration */, null /* leaseBreakPeriod */, accessCondition, cnt, ctx);
putCmd.PreProcessResponse = (cmd, resp, ex, ctx) =>
{
HttpResponseParsers.ProcessExpectedStatusCodeNoException(HttpStatusCode.OK, resp, NullType.Value, cmd, ex);
CloudBlobSharedImpl.UpdateETagLMTAndSequenceNumber(attributes, resp);
return(NullType.Value);
};
return(putCmd);
}
