XXL-JOB

https://github.com/xuxueli/xxl-job
Admin
XXL-JOB is a distributed task scheduling framework that enables quick development with a...
Tokens:86,678
Snippets:534
Trust Score:8.9
License:GPL-3.0
Update:3 weeks ago
Show doc for...
Tokens:
Raw
### start()

Source: https://github.com/xuxueli/xxl-job/blob/master/_autodocs/api-reference/xxl-job-executor.md

Boot sequence that initializes and starts all executor components. Throws RuntimeException if required configuration is missing.

```APIDOC
## start()

### Description
Boot sequence that initializes and starts all executor components. Throws RuntimeException if required configuration is missing.

### Method
public void start() throws Exception

### Behavior
1. If !enabled - log and return.
2. Validate: throws RuntimeException if adminAddresses, appname, or accessToken is blank (StringTool.isBlank).
3. Bind xxlJobExecutor = this (this is what makes getInstance() work).
4. XxlJobFileAppender.initLogPath(logPath).
5. initAdminBizList() - builds the AdminBiz HTTP proxy list (HttpTool.createClient().url(finalAddress).timeout(finalTimeout*1000).header(XXL-JOB-ACCESS-TOKEN,...).header(XXL-JOB-APPNAME,...).proxy(AdminBiz.class)).
6. Start JobLogFileCleanThreadHelper(logRetentionDays).
7. Start TriggerCallbackThreadHelper with this.
8. startEmbedServer() - fills ip/port/address, warns if accessToken is blank, starts EmbedServer.

### Throws
- Exception - if any step fails.
```

--------------------------------

### start

Source: https://github.com/xuxueli/xxl-job/blob/master/_autodocs/api-reference/xxl-job-service.md

Starts a job in the scheduler center.

```APIDOC
## start

### Description
Starts a job in the scheduler center.

### Method
Service method

### Signature
`Response<String> start(int id, LoginInfo loginInfo)`

### Parameters
- **id** (int) - Required - The ID of the job to start.
- **loginInfo** (LoginInfo) - Required - The login information of the user performing the operation. Null is treated as no login and results in permission failure.

### Response
Returns a `Response<String>` indicating success or failure.
```

--------------------------------

### Frameless Executor Setup with XxlJobSimpleExecutor

Source: https://github.com/xuxueli/xxl-job/blob/master/_autodocs/api-reference/xxl-job-executor.md

Directly configures an XxlJobSimpleExecutor without Spring, setting admin addresses, appname, access token, and a list of beans with @XxlJob methods. The start() method may throw an exception if admin addresses are empty, and destroy() must be called to clean up.

```java
XxlJobSimpleExecutor executor = new XxlJobSimpleExecutor();
executor.setAdminAddresses("http://127.0.0.1:8080");
executor.setAppname("my-app");
executor.setAccessToken("token");
executor.setXxlJobBeanList(List.of(new SampleXxlJob())); // @XxlJob methods are scanned
try {
    executor.start();
} catch (Exception e) {
    logger.error(e.getMessage(), e); // e.g. "xxl-job executor adminAddresses empty."
}
...
executor.destroy();
```

--------------------------------

### XxlJobSimpleExecutor Class Reference

Source: https://github.com/xuxueli/xxl-job/blob/master/_autodocs/api-reference/xxl-job-simple-executor.md

Documentation for the XxlJobSimpleExecutor class, including its public methods and usage examples for registering and starting job handlers without Spring.

