Package com.azure.storage.file.share

Class ShareServiceClientBuilder

java.lang.Object
com.azure.storage.file.share.ShareServiceClientBuilder
All Implemented Interfaces:
com.azure.core.client.traits.AzureNamedKeyCredentialTrait<ShareServiceClientBuilder>, com.azure.core.client.traits.AzureSasCredentialTrait<ShareServiceClientBuilder>, com.azure.core.client.traits.ConfigurationTrait<ShareServiceClientBuilder>, com.azure.core.client.traits.ConnectionStringTrait<ShareServiceClientBuilder>, com.azure.core.client.traits.EndpointTrait<ShareServiceClientBuilder>, com.azure.core.client.traits.HttpTrait<ShareServiceClientBuilder>, com.azure.core.client.traits.TokenCredentialTrait<ShareServiceClientBuilder>
public final class ShareServiceClientBuilder extends Object implements com.azure.core.client.traits.TokenCredentialTrait<ShareServiceClientBuilder>, com.azure.core.client.traits.HttpTrait<ShareServiceClientBuilder>, com.azure.core.client.traits.ConnectionStringTrait<ShareServiceClientBuilder>, com.azure.core.client.traits.AzureNamedKeyCredentialTrait<ShareServiceClientBuilder>, com.azure.core.client.traits.AzureSasCredentialTrait<ShareServiceClientBuilder>, com.azure.core.client.traits.ConfigurationTrait<ShareServiceClientBuilder>, com.azure.core.client.traits.EndpointTrait<ShareServiceClientBuilder>
This class provides a fluent builder API to help aid the configuration and instantiation of the FileServiceClients and FileServiceAsyncClients, calling buildClient constructs an instance of ShareServiceClient and calling buildFileAsyncClient constructs an instance of ShareServiceAsyncClient.

The client needs the endpoint of the Azure Storage File service and authorization credential. endpoint gives the builder the endpoint and may give the builder a SAS token that authorizes the client.

Instantiating a synchronous FileService Client with SAS token

 ShareServiceClient fileServiceClient = new ShareServiceClientBuilder()
     .endpoint("https://${accountName}.file.core.windows.net?${SASToken}")
     .buildClient();

Instantiating an Asynchronous FileService Client with SAS token

 ShareServiceAsyncClient fileServiceAsyncClient = new ShareServiceClientBuilder()
     .endpoint("https://{accountName}.file.core.windows.net?{SASToken}")
     .buildAsyncClient();

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

 ShareServiceClient fileServiceClient = new ShareServiceClientBuilder()
     .endpoint("https://{accountName}.file.core.windows.net")
     .sasToken("${SASTokenQueryParams}")
     .buildClient();
 
 ShareServiceAsyncClient fileServiceAsyncClient = new ShareServiceClientBuilder()
     .endpoint("https://{accountName}.file.core.windows.net")
     .sasToken("${SASTokenQueryParams}")
     .buildAsyncClient();

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 FileService Client with connection string.

 String connectionString = "DefaultEndpointsProtocol=https;AccountName={name};AccountKey={key};"
     + "EndpointSuffix={core.windows.net}";
 ShareServiceClient fileServiceClient = new ShareServiceClientBuilder()
     .connectionString(connectionString)
     .buildClient();

Instantiating an Asynchronous FileService Client with connection string. 

 String connectionString = "DefaultEndpointsProtocol=https;AccountName={name};AccountKey={key};"
     + "EndpointSuffix={core.windows.net}";
 ShareServiceAsyncClient fileServiceAsyncClient = new ShareServiceClientBuilder()
     .connectionString(connectionString)
     .buildAsyncClient();
