com.microsoft.azure/azure-storage/8.6.6 : com/microsoft/azure/storage/file/CloudFileClient.java

CloudFileClient
https://github.com/Azure/azure-storage-java: SDK for Microsoft Azure Storage Clients
The Apache Software License, Version 2.0
Microsoft
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.
/**
 * 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.file;

import java.net.HttpURLConnection;
import java.net.URI;
import java.net.URISyntaxException;
import java.util.EnumSet;

import com.microsoft.azure.storage.DoesServiceRequest;
import com.microsoft.azure.storage.OperationContext;
import com.microsoft.azure.storage.ResultContinuation;
import com.microsoft.azure.storage.ResultContinuationType;
import com.microsoft.azure.storage.ResultSegment;
import com.microsoft.azure.storage.ServiceClient;
import com.microsoft.azure.storage.StorageCredentials;
import com.microsoft.azure.storage.StorageCredentialsAnonymous;
import com.microsoft.azure.storage.StorageException;
import com.microsoft.azure.storage.StorageUri;
import com.microsoft.azure.storage.core.ExecutionEngine;
import com.microsoft.azure.storage.core.LazySegmentedIterable;
import com.microsoft.azure.storage.core.ListResponse;
import com.microsoft.azure.storage.core.ListingContext;
import com.microsoft.azure.storage.core.SR;
import com.microsoft.azure.storage.core.SegmentedStorageRequest;
import com.microsoft.azure.storage.core.StorageRequest;
import com.microsoft.azure.storage.core.Utility;

Provides a client for accessing the Microsoft Azure File service.

This class provides a point of access to the File service. The service client encapsulates the base URI for the File
service. It also encapsulates the credentials for accessing the storage account.
/**
 * Provides a client for accessing the Microsoft Azure File service.
 * <p>
 * This class provides a point of access to the File service. The service client encapsulates the base URI for the File
 * service. It also encapsulates the credentials for accessing the storage account.
 */
public final class CloudFileClient extends ServiceClient {

    Holds the default request option values associated with this Service Client.
/**
     * Holds the default request option values associated with this Service Client.
     */
    private FileRequestOptions defaultRequestOptions = new FileRequestOptions();

    Creates an instance of the CloudFileClient class using the specified File service endpoint and
account credentials.
Params: baseUri – 
           A java.net.URI object that represents the File service endpoint used to create the
           client.
credentials –  A StorageCredentials object that represents the account credentials./**
     * Creates an instance of the <code>CloudFileClient</code> class using the specified File service endpoint and
     * account credentials.
     * 
     * @param baseUri
     *            A <code>java.net.URI</code> object that represents the File service endpoint used to create the
     *            client.
     * @param credentials
     *            A {@link StorageCredentials} object that represents the account credentials.
     */
    public CloudFileClient(final URI baseUri, StorageCredentials credentials) {
        this(new StorageUri(baseUri), credentials);
    }

    Creates an instance of the CloudFileClient class using the specified File service endpoint and
account credentials.
Params: storageUri –  A StorageUri object that represents the File service endpoint used to create the client.
credentials –  A StorageCredentials object that represents the account credentials./**
     * Creates an instance of the <code>CloudFileClient</code> class using the specified File service endpoint and
     * account credentials.
     * 
     * @param storageUri
     *            A {@link StorageUri} object that represents the File service endpoint used to create the
     *            client.
     * @param credentials
     *            A {@link StorageCredentials} object that represents the account credentials.
     */
    public CloudFileClient(StorageUri storageUri, StorageCredentials credentials) {
        super(storageUri, credentials);
        if (credentials == null || credentials.getClass().equals(StorageCredentialsAnonymous.class)) {
            throw new IllegalArgumentException(SR.STORAGE_CREDENTIALS_NULL_OR_ANONYMOUS);
        }
        FileRequestOptions.applyDefaults(this.defaultRequestOptions);
    }