```APIDOC
## XxlJobSimpleExecutor

### Description
Frameless executor implementation of `XxlJobExecutor` for applications that do not use Spring. It scans an explicitly provided list of "job beans" for methods annotated with `@XxlJob` and registers each as a `MethodJobHandler` before delegating to the base `start()`.

### Class Signature
```java
public class XxlJobSimpleExecutor extends XxlJobExecutor {
    private List<Object> xxlJobBeanList = new ArrayList<>();
    // ...
}
```

### Constructor
Implicit no-arg constructor (`super()`). No other constructors.

### Public Methods

#### `public List<Object> getXxlJobBeanList()`
Returns the bean list that will be scanned for `@XxlJob` methods on `start()`. Empty by default.

#### `public void setXxlJobBeanList(List<Object> xxlJobBeanList)`
Sets the beans to scan. Each bean class is inspected via `getDeclaredMethods()`; every method annotated with `@XxlJob` is registered through the protected `registryJobHandler(XxlJob, Object, Method)` (see [xxl-job-executor.md](xxl-job-executor.md) and [errors.md](../errors.md) for the `RuntimeException` conditions).

- Parameter: `xxlJobBeanList` — any plain objects; only the annotation matters, the bean itself becomes the invocation target of the `MethodJobHandler`.

#### `public void start()`
```java
@Override
public void start() {
    initJobHandlerMethodRepository(xxlJobBeanList);
    try {
        super.start();
    } catch (Exception e) {
        throw new RuntimeException(e);
    }
}
```
Scans `xxlJobBeanList` first, then runs the base boot sequence. Any checked exception from the base `start()` is re-wrapped in `RuntimeException`.

#### `public void destroy()`
```java
@Override
public void destroy() {
    super.destroy();
}
```
Delegates to the base graceful shutdown.

### Protected helper
`private void initJobHandlerMethodRepository(List<Object> xxlJobBeanList)` — internal scan: for each bean, iterates `bean.getClass().getDeclaredMethods()` and calls `registryJobHandler(executeMethod.getAnnotation(XxlJob.class), bean, executeMethod)`.

### Usage Examples

Frameless application bootstrap (essentially `XxlJobFramelessApplication` / `FrameLessXxlJobConfig` from the sample module):

```java
public class Main {
    public static void main(String[] args) {
        XxlJobSimpleExecutor executor = new XxlJobSimpleExecutor();
        executor.setAdminAddresses("http://127.0.0.1:8080");
        executor.setTimeout(3);
        executor.setEnabled(true);
        executor.setAppname("xxl-job-executor-sample");
        executor.setAccessToken("default_token");
        executor.setPort(9999);
        executor.setLogPath("/data/applogs/xxl-job/jobhandler");
        executor.setLogRetentionDays(30);
        executor.setGlueEnabled(true);
        executor.setXxlJobBeanList(List.of(new SampleXxlJob())); // @XxlJob annotated class

        try {
            executor.start();
        } catch (Exception e) {
            logger.error(e.getMessage(), e);
        }

        // block forever, then shutdown
        Runtime.getRuntime().addShutdownHook(executor::destroy);
    }
}
```

With a scan-failure (e.g. two beans both declare `@XxlJob("demoJobHandler")`):

```java
try {
    executor.setXxlJobBeanList(List.of(new BeanA(), new BeanB())); // BeanB also has @XxlJob("x")
    executor.start();
} catch (RuntimeException e) {
    // "xxl-job jobhandler[x] naming conflicts." — raised by XxlJobExecutor.registryJobHandler
    logger.error("scan failed", e);
}
```
```

--------------------------------

### XxlJobSimpleExecutor.start() override

Source: https://github.com/xuxueli/xxl-job/blob/master/_autodocs/api-reference/xxl-job-simple-executor.md

Overrides start() to scan the bean list first, then delegates to the base start(). Any checked exception is re-wrapped in RuntimeException.

```java
@Override
public void start() {
    initJobHandlerMethodRepository(xxlJobBeanList);
    try {
        super.start();
    } catch (Exception e) {
        throw new RuntimeException(e);
    }
}
```

--------------------------------

### GET /help

Source: https://github.com/xuxueli/xxl-job/blob/master/_autodocs/endpoints.md

Displays the help page. Requires login.

```APIDOC
## GET /help

### Description
Displays the help page.

### Method
GET

### Endpoint
/help

### Authentication
login

### Response
#### Success Response (200)
- Help page.
```

--------------------------------

### Add and start a job with system admin LoginInfo

Source: https://github.com/xuxueli/xxl-job/blob/master/_autodocs/api-reference/xxl-job-service.md

Used by web controllers; a plugin/embedding scenario calls it with a system admin LoginInfo (exactly what AdminJobBizImpl does). Creates an XxlJobInfo with CRON schedule, ROUND route, demoJobHandler, SERIAL_EXECUTION block strategy, and BEAN glue type. Adds the job and starts it if successful.

