Package org.jobrunr.dashboard

Class JobRunrDashboardWebServerConfiguration

java.lang.Object
org.jobrunr.dashboard.JobRunrDashboardWebServerConfiguration
public class JobRunrDashboardWebServerConfiguration extends Object
This class allows to configure the JobRunrDashboard

  • Method Details

    • usingStandardDashboardConfiguration

      public static JobRunrDashboardWebServerConfiguration usingStandardDashboardConfiguration()
      This returns the default configuration with the JobRunrDashboard running on port 8000
      Returns:
      the default JobRunrDashboard configuration

    • andPort

      public JobRunrDashboardWebServerConfiguration andPort(int port)
      Specifies the port on which the JobRunrDashboard will run
      Parameters:
      port - the port on which the JobRunrDashboard will run
      Returns:
      the same configuration instance which provides a fluent api

    • andBasicAuthentication

      public JobRunrDashboardWebServerConfiguration andBasicAuthentication(String username, String password)
      Adds basic authentication to the dashboard using the provided username and password. WARNING the password will be stored in clear text and if you are using http, it can be easily intercepted.
      Parameters:
      username - the login which the JobRunrDashboard will ask
      password - the password which the JobRunrDashboard will ask
      Returns:
      the same configuration instance which provides a fluent api

    • andAllowAnonymousDataUsage

      public JobRunrDashboardWebServerConfiguration andAllowAnonymousDataUsage(boolean allowAnonymousDataUsage)
      Allows to opt-out of anonymous usage statistics. This setting is true by default and sends only the total amount of succeeded jobs processed by your cluster per day to show a counter on the JobRunr website for marketing purposes.
      Returns:
      the same configuration instance which provides a fluent api