com.microsoft.azure.storage.blob.BlobAccessConditions 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
The Azure Storage Java Blob library.
There is a newer version: 11.0.1
/*
 * 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.azure.storage.blob;

/**
 * This class contains values which will restrict the successful operation of a variety of requests to the conditions
 * present. These conditions are entirely optional. The entire object or any of its properties may be set to null when
 * passed to a method to indicate that those conditions are not desired. Please refer to the type of each field for more
 * information on those particular access conditions.
 */
public final class BlobAccessConditions {

    /**
     * An object representing no access conditions.
     */
    public static final BlobAccessConditions NONE =
            new BlobAccessConditions(null, null, null,
                    null);

    // Optional standard HTTP access conditions which are optionally set
    private final HTTPAccessConditions httpAccessConditions;

    // Optional access conditions for a lease on a container or blob
    private final LeaseAccessConditions leaseAccessConditions;

    // Optional access conditions which are specific to append blobs
    private final AppendBlobAccessConditions appendBlobAccessConditions;

    // Optional access conditions which are specific to page blobs
    private final PageBlobAccessConditions pageBlobAccessConditions;

    /**
     * Access conditions which are specific to blobs.
     *
     * @param httpAccessConditions
     *      {@link HTTPAccessConditions}
     * @param leaseAccessConditions
     *      {@link LeaseAccessConditions}
     * @param appendBlobAccessConditions
     *      {@link AppendBlobAccessConditions}
     * @param pageBlobAccessConditions
     *      {@link PageBlobAccessConditions}
     */
    public BlobAccessConditions(
            HTTPAccessConditions httpAccessConditions,
            LeaseAccessConditions leaseAccessConditions,
            AppendBlobAccessConditions appendBlobAccessConditions,
            PageBlobAccessConditions pageBlobAccessConditions) {
        this.httpAccessConditions = httpAccessConditions == null ?
                HTTPAccessConditions.NONE : httpAccessConditions;
        this.leaseAccessConditions = leaseAccessConditions == null ?
                LeaseAccessConditions.NONE : leaseAccessConditions;
        this.appendBlobAccessConditions = appendBlobAccessConditions == null ?
                AppendBlobAccessConditions.NONE : appendBlobAccessConditions;
        this.pageBlobAccessConditions = pageBlobAccessConditions == null ?
                PageBlobAccessConditions.NONE : pageBlobAccessConditions;
    }

    /**
     * @return
     *      The HttpAccessConditions.
     */
    HTTPAccessConditions getHttpAccessConditions() {
        return httpAccessConditions;
    }

    /**
     * @return
     *      The LeaseAccessConditions.
     */
    LeaseAccessConditions getLeaseAccessConditions() {
        return leaseAccessConditions;
    }

    /**
     * @return
     *      The AppendBlobAccessConditions.
     */
    AppendBlobAccessConditions getAppendBlobAccessConditions() {
        return appendBlobAccessConditions;
    }

    /**
     * @return
     *      The PageBlobAccessConditions.
     */
    PageBlobAccessConditions getPageBlobAccessConditions() {
        return pageBlobAccessConditions;
    }

}