Class RVAzureCosmosDBDataSource

java.lang.Object
io.revealbi.core.data.RVDashboardDataSource
io.revealbi.core.data.RVAzureCosmosDBDataSource
All Implemented Interfaces:
IProcessDataOnServerDataSource

public class RVAzureCosmosDBDataSource extends RVDashboardDataSource implements IProcessDataOnServerDataSource
Azure CosmosDB data source.
  • Field Details

  • Constructor Details

    • RVAzureCosmosDBDataSource

      public RVAzureCosmosDBDataSource()
  • Method Details

    • getAccountEndpoint

      public String getAccountEndpoint()
      Gets or sets the URI of the Azure CosmosDB account endpoint (e.g. https://myaccount.documents.azure.com:443/).
      Returns:
      the account endpoint URI
    • setAccountEndpoint

      public void setAccountEndpoint(String accountEndpoint)
      Gets or sets the URI of the Azure CosmosDB account endpoint (e.g. https://myaccount.documents.azure.com:443/).
      Parameters:
      accountEndpoint - the account endpoint URI
    • getApplicationRegion

      public String getApplicationRegion()
      Gets or sets the preferred Azure region for read and write operations. Leave null to use the account default.
      Returns:
      the preferred application region, or null to use the account default
    • setApplicationRegion

      public void setApplicationRegion(String applicationRegion)
      Gets or sets the preferred Azure region for read and write operations. Leave null to use the account default.
      Parameters:
      applicationRegion - the preferred application region
    • getConnectionMode

      public RVAzureCosmosDBConnectionMode getConnectionMode()
      Gets or sets the connection mode used to communicate with the CosmosDB service. Defaults to RVAzureCosmosDBConnectionMode.GATEWAY.
      Returns:
      the connection mode
    • setConnectionMode

      public void setConnectionMode(RVAzureCosmosDBConnectionMode connectionMode)
      Gets or sets the connection mode used to communicate with the CosmosDB service. Defaults to RVAzureCosmosDBConnectionMode.GATEWAY.
      Parameters:
      connectionMode - the connection mode
    • getAcceptAnyServerCertificate

      public boolean getAcceptAnyServerCertificate()
      When set to true, the HTTP client accepts any server certificate without validation. Useful in development or test environments with self-signed certificates. Do not use in production.
      Returns:
      true if any server certificate is accepted
    • setAcceptAnyServerCertificate

      public void setAcceptAnyServerCertificate(boolean acceptAnyServerCertificate)
      When set to true, the HTTP client accepts any server certificate without validation. Useful in development or test environments with self-signed certificates. Do not use in production.
      Parameters:
      acceptAnyServerCertificate - true to accept any server certificate
    • getDatabase

      public String getDatabase()
      Gets or sets the name of the database to connect to.
      Returns:
      the database name
    • setDatabase

      public void setDatabase(String database)
      Gets or sets the name of the database to connect to.
      Parameters:
      database - the database name
    • getProcessDataOnServerDefaultValue

      public boolean getProcessDataOnServerDefaultValue()
      Gets the default value for "Process Data on Server" option for this data source. The end user can still change the value, unless getProcessDataOnServerReadOnly() is true.
      Specified by:
      getProcessDataOnServerDefaultValue in interface IProcessDataOnServerDataSource
      Returns:
      the default value for the "Process Data on Server" option
    • setProcessDataOnServerDefaultValue

      public void setProcessDataOnServerDefaultValue(boolean processDataOnServerDefaultValue)
      Sets the default value for "Process Data on Server" option for this data source. The end user can still change the value, unless setProcessDataOnServerReadOnly(boolean) is true.
      Specified by:
      setProcessDataOnServerDefaultValue in interface IProcessDataOnServerDataSource
      Parameters:
      processDataOnServerDefaultValue - the default value
    • getProcessDataOnServerReadOnly

      public boolean getProcessDataOnServerReadOnly()
      When true, the user will not be allowed to change the value for "Process Data on Server" option and the default value will be used.
      Specified by:
      getProcessDataOnServerReadOnly in interface IProcessDataOnServerDataSource
      Returns:
      true if the option is read-only
    • setProcessDataOnServerReadOnly

      public void setProcessDataOnServerReadOnly(boolean processDataOnServerReadOnly)
      When set to true, the user will not be allowed to change the value for "Process Data on Server" option and the default value will be used.
      Specified by:
      setProcessDataOnServerReadOnly in interface IProcessDataOnServerDataSource
      Parameters:
      processDataOnServerReadOnly - true to make the option read-only
    • getProviderKey

      public String getProviderKey()
      Specified by:
      getProviderKey in class RVDashboardDataSource