    Gets a CloudFileShare object with the specified name. 
Params: shareName – 
           The name of the share, which must adhere to share naming rules. The share name should not
           include any path separator characters (/).
           Share names must be lowercase, between 3-63 characters long and must start with a letter or
           number. Share names may contain only letters, numbers, and the dash (-) character.
Throws: StorageException – 
URISyntaxException – 
See Also: Naming and Referencing Shares,
     *      Directories, Files, and Metadata
Returns: A reference to a CloudFileShare object./**
     * Gets a {@link CloudFileShare} object with the specified name.
     * 
     * @param shareName
     *            The name of the share, which must adhere to share naming rules. The share name should not
     *            include any path separator characters (/).
     *            Share names must be lowercase, between 3-63 characters long and must start with a letter or
     *            number. Share names may contain only letters, numbers, and the dash (-) character.
     * 
     * @return A reference to a {@link CloudFileShare} object.
     * @throws StorageException
     * @throws URISyntaxException
     * 
     * @see <a href="http://msdn.microsoft.com/en-us/library/azure/dn167011.aspx">Naming and Referencing Shares,
     *      Directories, Files, and Metadata</a>
     */
    public CloudFileShare getShareReference(final String shareName) throws URISyntaxException, StorageException {
        Utility.assertNotNullOrEmpty("shareName", shareName);
        return this.getShareReference(shareName, null);
    }

    Gets a CloudFileShare object with the specified name. 
Params: shareName – 
           The name of the share, which must adhere to share naming rules. The share name should not
           include any path separator characters (/).
           Share names must be lowercase, between 3-63 characters long and must start with a letter or
           number. Share names may contain only letters, numbers, and the dash (-) character.
snapshotID – 
           A String that represents the snapshot ID of the share.
Throws: StorageException – 
URISyntaxException – 
See Also: Naming and Referencing Shares,
     *      Directories, Files, and Metadata
Returns: A reference to a CloudFileShare object./**
     * Gets a {@link CloudFileShare} object with the specified name.
     * 
     * @param shareName
     *            The name of the share, which must adhere to share naming rules. The share name should not
     *            include any path separator characters (/).
     *            Share names must be lowercase, between 3-63 characters long and must start with a letter or
     *            number. Share names may contain only letters, numbers, and the dash (-) character.
     * @param snapshotID
     *            A <code>String</code> that represents the snapshot ID of the share.
     * @return A reference to a {@link CloudFileShare} object.
     * @throws StorageException
     * @throws URISyntaxException
     * 
     * @see <a href="http://msdn.microsoft.com/en-us/library/azure/dn167011.aspx">Naming and Referencing Shares,
     *      Directories, Files, and Metadata</a>
     */
    public CloudFileShare getShareReference(final String shareName, String snapshotID) throws URISyntaxException, StorageException {
        Utility.assertNotNullOrEmpty("shareName", shareName);
        return new CloudFileShare(shareName, snapshotID, this);
    }

    Returns an enumerable collection of shares for this File service client.
Returns: An enumerable collection of CloudFileShare objects retrieved lazily that represent the shares for this client./**
     * Returns an enumerable collection of shares for this File service client.
     * 
     * @return An enumerable collection of {@link CloudFileShare} objects retrieved lazily that represent the
     *         shares for this client.
     */
    @DoesServiceRequest
    public Iterable<CloudFileShare> listShares() {
        return this.listSharesWithPrefix(null, EnumSet.noneOf(ShareListingDetails.class), null /* options */, null /* opContext */);
    }

    Returns an enumerable collection of shares whose names begin with the specified prefix for this File service
client.
Params: prefix – 
           A String that represents the share name prefix.
Returns: An enumerable collection of CloudFileShare objects retrieved lazily that represent the shares for this client whose names begin with the specified prefix./**
     * Returns an enumerable collection of shares whose names begin with the specified prefix for this File service
     * client.
     * 
     * @param prefix
     *            A <code>String</code> that represents the share name prefix.
     * 
     * @return An enumerable collection of {@link CloudFileShare} objects retrieved lazily that represent the
     *         shares for this client whose names begin with the specified prefix.
     */
    @DoesServiceRequest
    public Iterable<CloudFileShare> listShares(final String prefix) {
        return this.listSharesWithPrefix(prefix, EnumSet.noneOf(ShareListingDetails.class), null /* options */, null /* opContext */);
    }