```java
LoginInfo systemLogin = new LoginInfo("0", "openapi", "OpenAPI", null, List.of("ADMIN"), null, -1L, null);

XxlJobInfo job = new XxlJobInfo();
job.setJobGroup(1);
job.setName("nightly report");
job.setScheduleType("CRON");
job.setScheduleConf("0 0 2 * * ? *");
job.setExecutorRouteStrategy("ROUND");
job.setExecutorHandler("demoJobHandler");
job.setExecutorBlockStrategy("SERIAL_EXECUTION");
job.setGlueType("BEAN");

Response<String> added = xxlJobService.add(job, systemLogin);
if (added.isSuccess()) {
    xxlJobService.start(job.getId(), systemLogin);
}
```

--------------------------------

### afterSingletonsInstantiated

Source: https://github.com/xuxueli/xxl-job/blob/master/_autodocs/api-reference/xxl-job-spring-executor.md

Starts the executor after all singletons are instantiated.

```APIDOC
## [METHOD] afterSingletonsInstantiated()

### Description
Lifecycle hook invoked by Spring after all singletons are created. It scans for @XxlJob methods, refreshes GlueFactory to the Spring variant, and starts the executor.

### Method
Lifecycle callback (SmartInitializingSingleton)

### Endpoint
N/A (Java method)

### Parameters
None

### Request Example
N/A (called by Spring)

### Response
#### Success Response
- Executor starts successfully.

#### Response Example
N/A

### Error Handling
- If start() fails, a RuntimeException is thrown.
```

--------------------------------

### POST /api/{uri} - startJob

Source: https://github.com/xuxueli/xxl-job/blob/master/_autodocs/api-reference/admin-biz.md

Starts a job by its ID.

```APIDOC
## [POST] /api/{uri} - startJob

### Description
Starts a job by its ID.

### Method
POST

### Endpoint
/api/{uri}

### Headers
- **XXL-JOB-ACCESS-TOKEN** (string) - Required - Access token of the XxlJobGroup whose appname matches XXL-JOB-APPNAME.
- **XXL-JOB-APPNAME** (string) - Required - Executor group appname.

### Request Body
- **JobOperateRequest** (object) - Required - Contains the job ID.
  - **id** (int) - Required - Job ID.

### Response
#### Success Response (200)
- **code** (int) - Response code.
- **msg** (string) - Response message.
- **content** (string) - null.

#### Error Response
- **code** (int) - Error code.
- **msg** (string) - Error message.
- **content** (string) - null.

```

--------------------------------

### getInstance()

Source: https://github.com/xuxueli/xxl-job/blob/master/_autodocs/api-reference/xxl-job-executor.md

Returns the bound executor singleton. Throws RuntimeException if start() has not been called.

```APIDOC
## getInstance()

### Description
Returns the bound executor singleton. Throws RuntimeException if start() has not been called.

### Method
public static XxlJobExecutor getInstance()

### Return
- XxlJobExecutor - the instance previously bound by start().

### Throws
- RuntimeException - ">>>>>>>>> xxl-job load executor instance fail, please initialize it." if start() has not yet been called.
```

--------------------------------

### GET /

Source: https://github.com/xuxueli/xxl-job/blob/master/_autodocs/endpoints.md

Displays the console index page with a menu list filtered by the user's role. Requires login.

```APIDOC
## GET /

### Description
Displays the console index page with a menu list filtered by the user's role.

### Method
GET

### Endpoint
/

### Authentication
login

### Response
#### Success Response (200)
- Console index page (menu list filtered by role).
```

--------------------------------

### Job bean with @XxlJob method

Source: https://github.com/xuxueli/xxl-job/blob/master/_autodocs/api-reference/xxl-job-spring-executor.md

Example @Component with an @XxlJob-annotated method; no manual registration needed.

```java
@Component
public class SampleXxlJob {
    @XxlJob("demoJobHandler")
    public void demoJobHandler() throws Exception {
        XxlJobHelper.log("XXL-JOB, Hello World.");
    }
}
```

--------------------------------

### Get shard parameters for slice broadcast in XXL-JOB task handler

Source: https://github.com/xuxueli/xxl-job/blob/master/doc/XXL-JOB-English-Documentation.md

Retrieves the current shard index and total shard count from XxlJobContext. Used when the route policy is '分片广播' to implement slice tasks. index starts at 0, total is the number of executors in the cluster.

```java
int shardIndex = XxlJobContext.getXxlJobContext().getShardIndex();
int shardTotal = XxlJobContext.getXxlJobContext().getShardTotal();
```

