Package com.azure.storage.file.share

Class ShareFileClientBuilder

  • public class ShareFileClientBuilder
extends Object
    This class provides a fluent builder API to help aid the configuration and instantiation of the FileClients, FileAsyncClients, DirectoryClients, and DirectoryAsyncClients. Calling buildFileClient, buildFileAsyncClient, buildDirectoryClient, or buildDirectoryAsyncClient constructs an instance of ShareFileClient, ShareFileAsyncClient, ShareDirectoryClient, or ShareDirectoryAsyncClient respectively.

    The client needs the endpoint of the Azure Storage File service, name of the share, and authorization credential. endpoint gives the builder the endpoint and may give the builder the shareName(String), resourcePath(String) and a SAS token that authorizes the client.

    Instantiating a synchronous File Client with SAS token

     ShareFileClient fileClient = new ShareFileClientBuilder()
     .endpoint("https://${accountName}.file.core.windows.net?${SASToken}")
     .shareName("myshare")
     .resourcePath("myfilepath")
     .buildFileClient();

    Instantiating an Asynchronous File Client with SAS token

     ShareDirectoryClient shareDirectoryClient = new ShareFileClientBuilder()
     .endpoint("https://${accountName}.file.core.windows.net?${SASToken}")
     .shareName("myshare")
     .resourcePath("mydirectory")
     .buildDirectoryClient();

    If the endpoint doesn't contain the query parameters to construct a SAS token it may be set using sasToken.

     ShareFileClient fileClient = new ShareFileClientBuilder()
     .endpoint("https://${accountName}.file.core.windows.net")
     .sasToken("${SASTokenQueryParams}")
     .shareName("myshare")
     .resourcePath("myfilepath")
     .buildFileClient();
 
     ShareFileAsyncClient shareFileAsyncClient = new ShareFileClientBuilder()
     .endpoint("https://{accountName}.file.core.windows.net")
     .sasToken("${SASTokenQueryParams}")
     .shareName("myshare")
     .resourcePath("myfilepath")
     .buildFileAsyncClient();

    Another way to authenticate the client is using a StorageSharedKeyCredential. To create a StorageSharedKeyCredential a connection string from the Storage File service must be used. Set the StorageSharedKeyCredential with connectionString. If the builder has both a SAS token and StorageSharedKeyCredential the StorageSharedKeyCredential will be preferred when authorizing requests sent to the service.

    Instantiating a synchronous File Client with connection string.

     String connectionString = "DefaultEndpointsProtocol=https;AccountName={name};AccountKey={key}"
     + ";EndpointSuffix={core.windows.net}";
 ShareDirectoryClient shareDirectoryClient = new ShareFileClientBuilder()
     .connectionString(connectionString)
     .shareName("myshare")
     .resourcePath("mydirectory")
     .buildDirectoryClient();

    Instantiating an Asynchronous File Client with connection string.

     String connectionString = "DefaultEndpointsProtocol=https;AccountName={name};AccountKey={key};"
     + "EndpointSuffix={core.windows.net}";
 ShareDirectoryAsyncClient shareDirectoryAsyncClient = new ShareFileClientBuilder()
     .connectionString(connectionString).shareName("myshare").resourcePath("mydirectory")
     .buildDirectoryAsyncClient();
    See Also:
    ShareFileClient, ShareFileAsyncClient, StorageSharedKeyCredential

    • Constructor Detail

      • ShareFileClientBuilder

        public ShareFileClientBuilder()
        Creates a builder instance that is able to configure and construct FileClients and FileAsyncClients.

    • Method Detail

      • endpoint

        public ShareFileClientBuilder endpoint​(String endpoint)
        Sets the endpoint for the Azure Storage File instance that the client will interact with.

        The first path segment, if the endpoint contains path segments, will be assumed to be the name of the share that the client will interact with. Rest of the path segments should be the path of the file. It mush end up with the file name if more segments exist.

        Query parameters of the endpoint will be parsed in an attempt to generate a SAS token to authenticate requests sent to the service.

        Parameters:
        endpoint - The URL of the Azure Storage File instance to send service requests to and receive responses from.
        Returns:
        the updated ShareFileClientBuilder object
        Throws:
        IllegalArgumentException - If endpoint is null or is an invalid URL

      • shareName

        public ShareFileClientBuilder shareName​(String shareName)
        Sets the share that the constructed clients will interact with
        Parameters:
        shareName - Name of the share
        Returns:
        the updated ShareFileClientBuilder object
        Throws:
        NullPointerException - If shareName is null.

      • snapshot

        public ShareFileClientBuilder snapshot​(String snapshot)
        Sets the shareSnapshot that the constructed clients will interact with. This shareSnapshot must be linked to the share that has been specified in the builder.
        Parameters:
        snapshot - Identifier of the shareSnapshot
        Returns:
        the updated ShareFileClientBuilder object
        Throws:
        NullPointerException - If shareSnapshot is null.

      • resourcePath

        public ShareFileClientBuilder resourcePath​(String resourcePath)
        Sets the file that the constructed clients will interact with
        Parameters:
        resourcePath - Path of the file (or directory).
        Returns:
        the updated ShareFileClientBuilder object
        Throws:
        NullPointerException - If resourcePath is null.

      • sasToken

        public ShareFileClientBuilder sasToken​(String sasToken)
        Sets the SAS token used to authorize requests sent to the service.
        Parameters:
        sasToken - The SAS token to use for authenticating requests. This string should only be the query parameters (with or without a leading '?') and not a full url.
        Returns:
        the updated ShareFileClientBuilder
        Throws:
        NullPointerException - If sasToken is null.

      • credential

        public ShareFileClientBuilder credential​(com.azure.core.credential.AzureSasCredential credential)
        Sets the AzureSasCredential used to authorize requests sent to the service.
        Parameters:
        credential - AzureSasCredential used to authorize requests sent to the service.
        Returns:
        the updated ShareFileClientBuilder
        Throws:
        NullPointerException - If credential is null.

      • connectionString

        public ShareFileClientBuilder connectionString​(String connectionString)
        Sets the connection string to connect to the service.
        Parameters:
        connectionString - Connection string of the storage account.
        Returns:
        the updated ShareFileClientBuilder
        Throws:
        IllegalArgumentException - If connectionString in invalid.

      • httpClient

        public ShareFileClientBuilder httpClient​(com.azure.core.http.HttpClient httpClient)
        Sets the HttpClient to use for sending a receiving requests to and from the service.
        Parameters:
        httpClient - HttpClient to use for requests.
        Returns:
        the updated ShareFileClientBuilder object

      • addPolicy

        public ShareFileClientBuilder addPolicy​(com.azure.core.http.policy.HttpPipelinePolicy pipelinePolicy)
        Adds a pipeline policy to apply on each request sent. The policy will be added after the retry policy. If the method is called multiple times, all policies will be added and their order preserved.
        Parameters:
        pipelinePolicy - a pipeline policy
        Returns:
        the updated ShareFileClientBuilder object
        Throws:
        NullPointerException - If pipelinePolicy is null.

      • httpLogOptions

        public ShareFileClientBuilder httpLogOptions​(com.azure.core.http.policy.HttpLogOptions logOptions)
        Sets the HttpLogOptions for service requests.
        Parameters:
        logOptions - The logging configuration to use when sending and receiving HTTP requests/responses.
        Returns:
        the updated ShareFileClientBuilder object
        Throws:
        NullPointerException - If logOptions is null.

      • getDefaultHttpLogOptions

        public static com.azure.core.http.policy.HttpLogOptions getDefaultHttpLogOptions()
        Gets the default log options with Storage headers and query parameters.
        Returns:
        the default log options.

      • configuration

        public ShareFileClientBuilder configuration​(com.azure.core.util.Configuration configuration)
        Sets the configuration object used to retrieve environment configuration values during building of the client.
        Parameters:
        configuration - Configuration store used to retrieve environment configurations.
        Returns:
        the updated ShareFileClientBuilder object

      • pipeline

        public ShareFileClientBuilder pipeline​(com.azure.core.http.HttpPipeline httpPipeline)
        Sets the HttpPipeline to use for the service client. If pipeline is set, all other settings are ignored, aside from endpoint.
        Parameters:
        httpPipeline - HttpPipeline to use for sending service requests and receiving responses.
        Returns:
        the updated ShareFileClientBuilder object

      • clientOptions

        public ShareFileClientBuilder clientOptions​(com.azure.core.util.ClientOptions clientOptions)
        Sets the client options for all the requests made through the client.
        Parameters:
        clientOptions - ClientOptions.
        Returns:
        the updated ShareFileClientBuilder object
        Throws:
        NullPointerException - If clientOptions is null.

      • serviceVersion

        public ShareFileClientBuilder serviceVersion​(ShareServiceVersion version)
        Sets the ShareServiceVersion that is used when making API requests.

        If a service version is not provided, the service version that will be used will be the latest known service version based on the version of the client library being used. If no service version is specified, updating to a newer version of the client library will have the result of potentially moving to a newer service version.

        Targeting a specific service version may also mean that the service will return an error for newer APIs.

        Parameters:
        version - ShareServiceVersion of the service to be used when making requests.
        Returns:
        the updated ShareFileClientBuilder object