    Returns an enumerable collection of shares whose names begin with the specified prefix for this File
service client, using the specified details settings, request options, and operation context.
Params: prefix – 
           A String that represents the share name prefix.
detailsIncluded – 
           A java.util.EnumSet object that contains ShareListingDetails values that indicate whether share snapshots and/or metadata will be returned.
options –  A FileRequestOptions object that specifies any additional options for the request. Specifying null will use the default request options from the associated service client ( CloudFileClient).
opContext –  An OperationContext object that represents the context for the current operation. This object is used to track requests to the storage service, and to provide additional runtime information about the operation.
Returns: An enumerable collection of CloudFileShare objects retrieved lazily that represents the shares for this client./**
     * Returns an enumerable collection of shares whose names begin with the specified prefix for this File
     * service client, using the specified details settings, request options, and operation context.
     * 
     * @param prefix
     *            A <code>String</code> that represents the share name prefix.
     * @param detailsIncluded
     *            A <code>java.util.EnumSet</code> object that contains {@link ShareListingDetails} values that indicate
     *            whether share snapshots and/or metadata will be returned.
     * @param options
     *            A {@link FileRequestOptions} object that specifies any additional options for the request. Specifying
     *            <code>null</code> will use the default request options from the associated service client (
     *            {@link CloudFileClient}).
     * @param opContext
     *            An {@link OperationContext} object that represents the context for the current operation. This object
     *            is used to track requests to the storage service, and to provide additional runtime information about
     *            the operation.
     * 
     * @return An enumerable collection of {@link CloudFileShare} objects retrieved lazily that represents the
     *         shares for this client.
     */
    @DoesServiceRequest
    public Iterable<CloudFileShare> listShares(final String prefix, final EnumSet<ShareListingDetails> detailsIncluded,
            final FileRequestOptions options, final OperationContext opContext) {
        return this.listSharesWithPrefix(prefix, detailsIncluded, options, opContext);
    }

    Returns a result segment of an enumerable collection of shares for this File service client.
Throws: StorageException – 
            If a storage service error occurred.
Returns: A ResultSegment object that contains a segment of the enumerable collection of CloudFileShare objects that represent the shares for this client./**
     * Returns a result segment of an enumerable collection of shares for this File service client.
     * 
     * @return A {@link ResultSegment} object that contains a segment of the enumerable collection of
     *         {@link CloudFileShare} objects that represent the shares for this client.
     * 
     * @throws StorageException
     *             If a storage service error occurred.
     */
    @DoesServiceRequest
    public ResultSegment<CloudFileShare> listSharesSegmented() throws StorageException {
        return this.listSharesSegmented(null, EnumSet.noneOf(ShareListingDetails.class), null, null /* continuationToken */,
                null /* options */, null /* opContext */);
    }

    Returns a result segment of an enumerable collection of shares whose names begin with the specified
prefix for this File service client.
Params: prefix – 
           A String that represents the prefix of the share name.
Throws: StorageException – 
            If a storage service error occurred.
Returns: A ResultSegment object that contains a segment of the enumerable collection of CloudFileShare objects that represent the shares whose names begin with the specified prefix./**
     * Returns a result segment of an enumerable collection of shares whose names begin with the specified
     * prefix for this File service client.
     * 
     * @param prefix
     *            A <code>String</code> that represents the prefix of the share name.
     * 
     * @return A {@link ResultSegment} object that contains a segment of the enumerable collection of
     *         {@link CloudFileShare} objects that represent the shares whose names begin with the specified
     *         prefix.
     * 
     * @throws StorageException
     *             If a storage service error occurred.
     */
    @DoesServiceRequest
    public ResultSegment<CloudFileShare> listSharesSegmented(final String prefix) throws StorageException {
        return this.listSharesWithPrefixSegmented(prefix, EnumSet.noneOf(ShareListingDetails.class), null, null /* continuationToken */,
                null /* options */, null /* opContext */);
    }

