com.azure.storage.blob.specialized.BlobLeaseClient Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of azure-storage-blob Show documentation
Show all versions of azure-storage-blob Show documentation
This module contains client library for Microsoft Azure Blob Storage.
// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License.
package com.azure.storage.blob.specialized;
import com.azure.core.annotation.ReturnType;
import com.azure.core.annotation.ServiceClient;
import com.azure.core.annotation.ServiceMethod;
import com.azure.core.http.RequestConditions;
import com.azure.core.http.rest.Response;
import com.azure.core.util.Context;
import com.azure.storage.blob.BlobClient;
import com.azure.storage.blob.BlobContainerClient;
import com.azure.storage.blob.implementation.util.ModelHelper;
import com.azure.storage.blob.options.BlobAcquireLeaseOptions;
import com.azure.storage.blob.options.BlobBreakLeaseOptions;
import com.azure.storage.blob.options.BlobChangeLeaseOptions;
import com.azure.storage.blob.options.BlobReleaseLeaseOptions;
import com.azure.storage.blob.options.BlobRenewLeaseOptions;
import com.azure.storage.common.implementation.StorageImplUtils;
import java.net.URL;
import java.time.Duration;
/**
* This class provides a client that contains all the leasing operations for {@link BlobContainerClient containers} and
* {@link BlobClient blobs}. This client acts as a supplement to those clients and only handles leasing operations.
*
* Instantiating a BlobLeaseClient
*
*
*
* BlobLeaseClient blobLeaseClient = new BlobLeaseClientBuilder()
* .blobClient(blobClient)
* .buildClient();
*
*
*
*
*
* BlobLeaseClient blobLeaseClient = new BlobLeaseClientBuilder()
* .containerClient(blobContainerClient)
* .buildClient();
*
*
*
* View {@link BlobLeaseClientBuilder this} for additional ways to construct the client.
*
* For more information about leasing see the
* container leasing or
* blob leasing documentation.
*
* @see BlobLeaseClientBuilder
*/
@ServiceClient(builder = BlobLeaseClientBuilder.class)
public final class BlobLeaseClient {
private final BlobLeaseAsyncClient client;
BlobLeaseClient(BlobLeaseAsyncClient client) {
this.client = client;
}
/**
* Gets the {@link URL} of the lease client.
*
* The lease will either be a container or blob URL depending on which the lease client is associated.
*
* @return URL of the lease client.
*/
public String getResourceUrl() {
return client.getResourceUrl();
}
/**
* Get the lease ID for this lease.
*
* @return the lease ID.
*/
public String getLeaseId() {
return client.getLeaseId();
}
/**
* Acquires a lease for write and delete operations. The lease duration must be between 15 to 60 seconds or
* -1 for an infinite duration.
*
* Code Samples
*
*
*
* System.out.printf("Lease ID is %s%n", client.acquireLease(60));
*
*
*
* @param durationInSeconds The duration of the lease between 15 to 60 seconds or -1 for an infinite duration.
* @return The lease ID.
*/
@ServiceMethod(returns = ReturnType.SINGLE)
public String acquireLease(int durationInSeconds) {
return acquireLeaseWithResponse(durationInSeconds, null, null, Context.NONE).getValue();
}
/**
* Acquires a lease for write and delete operations. The lease duration must be between 15 to 60 seconds or
* -1 for an infinite duration.
*
* Code Samples
*
*
*
* RequestConditions modifiedRequestConditions = new RequestConditions()
* .setIfModifiedSince(OffsetDateTime.now().minusDays(3));
*
* System.out.printf("Lease ID is %s%n", client
* .acquireLeaseWithResponse(60, modifiedRequestConditions, timeout, new Context(key, value))
* .getValue());
*
*
*
* @param durationInSeconds The duration of the lease between 15 to 60 seconds or -1 for an infinite duration.
* @param modifiedRequestConditions Standard HTTP Access conditions related to the modification of data. ETag and
* LastModifiedTime are used to construct conditions related to when the resource was changed relative to the given
* request. The request will fail if the specified condition is not satisfied.
* @param timeout An optional timeout value beyond which a {@link RuntimeException} will be raised.
* @param context Additional context that is passed through the Http pipeline during the service call.
* @return The lease ID.
*/
@ServiceMethod(returns = ReturnType.SINGLE)
public Response acquireLeaseWithResponse(int durationInSeconds, RequestConditions modifiedRequestConditions,
Duration timeout, Context context) {
return acquireLeaseWithResponse(new BlobAcquireLeaseOptions(durationInSeconds)
.setRequestConditions(ModelHelper.populateBlobLeaseRequestConditions(modifiedRequestConditions)), timeout,
context);
}
/**
* Acquires a lease for write and delete operations. The lease duration must be between 15 to 60 seconds or
* -1 for an infinite duration.
*
* Code Samples
*
*
*
* BlobLeaseRequestConditions requestConditions = new BlobLeaseRequestConditions()
* .setIfModifiedSince(OffsetDateTime.now().minusDays(3));
*
* BlobAcquireLeaseOptions options = new BlobAcquireLeaseOptions(60)
* .setRequestConditions(requestConditions);
*
* System.out.printf("Lease ID is %s%n", client
* .acquireLeaseWithResponse(options, timeout, new Context(key, value))
* .getValue());
*
*
*
* @param options {@link BlobAcquireLeaseOptions}
* @param timeout An optional timeout value beyond which a {@link RuntimeException} will be raised.
* @param context Additional context that is passed through the Http pipeline during the service call.
* @return The lease ID.
*/
@ServiceMethod(returns = ReturnType.SINGLE)
public Response acquireLeaseWithResponse(BlobAcquireLeaseOptions options, Duration timeout,
Context context) {
return StorageImplUtils.blockWithOptionalTimeout(this.client.acquireLeaseWithResponse(options, context),
timeout);
}
/**
* Renews the previously acquired lease.
*
* Code Samples
*
*
*
* System.out.printf("Renewed lease ID is %s%n", client.renewLease());
*
*
*
* @return The renewed lease ID.
*/
@ServiceMethod(returns = ReturnType.SINGLE)
public String renewLease() {
return renewLeaseWithResponse((RequestConditions) null, null, Context.NONE).getValue();
}
/**
* Renews the previously-acquired lease.
*
* Code Samples
*
*
*
* RequestConditions modifiedRequestConditions = new RequestConditions()
* .setIfUnmodifiedSince(OffsetDateTime.now().minusDays(3));
*
* System.out.printf("Renewed lease ID is %s%n",
* client.renewLeaseWithResponse(modifiedRequestConditions, timeout, new Context(key, value))
* .getValue());
*
*
*
* @param modifiedRequestConditions Standard HTTP Access conditions related to the modification of data. ETag and
* LastModifiedTime are used to construct conditions related to when the resource was changed relative to the given
* request. The request will fail if the specified condition is not satisfied.
* @param timeout An optional timeout value beyond which a {@link RuntimeException} will be raised.
* @param context Additional context that is passed through the Http pipeline during the service call.
* @return The renewed lease ID.
*/
@ServiceMethod(returns = ReturnType.SINGLE)
public Response renewLeaseWithResponse(RequestConditions modifiedRequestConditions, Duration timeout,
Context context) {
return renewLeaseWithResponse(new BlobRenewLeaseOptions()
.setRequestConditions(ModelHelper.populateBlobLeaseRequestConditions(modifiedRequestConditions)),
timeout, context);
}
/**
* Renews the previously-acquired lease.
*
* Code Samples
*
*
*
* BlobLeaseRequestConditions requestConditions = new BlobLeaseRequestConditions()
* .setIfModifiedSince(OffsetDateTime.now().minusDays(3));
*
* BlobRenewLeaseOptions options = new BlobRenewLeaseOptions()
* .setRequestConditions(requestConditions);
*
* System.out.printf("Renewed lease ID is %s%n",
* client.renewLeaseWithResponse(options, timeout, new Context(key, value))
* .getValue());
*
*
*
* @param options {@link BlobRenewLeaseOptions}
* @param timeout An optional timeout value beyond which a {@link RuntimeException} will be raised.
* @param context Additional context that is passed through the Http pipeline during the service call.
* @return The renewed lease ID.
*/
@ServiceMethod(returns = ReturnType.SINGLE)
public Response renewLeaseWithResponse(BlobRenewLeaseOptions options, Duration timeout,
Context context) {
return StorageImplUtils.blockWithOptionalTimeout(this.client.renewLeaseWithResponse(options, context), timeout);
}
/**
* Releases the previously acquired lease.
*
* Code Samples
*
*
*
* client.releaseLease();
* System.out.println("Release lease completed");
*
*
*/
@ServiceMethod(returns = ReturnType.SINGLE)
public void releaseLease() {
releaseLeaseWithResponse((RequestConditions) null, null, Context.NONE);
}
/**
* Releases the previously acquired lease.
*
* Code Samples
*
*
*
* RequestConditions modifiedRequestConditions = new RequestConditions()
* .setIfUnmodifiedSince(OffsetDateTime.now().minusDays(3));
*
* System.out.printf("Release lease completed with status %d%n",
* client.releaseLeaseWithResponse(modifiedRequestConditions, timeout, new Context(key, value))
* .getStatusCode());
*
*
*
* @param modifiedRequestConditions Standard HTTP Access conditions related to the modification of data. ETag and
* LastModifiedTime are used to construct conditions related to when the resource was changed relative to the given
* request. The request will fail if the specified condition is not satisfied.
* @param timeout An optional timeout value beyond which a {@link RuntimeException} will be raised.
* @param context Additional context that is passed through the Http pipeline during the service call.
* @return A response containing status code and HTTP headers.
*/
@ServiceMethod(returns = ReturnType.SINGLE)
public Response releaseLeaseWithResponse(RequestConditions modifiedRequestConditions, Duration timeout,
Context context) {
return releaseLeaseWithResponse(new BlobReleaseLeaseOptions()
.setRequestConditions(ModelHelper.populateBlobLeaseRequestConditions(modifiedRequestConditions)),
timeout, context);
}
/**
* Releases the previously acquired lease.
*
* Code Samples
*
*
*
* BlobLeaseRequestConditions requestConditions = new BlobLeaseRequestConditions()
* .setIfModifiedSince(OffsetDateTime.now().minusDays(3));
*
* BlobReleaseLeaseOptions options = new BlobReleaseLeaseOptions()
* .setRequestConditions(requestConditions);
*
* System.out.printf("Release lease completed with status %d%n",
* client.releaseLeaseWithResponse(options, timeout, new Context(key, value))
* .getStatusCode());
*
*
*
* @param options {@link BlobReleaseLeaseOptions}
* @param timeout An optional timeout value beyond which a {@link RuntimeException} will be raised.
* @param context Additional context that is passed through the Http pipeline during the service call.
* @return A response containing status code and HTTP headers.
*/
@ServiceMethod(returns = ReturnType.SINGLE)
public Response releaseLeaseWithResponse(BlobReleaseLeaseOptions options, Duration timeout,
Context context) {
return StorageImplUtils.blockWithOptionalTimeout(this.client.releaseLeaseWithResponse(options, context),
timeout);
}
/**
* Breaks the previously acquired lease, if it exists.
*
* Code Samples
*
*
*
* System.out.printf("The broken lease has %d seconds remaining on the lease", client.breakLease());
*
*
*
* @return The remaining time in the broken lease in seconds.
*/
@ServiceMethod(returns = ReturnType.SINGLE)
public Integer breakLease() {
return breakLeaseWithResponse(null, null, null, Context.NONE).getValue();
}
/**
* Breaks the previously acquired lease, if it exists.
*
* If {@code null} is passed for {@code breakPeriodInSeconds} a fixed duration lease will break after the
* remaining lease period elapses and an infinite lease will break immediately.
*
* Code Samples
*
*
*
* Integer retainLeaseInSeconds = 5;
* RequestConditions modifiedRequestConditions = new RequestConditions()
* .setIfUnmodifiedSince(OffsetDateTime.now().minusDays(3));
*
* System.out.printf("The broken lease has %d seconds remaining on the lease", client
* .breakLeaseWithResponse(retainLeaseInSeconds, modifiedRequestConditions, timeout, new Context(key, value))
* .getValue());
*
*
*
* @param breakPeriodInSeconds An optional duration, between 0 and 60 seconds, that the lease should continue before
* it is broken. If the break period is longer than the time remaining on the lease the remaining time on the lease
* is used. A new lease will not be available before the break period has expired, but the lease may be held for
* longer than the break period.
* @param modifiedRequestConditions Standard HTTP Access conditions related to the modification of data. ETag and
* LastModifiedTime are used to construct conditions related to when the resource was changed relative to the given
* request. The request will fail if the specified condition is not satisfied.
* @param timeout An optional timeout value beyond which a {@link RuntimeException} will be raised.
* @param context Additional context that is passed through the Http pipeline during the service call.
* @return The remaining time in the broken lease in seconds.
*/
@ServiceMethod(returns = ReturnType.SINGLE)
public Response breakLeaseWithResponse(Integer breakPeriodInSeconds,
RequestConditions modifiedRequestConditions, Duration timeout, Context context) {
return breakLeaseWithResponse(new BlobBreakLeaseOptions()
.setBreakPeriod(breakPeriodInSeconds == null ? null : Duration.ofSeconds(breakPeriodInSeconds))
.setRequestConditions(ModelHelper.populateBlobLeaseRequestConditions(modifiedRequestConditions)),
timeout, context);
}
/**
* Breaks the previously acquired lease, if it exists.
*
* If {@code null} is passed for {@code breakPeriodInSeconds} a fixed duration lease will break after the
* remaining lease period elapses and an infinite lease will break immediately.
*
* Code Samples
*
*
*
* Integer retainLeaseInSeconds = 5;
* BlobLeaseRequestConditions requestConditions = new BlobLeaseRequestConditions()
* .setIfUnmodifiedSince(OffsetDateTime.now().minusDays(3));
*
* BlobBreakLeaseOptions options = new BlobBreakLeaseOptions()
* .setBreakPeriod(Duration.ofSeconds(retainLeaseInSeconds))
* .setRequestConditions(requestConditions);
*
* System.out.printf("The broken lease has %d seconds remaining on the lease", client
* .breakLeaseWithResponse(options, timeout, new Context(key, value))
* .getValue());
*
*
*
* @param options {@link BlobBreakLeaseOptions}
* @param timeout An optional timeout value beyond which a {@link RuntimeException} will be raised.
* @param context Additional context that is passed through the Http pipeline during the service call.
* @return The remaining time in the broken lease in seconds.
*/
@ServiceMethod(returns = ReturnType.SINGLE)
public Response breakLeaseWithResponse(BlobBreakLeaseOptions options, Duration timeout, Context context) {
return StorageImplUtils.blockWithOptionalTimeout(this.client.breakLeaseWithResponse(options, context), timeout);
}
/**
* Changes the lease ID.
*
* Code Samples
*
*
*
* System.out.printf("Changed lease ID is %s%n", client.changeLease("proposedId"));
*
*
*
* @param proposedId A new lease ID in a valid GUID format.
* @return The new lease ID.
*/
@ServiceMethod(returns = ReturnType.SINGLE)
public String changeLease(String proposedId) {
return changeLeaseWithResponse(proposedId, null, null, Context.NONE).getValue();
}
/**
* Changes the lease ID.
*
* Code Samples
*
*
*
* RequestConditions modifiedRequestConditions = new RequestConditions()
* .setIfUnmodifiedSince(OffsetDateTime.now().minusDays(3));
*
* System.out.printf("Changed lease ID is %s%n",
* client.changeLeaseWithResponse("proposedId", modifiedRequestConditions, timeout, new Context(key, value))
* .getValue());
*
*
*
* @param proposedId A new lease ID in a valid GUID format.
* @param modifiedRequestConditions Standard HTTP Access conditions related to the modification of data. ETag and
* LastModifiedTime are used to construct conditions related to when the resource was changed relative to the given
* request. The request will fail if the specified condition is not satisfied.
* @param timeout An optional timeout value beyond which a {@link RuntimeException} will be raised.
* @param context Additional context that is passed through the Http pipeline during the service call.
* @return The new lease ID.
*/
@ServiceMethod(returns = ReturnType.SINGLE)
public Response changeLeaseWithResponse(String proposedId,
RequestConditions modifiedRequestConditions, Duration timeout, Context context) {
return changeLeaseWithResponse(new BlobChangeLeaseOptions(proposedId)
.setRequestConditions(ModelHelper.populateBlobLeaseRequestConditions(modifiedRequestConditions)), timeout,
context);
}
/**
* Changes the lease ID.
*
* Code Samples
*
*
*
* BlobLeaseRequestConditions requestConditions = new BlobLeaseRequestConditions()
* .setIfUnmodifiedSince(OffsetDateTime.now().minusDays(3));
*
* BlobChangeLeaseOptions options = new BlobChangeLeaseOptions("proposedId")
* .setRequestConditions(requestConditions);
*
* System.out.printf("Changed lease ID is %s%n",
* client.changeLeaseWithResponse(options, timeout, new Context(key, value))
* .getValue());
*
*
*
* @param options {@link BlobChangeLeaseOptions}
* @param timeout An optional timeout value beyond which a {@link RuntimeException} will be raised.
* @param context Additional context that is passed through the Http pipeline during the service call.
* @return The new lease ID.
*/
@ServiceMethod(returns = ReturnType.SINGLE)
public Response changeLeaseWithResponse(BlobChangeLeaseOptions options, Duration timeout, Context context) {
return StorageImplUtils.blockWithOptionalTimeout(this.client.changeLeaseWithResponse(options, context),
timeout);
}
/**
* Get associated account name.
*
* @return account name associated with this storage resource.
*/
public String getAccountName() {
return client.getAccountName();
}
}