CarrotDashboardWebServerConfiguration (Carrot Task Queue 2.0.2 API)

java.lang.Object
- cn.boboweike.carrot.dashboard.CarrotDashboardWebServerConfiguration

public class CarrotDashboardWebServerConfiguration
extends Object

This class allows to configure the CarrotDashboard

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`CarrotDashboardWebServerConfiguration`	`andBasicAuthentication(String username, String password)`	Adds basic authentication to the dashboard using the provided username and password.
`CarrotDashboardWebServerConfiguration`	`andPort(int port)`	Specifies the port on which the CarrotDashboard will run
`static CarrotDashboardWebServerConfiguration`	`usingStandardDashboardConfiguration()`	This returns the default configuration with the CarrotDashboard running on port 8000

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - usingStandardDashboardConfiguration
```
public static CarrotDashboardWebServerConfiguration usingStandardDashboardConfiguration()
```
    This returns the default configuration with the CarrotDashboard running on port 8000
    
    Returns:
    
    the default CarrotDashboard configuration
  - andPort
```
public CarrotDashboardWebServerConfiguration andPort(int port)
```
    Specifies the port on which the CarrotDashboard will run
    
    Parameters:
    
    port - the port on which the CarrotDashboard will run
    
    Returns:
    
    the same configuration instance which provides a fluent api
  - andBasicAuthentication
```
public CarrotDashboardWebServerConfiguration 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 CarrotDashboard will ask
    
    password - the password which the CarrotDashboard will ask
    
    Returns:
    
    the same configuration instance which provides a fluent api