    Returns a result segment of an enumerable collection of shares whose names begin with the specified
prefix, using the specified listing details options, request options, and operation context.
Params: prefix – 
           A String that represents the prefix of the share name.
detailsIncluded – 
           A java.util.EnumSet object that contains ShareListingDetails values that indicate whether share snapshots and/or metadata will be returned.
maxResults – 
           The maximum number of results to retrieve.  If null or greater
           than 5000, the server will return up to 5,000 items.  Must be at least 1.
continuationToken –  A ResultContinuation object that represents a continuation token returned by a previous listing operation.
options –  A FileRequestOptions object that specifies any additional options for the request. Specifying null will use the default request options from the associated service client ( CloudFileClient).
opContext –  An OperationContext object that represents the context for the current operation. This object is used to track requests to the storage service, and to provide additional runtime information about the operation.
Throws: StorageException – 
            If a storage service error occurred.
Returns: A ResultSegment object that contains a segment of the enumerable collection of CloudFileShare objects that represent the shares for this client./**
     * Returns a result segment of an enumerable collection of shares whose names begin with the specified
     * prefix, using the specified listing details options, request options, and operation context.
     * 
     * @param prefix
     *            A <code>String</code> that represents the prefix of the share name.
     * @param detailsIncluded
     *            A <code>java.util.EnumSet</code> object that contains {@link ShareListingDetails} values that indicate
     *            whether share snapshots and/or metadata will be returned.
     * @param maxResults
     *            The maximum number of results to retrieve.  If <code>null</code> or greater
     *            than 5000, the server will return up to 5,000 items.  Must be at least 1.
     * @param continuationToken
     *            A {@link ResultContinuation} object that represents a continuation token returned
     *            by a previous listing operation.
     * @param options
     *            A {@link FileRequestOptions} object that specifies any additional options for
     *            the request. Specifying <code>null</code> will use the default request options
     *            from the associated service client ( {@link CloudFileClient}).
     * @param opContext
     *            An {@link OperationContext} object that represents the context for the current
     *            operation. This object is used to track requests to the storage service,
     *            and to provide additional runtime information about the operation.
     * 
     * @return A {@link ResultSegment} object that contains a segment of the enumerable collection
     *         of {@link CloudFileShare} objects that represent the shares for this client.
     * 
     * @throws StorageException
     *             If a storage service error occurred.
     */
    @DoesServiceRequest
    public ResultSegment<CloudFileShare> listSharesSegmented(final String prefix,
            final EnumSet<ShareListingDetails> detailsIncluded, final Integer maxResults,
            final ResultContinuation continuationToken, final FileRequestOptions options,
            final OperationContext opContext) throws StorageException {
        return this.listSharesWithPrefixSegmented(prefix, detailsIncluded, maxResults, continuationToken, options,
                opContext);
    }

