Share via

ClientSettings Class

  • Reference
Package:
com.microsoft.azure.servicebus
Maven Artifact:
com.microsoft.azure:azure-servicebus:3.6.7
  • java.lang.Object
    • com.microsoft.azure.servicebus.ClientSettings

public class ClientSettings

Class encapsulating common client level settings like TokenProvider, RetryPolicy, OperationTimeout.

Constructor Summary

Constructor Description
ClientSettings(TokenProvider tokenProvider)

Creates a new instance with the given token provider, default retry policy and default operation timeout.
ClientSettings(TokenProvider tokenProvider, RetryPolicy retryPolicy, Duration operationTimeout)

Creates a new instance with the given token provider, retry policy and operation timeout.
ClientSettings(TokenProvider tokenProvider, RetryPolicy retryPolicy, Duration operationTimeout, TransportType transportType)

Creates a new instance with the given token provider, retry policy and operation timeout.

Method Summary

Modifier and Type Method and Description
Duration getOperationTimeout()

Gets the operation timeout contained in this instance.
RetryPolicy getRetryPolicy()

Gets the retry policy contained in this instance.
TokenProvider getTokenProvider()

Gets the token provider contained in this instance.
TransportType getTransportType()

Gets the transport type for this instance

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

ClientSettings

public ClientSettings(TokenProvider tokenProvider)

Creates a new instance with the given token provider, default retry policy and default operation timeout.

Parameters:

tokenProvider - TokenProvider instance

ClientSettings

public ClientSettings(TokenProvider tokenProvider, RetryPolicy retryPolicy, Duration operationTimeout)

Creates a new instance with the given token provider, retry policy and operation timeout.

Parameters:

tokenProvider - TokenProvider instance
retryPolicy - RetryPolicy instance
operationTimeout - default operation timeout to be used for all client operations. Client can override this value by explicitly specifying a timeout in the operation.

ClientSettings

public ClientSettings(TokenProvider tokenProvider, RetryPolicy retryPolicy, Duration operationTimeout, TransportType transportType)

Creates a new instance with the given token provider, retry policy and operation timeout.

Parameters:

tokenProvider - TokenProvider instance
retryPolicy - RetryPolicy instance
operationTimeout - default operation timeout to be used for all client operations. Client can override this value by explicitly specifying a timeout in the operation.
transportType - TransportType instance

Method Details

getOperationTimeout

public Duration getOperationTimeout()

Gets the operation timeout contained in this instance.

Returns:

operation timeout contained in this instance

getRetryPolicy

public RetryPolicy getRetryPolicy()

Gets the retry policy contained in this instance.

Returns:

RetryPolicy contained in this instance

getTokenProvider

public TokenProvider getTokenProvider()

Gets the token provider contained in this instance.

Returns:

TokenProvider contained in this instance

getTransportType

public TransportType getTransportType()

Gets the transport type for this instance

Returns:

transport type for the instance

Applies to