--------------------------------

### Start Embed Server with XxlJobSimpleExecutor

Source: https://github.com/xuxueli/xxl-job/blob/master/_autodocs/api-reference/embed-server.md

Directly instantiates the embed server via XxlJobSimpleExecutor. Normally done by XxlJobExecutor.start(); note that EmbedServer.start requires the registry helper and network config set up by that method, so use executor.start() normally.

```java
XxlJobExecutor executor = new XxlJobSimpleExecutor();
executor.setPort(9999);
executor.setAppname("my-app");
executor.setAccessToken("token");
executor.setLogPath("/tmp/xxl-job");
// note: EmbedServer.start requires the registry helper and network config
// set up by XxlJobExecutor.start() — use executor.start() normally:
executor.start();
// ... embedding server now answers POST /beat on port 9999
```

--------------------------------

### Docker Compose startup steps for XXL-JOB

Source: https://github.com/xuxueli/xxl-job/blob/master/doc/XXL-JOB-English-Documentation.md

Commands to download, build, start, and stop XXL-JOB using Docker Compose. Requires a custom MySQL persistence directory for MYSQL_PATH. The git clone command fetches the latest release tag.

```bash
// Download XXL-JOB
git clone --branch "$(curl -s https://api.github.com/repos/xuxueli/xxl-job/releases/latest | jq -r .tag_name)" https://github.com/xuxueli/xxl-job.git
// Build XXL-JOB
mvn clean package -Dmaven.test.skip=true
// Start XXL-JOB
MYSQL_PATH={自定义数据库持久化目录} docker compose up -d
// Stop XXL-JOB
docker compose down
```

--------------------------------

### POST /jobinfo/start

Source: https://github.com/xuxueli/xxl-job/blob/master/_autodocs/endpoints.md

Starts a job by setting its status to RUNNING and computing the next trigger time. Requires login. Accepts exactly one ID.

```APIDOC
## POST /jobinfo/start

### Description
Starts a job by setting its status to RUNNING and computing the next trigger time. Requires login. Accepts exactly one ID.

### Method
POST

### Endpoint
/jobinfo/start

### Parameters
#### Request Body
- **ids[]** (array of integer) - Required - Exactly one job ID to start.

### Response
#### Success Response (200)
- **code** (integer) - The response code (e.g., 200 for success).
- **msg** (string) - The response message.
- **content** (string) - The response content.

#### Response Example
{
  "code": 200,
  "msg": "success",
  "content": null
}
```

--------------------------------

### Basic logging and result handling with XxlJobHelper

Source: https://github.com/xuxueli/xxl-job/blob/master/_autodocs/api-reference/xxl-job-helper.md

Example from SampleXxlJob showing basic logging with placeholders and result handling. Uses getShardIndex, getShardTotal, getJobParam, log, and handleFail. If no handle*() call is made, the job defaults to success.

```java
@XxlJob("shardingJobHandler")
public void shardingJobHandler() throws Exception {
    int shardIndex = XxlJobHelper.getShardIndex();
    int shardTotal = XxlJobHelper.getShardTotal();
    XxlJobHelper.log("shard index = {}, shard total = {}", shardIndex, shardTotal);

    String param = XxlJobHelper.getJobParam();
    if (param == null || param.trim().isEmpty()) {
        XxlJobHelper.log("param invalid.");
        XxlJobHelper.handleFail();          // result: fail
        return;
    }
    // default success if no handle*() call is made
}
```

--------------------------------

### XxlJobFileAppender.initLogPath(logPath)

Source: https://github.com/xuxueli/xxl-job/blob/master/_autodocs/api-reference/xxl-job-file-appender.md

Initializes the log base path and creates required subdirectories (gluesource, callbacklogs). Throws an exception if logPath is blank.

```APIDOC
## XxlJobFileAppender.initLogPath

### Description
Initializes the log base path and creates required directories (gluesource, callbacklogs) for job execution logs.

### Method
initLogPath (static)

### Signature
public static void initLogPath(String logPath) throws IOException

### Parameters
- **String logPath** (string) - Required - Base path for logs; must not be blank or it throws RuntimeException("xxl-job logPath cannot be empty").

### Response
No return value. Creates directories and normalizes logBasePath to canonical path.

### Errors
- RuntimeException when logPath is blank.
- IOException on directory creation failure.
```