    Returns an enumerable collection of shares whose names begin with the specified prefix, using the
specified details settings, request options, and operation context.
Params: prefix – 
           A String that represents the prefix of the share name.
detailsIncluded – 
           A java.util.EnumSet object that contains ShareListingDetails values that indicate whether share snapshots and/or metadata will be returned.
options –  A FileRequestOptions object that specifies any additional options for the request. Specifying null will use the default request options from the associated service client ( CloudFileClient).
opContext –  An OperationContext object that represents the context for the current operation. This object is used to track requests to the storage service, and to provide additional runtime information about the operation.
Returns: An enumerable collection of CloudFileShare objects retrieved lazily that represent the shares whose names begin with the specified prefix./**
     * Returns an enumerable collection of shares whose names begin with the specified prefix, using the
     * specified details settings, request options, and operation context.
     * 
     * @param prefix
     *            A <code>String</code> that represents the prefix of the share name.
     * @param detailsIncluded
     *            A <code>java.util.EnumSet</code> object that contains {@link ShareListingDetails} values that indicate
     *            whether share snapshots and/or metadata will be returned.
     * @param options
     *            A {@link FileRequestOptions} object that specifies any additional options for the request. Specifying
     *            <code>null</code> will use the default request options from the associated service client (
     *            {@link CloudFileClient}).
     * @param opContext
     *            An {@link OperationContext} object that represents the context for the current operation. This object
     *            is used to track requests to the storage service, and to provide additional runtime information about
     *            the operation.
     * 
     * @return An enumerable collection of {@link CloudFileShare} objects retrieved lazily that represent the
     *         shares whose names begin with the specified prefix.
     */
    private Iterable<CloudFileShare> listSharesWithPrefix(final String prefix,
            final EnumSet<ShareListingDetails> detailsIncluded, FileRequestOptions options, OperationContext opContext) {
        if (opContext == null) {
            opContext = new OperationContext();
        }

        opContext.initialize();
        options = FileRequestOptions.populateAndApplyDefaults(options, this);

        SegmentedStorageRequest segmentedRequest = new SegmentedStorageRequest();

        return new LazySegmentedIterable<CloudFileClient, Void, CloudFileShare>(this.listSharesWithPrefixSegmentedImpl(
                prefix, detailsIncluded, null, options, segmentedRequest), this, null, options.getRetryPolicyFactory(),
                opContext);
    }

    Returns a result segment of an enumerable collection of shares whose names begin with the specified
prefix, using the specified listing details options, request options, and operation context.
Params: prefix – 
           A String that represents the prefix of the share name.
detailsIncluded – 
           A java.util.EnumSet object that contains ShareListingDetails values that indicate whether share snapshots and/or metadata will be returned.
maxResults – 
           The maximum number of results to retrieve.  If null or greater
           than 5000, the server will return up to 5,000 items.  Must be at least 1.
continuationToken –  A ResultContinuation object that represents a continuation token returned by a previous listing operation.
options –  A FileRequestOptions object that specifies any additional options for the request. Specifying null will use the default request options from the associated service client ( CloudFileClient).
opContext –  An OperationContext object that represents the context for the current operation. This object is used to track requests to the storage service, and to provide additional runtime information about the operation.
Throws: StorageException – 
            If a storage service error occurred.
Returns: A ResultSegment object that contains a segment of the enumerable collection of CloudFileShare objects that represent the shares for this client./**
     * Returns a result segment of an enumerable collection of shares whose names begin with the specified
     * prefix, using the specified listing details options, request options, and operation context.
     * 
     * @param prefix
     *            A <code>String</code> that represents the prefix of the share name.
     * @param detailsIncluded
     *            A <code>java.util.EnumSet</code> object that contains {@link ShareListingDetails} values that indicate
     *            whether share snapshots and/or metadata will be returned.
     * @param maxResults
     *            The maximum number of results to retrieve.  If <code>null</code> or greater
     *            than 5000, the server will return up to 5,000 items.  Must be at least 1.
     * @param continuationToken
     *            A {@link ResultContinuation} object that represents a continuation token returned
     *            by a previous listing operation.
     * @param options
     *            A {@link FileRequestOptions} object that specifies any additional options for
     *            the request. Specifying <code>null</code> will use the default request options
     *            from the associated service client ( {@link CloudFileClient}).
     * @param opContext
     *            An {@link OperationContext} object that represents the context for the current
     *            operation. This object is used to track requests to the storage service,
     *            and to provide additional runtime information about the operation.
     * 
     * @return A {@link ResultSegment} object that contains a segment of the enumerable collection
     *         of {@link CloudFileShare} objects that represent the shares for this client.
     * 
     * @throws StorageException
     *             If a storage service error occurred.
     */
    private ResultSegment<CloudFileShare> listSharesWithPrefixSegmented(final String prefix,
            final EnumSet<ShareListingDetails> detailsIncluded, final Integer maxResults,
            final ResultContinuation continuationToken, FileRequestOptions options, OperationContext opContext)
            throws StorageException {
        if (opContext == null) {
            opContext = new OperationContext();
        }

        opContext.initialize();
        options = FileRequestOptions.populateAndApplyDefaults(options, this);

        Utility.assertContinuationType(continuationToken, ResultContinuationType.SHARE);

        SegmentedStorageRequest segmentedRequest = new SegmentedStorageRequest();
        segmentedRequest.setToken(continuationToken);

        return ExecutionEngine.executeWithRetry(this, null,
                this.listSharesWithPrefixSegmentedImpl(prefix, detailsIncluded, maxResults, options, segmentedRequest),
                options.getRetryPolicyFactory(), opContext);
    }

