Package com.azure.spring.cloud.autoconfigure.jms.properties

Class AzureServiceBusJmsProperties

java.lang.Object
com.azure.spring.cloud.autoconfigure.jms.properties.AzureServiceBusJmsProperties
All Implemented Interfaces:
com.azure.spring.cloud.core.properties.PasswordlessProperties, com.azure.spring.cloud.core.provider.authentication.TokenCredentialOptionsProvider, com.azure.spring.cloud.core.provider.AzureProfileOptionsProvider, org.springframework.beans.factory.InitializingBean
@ConfigurationProperties(prefix="spring.jms.servicebus") public class AzureServiceBusJmsProperties extends Object implements org.springframework.beans.factory.InitializingBean, com.azure.spring.cloud.core.properties.PasswordlessProperties
ConfigurationProperties for configuring Azure Service Bus JMS.

  • Field Details

  • Constructor Details

    • AzureServiceBusJmsProperties

      public AzureServiceBusJmsProperties()

  • Method Details

    • isEnabled

      public boolean isEnabled()
      Whether to enable Service Bus JMS autoconfiguration.
      Returns:
      Whether to enable Service Bus autoconfiguration

    • setEnabled

      public void setEnabled(boolean enabled)
      Set whether to enable Service Bus JMS autoconfiguation.
      Parameters:
      enabled - whether to enable Service Bus autoconfiguration.

    • getPool

      public org.springframework.boot.autoconfigure.jms.JmsPoolConnectionFactoryProperties getPool()
      The properties for a pooled connection factory.
      Returns:
      the properties for a pooled connection factory.

    • getConnectionString

      public String getConnectionString()
      Get the connection string to connect to a Service Bus namespace.
      Returns:
      the connection string to connect to a Service Bus namespace.

    • setConnectionString

      public void setConnectionString(String connectionString)
      Set the connection string to connect to a Service Bus namespace.
      Parameters:
      connectionString - the connection string to connect to a Service Bus namespace.

    • getTopicClientId

      public String getTopicClientId()
      Get the Service Bus topic client ID.
      Returns:
      the Service Bus topic client ID.

    • setTopicClientId

      public void setTopicClientId(String topicClientId)
      Set the Service Bus topic client ID.
      Parameters:
      topicClientId - the Service Bus topic client ID.

    • getPricingTier

      public String getPricingTier()
      Get the pricing tier for a Service Bus namespace.
      Returns:
      the pricing tier for a Service Bus namespace.

    • setPricingTier

      public void setPricingTier(String pricingTier)
      Set the pricing tier for a Service Bus namespace.
      Parameters:
      pricingTier - the pricing tier for a Service Bus namespace.

    • getIdleTimeout

      public Duration getIdleTimeout()
      Get the connection idle timeout duration.
      Returns:
      the connection idle timeout duration.

    • setIdleTimeout

      public void setIdleTimeout(Duration idleTimeout)
      Set the connection idle timeout duration.
      Parameters:
      idleTimeout - the connection idle timeout duration.

    • getListener

      public AzureServiceBusJmsProperties.Listener getListener()
      Get the listener related properties.
      Returns:
      the listener related properties.

    • getPrefetchPolicy

      public AzureServiceBusJmsProperties.PrefetchPolicy getPrefetchPolicy()
      Get the prefetch policy related properties.
      Returns:
      the prefetch policy related properties.

    • getNamespace

      public String getNamespace()
      Get the Service Bus namespace.
      Returns:
      the Service Bus namespace.

    • setNamespace

      public void setNamespace(String namespace)
      Set the Service Bus namespace.
      Parameters:
      namespace - the Service Bus namespace.

    • getScopes

      public String getScopes()
      Get the scopes required for the access token.
      Specified by:
      getScopes in interface com.azure.spring.cloud.core.properties.PasswordlessProperties
      Returns:
      scopes required for the access token

    • setScopes

      public void setScopes(String scopes)
      Set the scopes required for the access token.
      Specified by:
      setScopes in interface com.azure.spring.cloud.core.properties.PasswordlessProperties
      Parameters:
      scopes - the scopes required for the access token

    • isPasswordlessEnabled

      public boolean isPasswordlessEnabled()
      Whether to enable connections authenticating with Azure AD, default is false.
      Specified by:
      isPasswordlessEnabled in interface com.azure.spring.cloud.core.properties.PasswordlessProperties
      Returns:
      enable connections authenticating with Azure AD if true, otherwise false.

    • setPasswordlessEnabled

      public void setPasswordlessEnabled(boolean passwordlessEnabled)
      Set the value to enable/disable connections authenticating with Azure AD. If not set, by default the value is false.
      Specified by:
      setPasswordlessEnabled in interface com.azure.spring.cloud.core.properties.PasswordlessProperties
      Parameters:
      passwordlessEnabled - the passwordlessEnabled

    • getProfile

      public AzureProfileConfigurationProperties getProfile()
      Get the profile
      Specified by:
      getProfile in interface com.azure.spring.cloud.core.provider.AzureProfileOptionsProvider
      Returns:
      the profile

    • setProfile

      public void setProfile(AzureProfileConfigurationProperties profile)
      Set the profile
      Parameters:
      profile - the profile properties related to an Azure subscription

    • getCredential

      public TokenCredentialConfigurationProperties getCredential()
      Get the credential properties.
      Specified by:
      getCredential in interface com.azure.spring.cloud.core.provider.authentication.TokenCredentialOptionsProvider
      Returns:
      the credential properties.

    • setCredential

      public void setCredential(TokenCredentialConfigurationProperties credential)
      Set the credential properties.
      Parameters:
      credential - the credential properties

    • afterPropertiesSet

      public void afterPropertiesSet() throws Exception
      Validate spring.jms.servicebus related properties.
      Specified by:
      afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean
      Throws:
      IllegalArgumentException - If connectionString is empty.
      Exception