--------------------------------

### getFinalFireTime()

Source: https://github.com/xuxueli/xxl-job/blob/master/_autodocs/api-reference/cron-expression.md

Gets the last matching time up to MAX_YEAR.

```APIDOC
## getFinalFireTime

### Description
Returns the last matching time up to MAX_YEAR, or null.

### Method
getFinalFireTime

### Signature
`public Date getFinalFireTime()`

### Returns
- **Date** - The final fire time, or null if none.

```

--------------------------------

### getCronExpression()

Source: https://github.com/xuxueli/xxl-job/blob/master/_autodocs/api-reference/cron-expression.md

Gets the raw cron expression string.

```APIDOC
## getCronExpression

### Description
Returns the raw cron string.

### Method
getCronExpression

### Signature
`public String getCronExpression()`

### Returns
- **String** - The raw cron expression.

```

--------------------------------

### getTimeZone()

Source: https://github.com/xuxueli/xxl-job/blob/master/_autodocs/api-reference/cron-expression.md

Gets the time zone used for evaluation.

```APIDOC
## getTimeZone

### Description
Returns the evaluation time zone.

### Method
getTimeZone

### Signature
`public TimeZone getTimeZone()`

### Returns
- **TimeZone** - The time zone used for evaluation.

```

--------------------------------

### xxl-job-executor.properties configuration

Source: https://github.com/xuxueli/xxl-job/blob/master/doc/XXL-JOB-English-Documentation.md

Configuration file for the xxl-job executor sample. Set xxl.job.admin.addresses to the admin address list (comma-separated), xxl.job.executor.appname for grouping, xxl.job.executor.ip (blank for auto-detection), xxl.job.executor.port (must be unique per instance on the same machine), xxl.job.executor.logpath for runtime logs, and xxl.job.accessToken (enabled if not blank).

```properties
### xxl-job admin address list：xxl-job-admin address list: Multiple addresses are separated by commas,this address is used for "heart beat and register" and "task execution result callback" between the executor and xxl-job-admin.
xxl.job.admin.addresses=http://127.0.0.1:8080

### xxl.job.executor.appname is used to group by executors
xxl.job.executor.appname=xxl-job-executor-sample
### xxl.job.executor.ip :1,used to register with xxl-job-admin;2,xxl-job-admin dispatch task to executor through it;3,if it is blank executor will get ip automatically, multi network card need to be configured.
xxl.job.executor.ip=
### xxl.job.executor.port :the port of the executor runned by,if multiple executor instance run on the same computer the port must different with each other
xxl.job.executor.port=9999

### xxl-job log path：runtime log path of the job instance
xxl.job.executor.logpath=/data/applogs/xxl-job/jobhandler/

### xxl-job, access token：xxl-job access token,enabled if it not blank
xxl.job.accessToken=
```

--------------------------------

### With lifecycle methods: init and destroy

Source: https://github.com/xuxueli/xxl-job/blob/master/_autodocs/api-reference/xxl-job-annotation.md

Shows @XxlJob with value, init, and destroy attributes. The init method runs once per JobThread start, destroy once per stop. Both init and destroy must be declared on the same class or registration throws RuntimeException.

```java
@XxlJob(value = "demoJobHandler2", init = "init", destroy = "destroy")
public void demoJobHandler2() throws Exception {
    XxlJobHelper.log("XXL-JOB, Hello World.");
}
public void init()    { logger.info("init"); }      // called once per JobThread start
public void destroy() { logger.info("destroy"); }   // called once per JobThread stop
```

--------------------------------

### GET /errorpage

Source: https://github.com/xuxueli/xxl-job/blob/master/_autodocs/endpoints.md

Displays the error page. No authentication required.

```APIDOC
## GET /errorpage

### Description
Displays the error page.

### Method
GET

### Endpoint
/errorpage

### Authentication
none

### Response
#### Success Response (200)
- Error page.
```

--------------------------------

### getExpressionSummary()

Source: https://github.com/xuxueli/xxl-job/blob/master/_autodocs/api-reference/cron-expression.md

Gets a human-readable summary of the parsed cron fields.

```APIDOC
## getExpressionSummary

### Description
Returns a human-readable summary of each parsed field.

### Method
getExpressionSummary

### Signature
`public String getExpressionSummary()`

### Returns
- **String** - A summary of the parsed fields.

```