    private StorageRequest<CloudFileClient, Void, ResultSegment<CloudFileShare>> listSharesWithPrefixSegmentedImpl(
            final String prefix, final EnumSet<ShareListingDetails> detailsIncluded, final Integer maxResults,
            final FileRequestOptions options, final SegmentedStorageRequest segmentedRequest) {

        Utility.assertContinuationType(segmentedRequest.getToken(), ResultContinuationType.SHARE);

        final ListingContext listingContext = new ListingContext(prefix, maxResults);

        final StorageRequest<CloudFileClient, Void, ResultSegment<CloudFileShare>> getRequest = new StorageRequest<CloudFileClient, Void, ResultSegment<CloudFileShare>>(
                options, this.getStorageUri()) {

            @Override
            public void setRequestLocationMode() {
                this.setRequestLocationMode(Utility.getListingLocationMode(segmentedRequest.getToken()));
            }

            @Override
            public HttpURLConnection buildRequest(CloudFileClient client, Void parentObject, OperationContext context)
                    throws Exception {
                listingContext.setMarker(segmentedRequest.getToken() != null ? segmentedRequest.getToken()
                        .getNextMarker() : null);
                return FileRequest.listShares(
                        client.getCredentials().transformUri(client.getStorageUri()).getUri(this.getCurrentLocation()),
                        options, context, listingContext, detailsIncluded);
            }

            @Override
            public void signRequest(HttpURLConnection connection, CloudFileClient client, OperationContext context)
                    throws Exception {
                StorageRequest.signBlobQueueAndFileRequest(connection, client, -1L, context);
            }

            @Override
            public ResultSegment<CloudFileShare> preProcessResponse(Void parentObject, CloudFileClient client,
                    OperationContext context) throws Exception {
                if (this.getResult().getStatusCode() != HttpURLConnection.HTTP_OK) {
                    this.setNonExceptionedRetryableFailure(true);
                }
                return null;
            }

            @Override
            public ResultSegment<CloudFileShare> postProcessResponse(HttpURLConnection connection, Void share,
                    CloudFileClient client, OperationContext context, ResultSegment<CloudFileShare> storageObject)
                    throws Exception {
                final ListResponse<CloudFileShare> response = ShareListHandler.getShareList(this.getConnection()
                        .getInputStream(), client);
                ResultContinuation newToken = null;

                if (response.getNextMarker() != null) {
                    newToken = new ResultContinuation();
                    newToken.setNextMarker(response.getNextMarker());
                    newToken.setContinuationType(ResultContinuationType.SHARE);
                    newToken.setTargetLocation(this.getResult().getTargetLocation());
                }

                final ResultSegment<CloudFileShare> resSegment = new ResultSegment<CloudFileShare>(
                        response.getResults(), response.getMaxResults(), newToken);

                // Important for listShares because this is required by the lazy iterator between executions.
                segmentedRequest.setToken(resSegment.getContinuationToken());
                return resSegment;
            }
        };

        return getRequest;
    }