See Also:

  • Constructor Details

  • Method Details

    • buildAsyncClient

      public ShareServiceAsyncClient buildAsyncClient()
      Creates a ShareServiceAsyncClient based on options set in the builder. Every time this method is called a new instance of ShareServiceAsyncClient is created.

      If pipeline is set, then the pipeline and endpoint are used to create the client. All other builder settings are ignored.

      Returns:
      A ShareServiceAsyncClient with the options set from the builder.
      Throws:
      IllegalArgumentException - If neither a StorageSharedKeyCredential or SAS token has been set.
      IllegalStateException - If multiple credentials have been specified.
      IllegalStateException - If both retryOptions(RetryOptions) and retryOptions(RequestRetryOptions) have been set.

    • buildClient

      public ShareServiceClient buildClient()
      Creates a ShareServiceClient based on options set in the builder. Every time buildClient() is called a new instance of ShareServiceClient is created.

      If pipeline is set, then the pipeline and endpoint are used to create the client. All other builder settings are ignored.

      Returns:
      A ShareServiceClient with the options set from the builder.
      Throws:
      NullPointerException - If endpoint is null.
      IllegalArgumentException - If neither a StorageSharedKeyCredential or SAS token has been set.
      IllegalStateException - If multiple credentials have been specified.
      IllegalStateException - If both retryOptions(RetryOptions) and retryOptions(RequestRetryOptions) have been set.

    • endpoint

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

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

      Specified by:
      endpoint in interface com.azure.core.client.traits.EndpointTrait<ShareServiceClientBuilder>
      Parameters:
      endpoint - The URL of the Azure Storage File instance to send service requests to and receive responses from.
      Returns:
      the updated ShareServiceClientBuilder object
      Throws:
      IllegalArgumentException - If endpoint isn't a proper URL

    • credential

      public ShareServiceClientBuilder credential(StorageSharedKeyCredential credential)
      Sets the StorageSharedKeyCredential used to authorize requests sent to the service.
      Parameters:
      credential - StorageSharedKeyCredential.
      Returns:
      the updated ShareServiceClientBuilder
      Throws:
      NullPointerException - If credential is null.

    • credential

      public ShareServiceClientBuilder credential(com.azure.core.credential.AzureNamedKeyCredential credential)
      Sets the AzureNamedKeyCredential used to authorize requests sent to the service.
      Specified by:
      credential in interface com.azure.core.client.traits.AzureNamedKeyCredentialTrait<ShareServiceClientBuilder>
      Parameters:
      credential - AzureNamedKeyCredential.
      Returns:
      the updated ShareServiceClientBuilder
      Throws:
      NullPointerException - If credential is null.

    • credential

      public ShareServiceClientBuilder credential(com.azure.core.credential.TokenCredential tokenCredential)
      Sets the TokenCredential used to authorize requests sent to the service. Refer to the Azure SDK for Java identity and authentication documentation for more details on proper usage of the TokenCredential type. Note: only Share-level operations that TokenCredential is compatible with are ShareClient.createPermission(String) and ShareClient.getPermission(String)
      Specified by:
      credential in interface com.azure.core.client.traits.TokenCredentialTrait<ShareServiceClientBuilder>
      Parameters:
      tokenCredential - TokenCredential used to authorize requests sent to the service.
      Returns:
      the updated ShareServiceClientBuilder
      Throws:
      NullPointerException - If credential is null.

    • sasToken

      public ShareServiceClientBuilder 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 ShareServiceClientBuilder
      Throws:
      NullPointerException - If sasToken is null.

    • credential

      public ShareServiceClientBuilder credential(com.azure.core.credential.AzureSasCredential credential)
      Sets the AzureSasCredential used to authorize requests sent to the service.
      Specified by:
      credential in interface com.azure.core.client.traits.AzureSasCredentialTrait<ShareServiceClientBuilder>
      Parameters:
      credential - AzureSasCredential used to authorize requests sent to the service.
      Returns:
      the updated ShareServiceClientBuilder
      Throws:
      NullPointerException - If credential is null.

    • connectionString

      public ShareServiceClientBuilder connectionString(String connectionString)
      Sets the connection string to connect to the service.
      Specified by:
      connectionString in interface com.azure.core.client.traits.ConnectionStringTrait<ShareServiceClientBuilder>
      Parameters:
      connectionString - Connection string of the storage account.
      Returns:
      the updated ShareServiceClientBuilder
      Throws:
      IllegalArgumentException - If connectionString is invalid.

    • httpClient

      public ShareServiceClientBuilder httpClient(com.azure.core.http.HttpClient httpClient)
      Sets the HttpClient to use for sending and receiving requests to and from the service.

      Note: It is important to understand the precedence order of the HttpTrait APIs. In particular, if a HttpPipeline is specified, this takes precedence over all other APIs in the trait, and they will be ignored. If no HttpPipeline is specified, a HTTP pipeline will be constructed internally based on the settings provided to this trait. Additionally, there may be other APIs in types that implement this trait that are also ignored if an HttpPipeline is specified, so please be sure to refer to the documentation of types that implement this trait to understand the full set of implications.

      Specified by:
      httpClient in interface com.azure.core.client.traits.HttpTrait<ShareServiceClientBuilder>
      Parameters:
      httpClient - The HttpClient to use for requests.
      Returns:
      the updated ShareServiceClientBuilder object

    • addPolicy

      public ShareServiceClientBuilder addPolicy(com.azure.core.http.policy.HttpPipelinePolicy pipelinePolicy)
      Adds a pipeline policy to apply on each request sent.

      Note: It is important to understand the precedence order of the HttpTrait APIs. In particular, if a HttpPipeline is specified, this takes precedence over all other APIs in the trait, and they will be ignored. If no HttpPipeline is specified, a HTTP pipeline will be constructed internally based on the settings provided to this trait. Additionally, there may be other APIs in types that implement this trait that are also ignored if an HttpPipeline is specified, so please be sure to refer to the documentation of types that implement this trait to understand the full set of implications.

      Specified by:
      addPolicy in interface com.azure.core.client.traits.HttpTrait<ShareServiceClientBuilder>
      Parameters:
      pipelinePolicy - A pipeline policy.
      Returns:
      the updated ShareServiceClientBuilder object
      Throws:
      NullPointerException - If pipelinePolicy is null.

    • httpLogOptions

      public ShareServiceClientBuilder httpLogOptions(com.azure.core.http.policy.HttpLogOptions logOptions)
      Sets the logging configuration to use when sending and receiving requests to and from the service. If a logLevel is not provided, default value of HttpLogDetailLevel.NONE is set.

      Note: It is important to understand the precedence order of the HttpTrait APIs. In particular, if a HttpPipeline is specified, this takes precedence over all other APIs in the trait, and they will be ignored. If no HttpPipeline is specified, a HTTP pipeline will be constructed internally based on the settings provided to this trait. Additionally, there may be other APIs in types that implement this trait that are also ignored if an HttpPipeline is specified, so please be sure to refer to the documentation of types that implement this trait to understand the full set of implications.

      Specified by:
      httpLogOptions in interface com.azure.core.client.traits.HttpTrait<ShareServiceClientBuilder>
      Parameters:
      logOptions - The logging configuration to use when sending and receiving requests to and from the service.
      Returns:
      the updated ShareServiceClientBuilder 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 ShareServiceClientBuilder configuration(com.azure.core.util.Configuration configuration)
      Sets the configuration object used to retrieve environment configuration values during building of the client.
      Specified by:
      configuration in interface com.azure.core.client.traits.ConfigurationTrait<ShareServiceClientBuilder>
      Parameters:
      configuration - Configuration store used to retrieve environment configurations.
      Returns:
      the updated ShareServiceClientBuilder object

    • retryOptions

      public ShareServiceClientBuilder retryOptions(RequestRetryOptions retryOptions)
      Sets the request retry options for all the requests made through the client. Setting this is mutually exclusive with using retryOptions(RetryOptions).
      Parameters:
      retryOptions - RequestRetryOptions.
      Returns:
      the updated ShareServiceClientBuilder object

    • retryOptions

      public ShareServiceClientBuilder retryOptions(com.azure.core.http.policy.RetryOptions retryOptions)
      Sets the RetryOptions for all the requests made through the client.

      Note: It is important to understand the precedence order of the HttpTrait APIs. In particular, if a HttpPipeline is specified, this takes precedence over all other APIs in the trait, and they will be ignored. If no HttpPipeline is specified, a HTTP pipeline will be constructed internally based on the settings provided to this trait. Additionally, there may be other APIs in types that implement this trait that are also ignored if an HttpPipeline is specified, so please be sure to refer to the documentation of types that implement this trait to understand the full set of implications.

      Setting this is mutually exclusive with using retryOptions(RequestRetryOptions). Consider using retryOptions(RequestRetryOptions) to also set storage specific options.

      Specified by:
      retryOptions in interface com.azure.core.client.traits.HttpTrait<ShareServiceClientBuilder>
      Parameters:
      retryOptions - The RetryOptions to use for all the requests made through the client.
      Returns:
      the updated ShareServiceClientBuilder object

    • pipeline

      public ShareServiceClientBuilder pipeline(com.azure.core.http.HttpPipeline httpPipeline)
      Sets the HttpPipeline to use for the service client.

      Note: It is important to understand the precedence order of the HttpTrait APIs. In particular, if a HttpPipeline is specified, this takes precedence over all other APIs in the trait, and they will be ignored. If no HttpPipeline is specified, a HTTP pipeline will be constructed internally based on the settings provided to this trait. Additionally, there may be other APIs in types that implement this trait that are also ignored if an HttpPipeline is specified, so please be sure to refer to the documentation of types that implement this trait to understand the full set of implications.

      The endpoint is not ignored when pipeline is set.

      Specified by:
      pipeline in interface com.azure.core.client.traits.HttpTrait<ShareServiceClientBuilder>
      Parameters:
      httpPipeline - HttpPipeline to use for sending service requests and receiving responses.
      Returns:
      the updated ShareServiceClientBuilder object

    • clientOptions

      public ShareServiceClientBuilder clientOptions(com.azure.core.util.ClientOptions clientOptions)
      Allows for setting common properties such as application ID, headers, proxy configuration, etc. Note that it is recommended that this method be called with an instance of the HttpClientOptions class (a subclass of the ClientOptions base class). The HttpClientOptions subclass provides more configuration options suitable for HTTP clients, which is applicable for any class that implements this HttpTrait interface.

      Note: It is important to understand the precedence order of the HttpTrait APIs. In particular, if a HttpPipeline is specified, this takes precedence over all other APIs in the trait, and they will be ignored. If no HttpPipeline is specified, a HTTP pipeline will be constructed internally based on the settings provided to this trait. Additionally, there may be other APIs in types that implement this trait that are also ignored if an HttpPipeline is specified, so please be sure to refer to the documentation of types that implement this trait to understand the full set of implications.

      Specified by:
      clientOptions in interface com.azure.core.client.traits.HttpTrait<ShareServiceClientBuilder>
      Parameters:
      clientOptions - A configured instance of HttpClientOptions.
      Returns:
      the updated ShareServiceClientBuilder object
      Throws:
      NullPointerException - If clientOptions is null.
      See Also:
      • HttpClientOptions

    • serviceVersion

      public ShareServiceClientBuilder 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 ShareServiceClientBuilder object

    • allowSourceTrailingDot

      public ShareServiceClientBuilder allowSourceTrailingDot(boolean allowSourceTrailingDot)
      Set the trailing dot property to specify whether trailing dot will be trimmed or not from the source URI. If set to true, trailing dot (.) will be allowed to suffix directory and file names. If false, the trailing dot will be trimmed. Supported by x-ms-version 2022-11-02 and above.
      Parameters:
      allowSourceTrailingDot - the allowSourceTrailingDot value.
      Returns:
      the updated ShareServiceClientBuilder object

    • allowTrailingDot

      public ShareServiceClientBuilder allowTrailingDot(boolean allowTrailingDot)
      Set the trailing dot property to specify whether trailing dot will be trimmed or not from the target URI. If set to true, trailing dot (.) will be allowed to suffix directory and file names. If false, the trailing dot will be trimmed. Supported by x-ms-version 2022-11-02 and above.
      Parameters:
      allowTrailingDot - the allowTrailingDot value.
      Returns:
      the updated ShareServiceClientBuilder object

    • shareTokenIntent

      public ShareServiceClientBuilder shareTokenIntent(ShareTokenIntent shareTokenIntent)
      Sets the ShareTokenIntent that specifies whether there is intent for a file to be backed up. This is currently required when using TokenCredential, and ignored for other forms of authentication.
      Parameters:
      shareTokenIntent - the ShareTokenIntent value.
      Returns:
      the updated ShareServiceClientBuilder object

    • audience

      public ShareServiceClientBuilder audience(ShareAudience audience)
      Sets the Audience to use for authentication with Azure Active Directory (AAD). The audience is not considered when using a shared key.
      Parameters:
      audience - ShareAudience to be used when requesting a token from Azure Active Directory (AAD).
      Returns:
      the updated ShareServiceClientBuilder object