--------------------------------

### Handling IO errors for uninitialized log path

Source: https://github.com/xuxueli/xxl-job/blob/master/_autodocs/api-reference/xxl-job-file-appender.md

Shows how to catch a RuntimeException when the log path is not initialized, with an example error message 'xxl-job logPath cannot be empty'.

```java
try {
    XxlJobFileAppender.initLogPath(null);
} catch (RuntimeException e) {
    // "xxl-job logPath cannot be empty"
    log.error(e.getMessage());
}
```

--------------------------------

### Catch executor startup and registration errors

Source: https://github.com/xuxueli/xxl-job/blob/master/_autodocs/errors.md

Wrap executor.start() in a try-catch to handle RuntimeException for empty adminAddresses/appname/accessToken, handler-name conflicts, or missing init/destroy methods. Log the error with log.error().

```java
// startup/registration
try {
    executor.start();
} catch (RuntimeException e) {
    // adminAddresses/appname/accessToken empty, handler-name conflicts, missing init/destroy method
    log.error("executor failed to start", e);
}
```

--------------------------------

### GET /joblog

Source: https://github.com/xuxueli/xxl-job/blob/master/_autodocs/endpoints.md

Displays the job log list page. Requires login.

```APIDOC
## GET /joblog

### Description
Displays the job log list page. Requires login.

### Method
GET

### Endpoint
/joblog

### Parameters
#### Query Parameters
- **jobGroup** (integer) - Optional - Job group ID, default 0.
- **jobId** (integer) - Optional - Job ID, default 0.

### Response
#### Success Response (200)
- **Log list page** (HTML) - The rendered log list page.

#### Response Example
(HTML page content)
```

--------------------------------

### GET /jobgroup/loadById

Source: https://github.com/xuxueli/xxl-job/blob/master/_autodocs/endpoints.md

Loads a single executor group by ID. Requires login.

```APIDOC
## GET /jobgroup/loadById

### Description
Loads a single executor group by ID.

### Method
GET

### Endpoint
/jobgroup/loadById

### Authentication
login

### Parameters
#### Query Parameters
- **id** (integer) - Required - Group ID.

### Response
#### Success Response (200)
- **data** (XxlJobGroup) - The group object.
```

--------------------------------

### getNextInvalidTimeAfter(Date date)

Source: https://github.com/xuxueli/xxl-job/blob/master/_autodocs/api-reference/cron-expression.md

Gets the next invalid time after a given date.

```APIDOC
## getNextInvalidTimeAfter

### Description
Returns the next instant after the given date for which the expression is not satisfied, or null.

### Method
getNextInvalidTimeAfter

### Signature
`public Date getNextInvalidTimeAfter(Date date)`

### Parameters
- **date** (Date) - Required - The date after which to search.

### Returns
- **Date** - The next invalid time, or null if none.

```

--------------------------------

### getNextValidTimeAfter(Date date)

Source: https://github.com/xuxueli/xxl-job/blob/master/_autodocs/api-reference/cron-expression.md

Gets the next valid time after a given date.

```APIDOC
## getNextValidTimeAfter

### Description
Returns the next matching instant after the given date, or null if none within MAX_YEAR.

### Method
getNextValidTimeAfter

### Signature
`public Date getNextValidTimeAfter(Date date)`

### Parameters
- **date** (Date) - Required - The date after which to search.

### Returns
- **Date** - The next valid time, or null if none.

```

--------------------------------

### Manual script job execution with ScriptUtil

Source: https://github.com/xuxueli/xxl-job/blob/master/_autodocs/api-reference/xxl-job-file-appender.md

Demonstrates how to manually run a script job using ScriptUtil, matching the invocation performed by ScriptJobHandler.execute. It marks the script file, executes it with parameters, and handles success or failure based on the exit value.

```java
String scriptFile = XxlJobFileAppender.getGlueSrcPath() + "/666_1761412677119.py";
ScriptUtil.markScriptFile(scriptFile, "import sys\nprint(sys.argv[1:])");

String logFile = "/data/applogs/xxl-job/jobhandler/2024-01-01/999.log";
int exitValue = ScriptUtil.execToFile("python3", scriptFile, logFile, "param", "0", "1");
if (exitValue == 0) {
    XxlJobHelper.handleSuccess();
} else {
    XxlJobHelper.handleFail("script exit value(" + exitValue + ") is failed");
}
```