    Retrieves the current FileServiceProperties for the given storage service. This encapsulates the CORS configurations. 
Throws: StorageException – 
            If a storage service error occurred.
Returns: A FileServiceProperties object representing the current configuration of the service./**
     * Retrieves the current {@link FileServiceProperties} for the given storage service. This encapsulates
     * the CORS configurations.
     * 
     * @return A {@link FileServiceProperties} object representing the current configuration of the service.
     * 
     * @throws StorageException
     *             If a storage service error occurred.
     */
    @DoesServiceRequest
    public final FileServiceProperties downloadServiceProperties() throws StorageException {
        return this.downloadServiceProperties(null /* options */, null /* opContext */);
    }

    Retrieves the current FileServiceProperties for the given storage service. This encapsulates the CORS configurations. 
Params: options –  A FileRequestOptions object that specifies any additional options for the request. Specifying null will use the default request options from the associated service client (CloudFileClient).
opContext –  An OperationContext object that represents the context for the current operation. This object is used to track requests to the storage service, and to provide additional runtime information about the operation.
Throws: StorageException – 
            If a storage service error occurred.
Returns: A FileServiceProperties object representing the current configuration of the service./**
     * Retrieves the current {@link FileServiceProperties} for the given storage service. This encapsulates
     * the CORS configurations.
     * 
     * @param options
     *            A {@link FileRequestOptions} object that specifies any additional options for the request. Specifying
     *            <code>null</code> will use the default request options from the associated service client
     *            ({@link CloudFileClient}).
     * @param opContext
     *            An {@link OperationContext} object that represents the context for the current operation. This object
     *            is used to track requests to the storage service, and to provide additional runtime information about
     *            the operation.
     * 
     * @return A {@link FileServiceProperties} object representing the current configuration of the service.
     * 
     * @throws StorageException
     *             If a storage service error occurred.
     */
    @DoesServiceRequest
    public final FileServiceProperties downloadServiceProperties(FileRequestOptions options, OperationContext opContext)
            throws StorageException {
        if (opContext == null) {
            opContext = new OperationContext();
        }

        opContext.initialize();
        options = FileRequestOptions.populateAndApplyDefaults(options, this);

        return new FileServiceProperties(ExecutionEngine.executeWithRetry(
                this, null, this.downloadServicePropertiesImpl(options, false),
                options.getRetryPolicyFactory(), opContext));
    }

    Uploads a new FileServiceProperties configuration to the given storage service. This encapsulates the CORS configurations. 
Params: properties –  A FileServiceProperties object which specifies the service properties to upload.
Throws: StorageException – 
            If a storage service error occurred./**
     * Uploads a new {@link FileServiceProperties} configuration to the given storage service. This encapsulates
     * the CORS configurations.
     * 
     * @param properties
     *            A {@link FileServiceProperties} object which specifies the service properties to upload.
     * 
     * @throws StorageException
     *             If a storage service error occurred.
     */
    @DoesServiceRequest
    public void uploadServiceProperties(final FileServiceProperties properties) throws StorageException {
        this.uploadServiceProperties(properties, null /* options */, null /* opContext */);
    }

