Package io.revealbi.core.data

Class RVRESTDataSource

java.lang.Object
io.revealbi.core.data.RVDashboardDataSource
io.revealbi.core.data.RVRESTDataSource
public class RVRESTDataSource extends RVDashboardDataSource
REST API data source, configures the URL to get data from, HTTP method to use and optionally headers and body to send in the request.

  • Field Details

  • Constructor Details

    • RVRESTDataSource

      public RVRESTDataSource()

  • Method Details

    • setUrl

      public String setUrl(String value)
      URL to the web resource, is expected to be a URL with HTTP or HTTPS scheme. Parameters might be specified using the notation {parameterName}, for example: http://server/customers/{CustomerID} defines a "CustomerID" parameter that must be included in the RVRESTDataSourceItem.getParameters() property of RVRESTDataSourceItem.
      Parameters:
      value -
      Returns:

    • getUrl

      public String getUrl()
      URL to the web resource, is expected to be a URL with HTTP or HTTPS scheme. Parameters might be specified using the notation {parameterName}, for example: http://server/customers/{CustomerID} defines a "CustomerID" parameter that must be included in the RVRESTDataSourceItem.getParameters() property of RVRESTDataSourceItem.
      Returns:

    • setUseAnonymousAuthentication

      public boolean setUseAnonymousAuthentication(boolean value)
      Boolean flag indicating if anonymous authentication should be used for this data source or credentials must be requested to the containing application.
      Parameters:
      value -
      Returns:

    • getUseAnonymousAuthentication

      public boolean getUseAnonymousAuthentication()
      Boolean flag indicating if anonymous authentication should be used for this data source or credentials must be requested to the containing application.
      Returns:

    • setMethod

      public String setMethod(String value)
      HTTP method to use, it defaults to GET.
      Parameters:
      value -
      Returns:

    • getMethod

      public String getMethod()
      HTTP method to use, it defaults to GET.
      Returns:

    • setContentType

      public String setContentType(String value)
      Content type of the body, only used when getBody() is not empty.
      Parameters:
      value -
      Returns:

    • getContentType

      public String getContentType()
      Content type of the body, only used when getBody() is not empty.
      Returns:

    • setBody

      public String setBody(String value)
      Body to send, expected to be used only with POST and PUT methods.
      Parameters:
      value -
      Returns:

    • getBody

      public String getBody()
      Body to send, expected to be used only with POST and PUT methods.
      Returns:

    • setHeaders

      public ArrayList<String> setHeaders(ArrayList<String> value)
      List of headers to send in the request, each string in this list is expected to be a string in the format name=value.
      Parameters:
      value -
      Returns:

    • getHeaders

      public ArrayList<String> getHeaders()
      List of headers to send in the request, each string in this list is expected to be a string in the format name=value.
      Returns:

    • setUsePreemptiveAuthentication

      public boolean setUsePreemptiveAuthentication(boolean value)
      Boolean flag indicating if preemptive authentication should be used for this data source to the containing application.
      Parameters:
      value -
      Returns:

    • getUsePreemptiveAuthentication

      public boolean getUsePreemptiveAuthentication()
      Boolean flag indicating if preemptive authentication should be used for this data source to the containing application.
      Returns:

    • getProviderKey

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