--------------------------------

### Read effective config values from XxlJobAdminBootstrap

Source: https://github.com/xuxueli/xxl-job/blob/master/_autodocs/api-reference/xxl-job-admin-bootstrap.md

Shows how to read effective configuration values with all clamping applied. The comments indicate the expected ranges or defaults for each value.

```java
XxlJobAdminBootstrap c = XxlJobAdminBootstrap.getInstance();
int fast = c.getTriggerPoolFastMax();     // >= 200
int slow = c.getTriggerPoolSlowMax();     // >= 100
int batch = c.getScheduleBatchSize();     // 50..500 else 100
int rdays = c.getLogretentiondays();      // -1 or >= 3
```

--------------------------------

### Frameless bootstrap with XxlJobSimpleExecutor

Source: https://github.com/xuxueli/xxl-job/blob/master/_autodocs/api-reference/xxl-job-simple-executor.md

Frameless application bootstrap: configures the executor, sets the bean list, starts it, and registers a shutdown hook. Requires a class annotated with @XxlJob.

```java
public class Main {
    public static void main(String[] args) {
        XxlJobSimpleExecutor executor = new XxlJobSimpleExecutor();
        executor.setAdminAddresses("http://127.0.0.1:8080");
        executor.setTimeout(3);
        executor.setEnabled(true);
        executor.setAppname("xxl-job-executor-sample");
        executor.setAccessToken("default_token");
        executor.setPort(9999);
        executor.setLogPath("/data/applogs/xxl-job/jobhandler");
        executor.setLogRetentionDays(30);
        executor.setGlueEnabled(true);
        executor.setXxlJobBeanList(List.of(new SampleXxlJob())); // @XxlJob annotated class

        try {
            executor.start();
        } catch (Exception e) {
            logger.error(e.getMessage(), e);
        }

        // block forever, then shutdown
        Runtime.getRuntime().addShutdownHook(executor::destroy);
    }
}
```

--------------------------------

### GET /user

Source: https://github.com/xuxueli/xxl-job/blob/master/_autodocs/endpoints.md

Returns the user list page. This endpoint is restricted to ADMIN users.

```APIDOC
## GET /user

### Description
Returns the user list page. This endpoint is restricted to ADMIN users.

### Method
GET

### Endpoint
/user

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **body** (HTML) - User list page.

#### Response Example
None
```

--------------------------------

### GET /jobgroup/pageList

Source: https://github.com/xuxueli/xxl-job/blob/master/_autodocs/endpoints.md

Returns a paginated list of executor groups. Requires ADMIN role.

```APIDOC
## GET /jobgroup/pageList

### Description
Returns a paginated list of executor groups.

### Method
GET

### Endpoint
/jobgroup/pageList

### Authentication
ADMIN

### Parameters
#### Query Parameters
- **offset** (integer) - Optional - Offset for pagination, default 0.
- **pagesize** (integer) - Optional - Page size, default 10.
- **appname** (string) - Optional - Filter by appname.
- **name** (string) - Optional - Filter by group name.

### Response
#### Success Response (200)
- **data** (PageModel<XxlJobGroup>) - Paginated list of groups.
```

--------------------------------

### GET /jobgroup

Source: https://github.com/xuxueli/xxl-job/blob/master/_autodocs/endpoints.md

Displays the executor group list page. Requires ADMIN role.

```APIDOC
## GET /jobgroup

### Description
Displays the executor group list page.

### Method
GET

### Endpoint
/jobgroup

### Authentication
ADMIN

### Response
#### Success Response (200)
- Group list page.
```

--------------------------------

### Logging an exception and failing the job

Source: https://github.com/xuxueli/xxl-job/blob/master/_autodocs/api-reference/xxl-job-helper.md

Example showing how to log an exception using XxlJobHelper.log(Throwable) and then mark the job as failed with handleFail. The stack trace is appended to the job log file with call-site info.

```java
@XxlJob("demoJobHandler")
public void demoJobHandler() throws Exception {
    try {
        riskyOperation();
    } catch (Exception e) {
        XxlJobHelper.log(e);                // stack trace goes to the job log file
        XxlJobHelper.handleFail("riskyOperation failed: " + e.getMessage());
    }
}
```
Tokens:
Raw