    Uploads a new FileServiceProperties configuration to the given storage service. This encapsulates the CORS configurations. 
Params: properties –  A FileServiceProperties object which specifies the service properties to upload.
options –  A FileRequestOptions object that specifies any additional options for the request. Specifying null will use the default request options from the associated service client (CloudFileClient).
opContext –  An OperationContext object that represents the context for the current operation. This object is used to track requests to the storage service, and to provide additional runtime information about the operation.
Throws: StorageException – 
            If a storage service error occurred./**
     * Uploads a new {@link FileServiceProperties} configuration to the given storage service. This encapsulates
     * the CORS configurations.
     * 
     * @param properties
     *            A {@link FileServiceProperties} object which specifies the service properties to upload.
     * @param options
     *            A {@link FileRequestOptions} object that specifies any additional options for the request. Specifying
     *            <code>null</code> will use the default request options from the associated service client
     *            ({@link CloudFileClient}).
     * @param opContext
     *            An {@link OperationContext} object that represents the context for the current operation. This object
     *            is used to track requests to the storage service, and to provide additional runtime information about
     *            the operation.
     * 
     * @throws StorageException
     *             If a storage service error occurred.
     */
    @DoesServiceRequest
    public void uploadServiceProperties(final FileServiceProperties properties, FileRequestOptions options,
            OperationContext opContext) throws StorageException {
        if (opContext == null) {
            opContext = new OperationContext();
        }

        opContext.initialize();
        options = FileRequestOptions.populateAndApplyDefaults(options, this);

        Utility.assertNotNull("properties", properties);

        ExecutionEngine.executeWithRetry(this, null,
                this.uploadServicePropertiesImpl(properties.getServiceProperties(), options, opContext, false),
                options.getRetryPolicyFactory(), opContext);
    }
    
    Gets the FileRequestOptions that is used for requests associated with this CloudFileClient
Returns: The FileRequestOptions object containing the values used by this CloudFileClient/**
     * Gets the {@link FileRequestOptions} that is used for requests associated with this <code>CloudFileClient</code>
     * 
     * @return The {@link FileRequestOptions} object containing the values used by this <code>CloudFileClient</code>
     */
    @Override
    public FileRequestOptions getDefaultRequestOptions() {
        return this.defaultRequestOptions;
    }

    Sets the FileRequestOptions that is used for any requests associated with this CloudFileClient object.
Params: defaultRequestOptions –  A FileRequestOptions object which specifies the options to use./**
     * Sets the {@link FileRequestOptions} that is used for any requests associated with this
     * <code>CloudFileClient</code> object.
     * 
     * @param defaultRequestOptions
     *            A {@link FileRequestOptions} object which specifies the options to use.
     */
    public void setDefaultRequestOptions(FileRequestOptions defaultRequestOptions) {
        Utility.assertNotNull("defaultRequestOptions", defaultRequestOptions);
        this.defaultRequestOptions = defaultRequestOptions;
    }
    
    Indicates whether path-style URIs are being used.
Returns: true if using path-style URIs; otherwise, false./**
     * Indicates whether path-style URIs are being used.
     * 
     * @return <code>true</code> if using path-style URIs; otherwise, <code>false</code>.
     */
    @Override
    protected boolean isUsePathStyleUris() {
        return super.isUsePathStyleUris();
    }
}
Params:	shareName – The name of the share, which must adhere to share naming rules. The share name should not include any path separator characters (/). Share names must be lowercase, between 3-63 characters long and must start with a letter or number. Share names may contain only letters, numbers, and the dash (-) character.
Throws:	StorageException – URISyntaxException –
See Also:	Naming and Referencing Shares, * Directories, Files, and Metadata
Returns:	A reference to a `CloudFileShare` object.
Params:	prefix – A `String` that represents the share name prefix.
Returns:	An enumerable collection of `CloudFileShare` objects retrieved lazily that represent the shares for this client whose names begin with the specified prefix.
Throws:	StorageException – If a storage service error occurred.
Returns:	A `ResultSegment` object that contains a segment of the enumerable collection of `CloudFileShare` objects that represent the shares for this client.
Params:	options – A `FileRequestOptions` object that specifies any additional options for the request. Specifying `null` will use the default request options from the associated service client (`CloudFileClient`). opContext – An `OperationContext` object that represents the context for the current operation. This object is used to track requests to the storage service, and to provide additional runtime information about the operation.
Throws:	StorageException – If a storage service error occurred.
Returns:	A `FileServiceProperties` object representing the current configuration of the service.
Params:	properties – A `FileServiceProperties` object which specifies the service properties to upload.
Throws:	StorageException – If a storage service error occurred.
/

com.microsoft.azure/ azure-storage/ 8.6.6/ com/microsoft/azure/storage/file/CloudFileClient.java
