ElasticJob-Lite provides a Java API, which can control the life cycle of jobs in a distributed environment by directly operating the registry.

The module is still in incubation.

Configuration API

Class name: org.apache.shardingsphere.elasticjob.lite.lifecycle.api.JobConfigurationAPI

Get job configuration

Method signature：YamlJobConfiguration getJobConfiguration(String jobName)

• Parameters:

  • jobName — Job name
• Returns: Job configuration object

Update job configuration

Method signature：void updateJobConfiguration(YamlJobConfiguration yamlJobConfiguration)

• Parameters:
  • jobConfiguration — Job configuration object

Remove job configuration

Method signature：void removeJobConfiguration(String jobName)

• Parameters:
  • jobName — Job name

Operation API

Class name：org.apache.shardingsphere.elasticjob.lite.lifecycle.api.JobConfigurationAPI

Trigger job execution

The job will only trigger execution if it does not conflict with the currently running job, and this flag will be automatically cleared after it is started.

Method signature：void trigger(Optional jobName, Optional serverIp)

• Parameters:
  • jobName — Job name
  • serverIp — IP address of the job server

Disable job

Disabling a job will cause other distributed jobs to trigger resharding.

Method signature：void disable(Optional jobName, Optional serverIp)

• Parameters:
  • jobName — Job name
  • serverIp — job server IP address

Enable job

Method signature：void enable(Optional jobName, Optional serverIp)

• Parameters:
  • jobName — Job name
  • serverIp — job server IP address

Shutdown scheduling job

Method signature：void shutdown(Optional jobName, Optional serverIp)

• Parameters:
  • jobName — Job name
  • serverIp — IP address of the job server

Remove job

Method signature：void remove(Optional jobName, Optional serverIp)

• Parameters:
  • jobName — Job name
  • serverIp — IP address of the job server

Operate sharding API

Class name：org.apache.shardingsphere.elasticjob.lite.lifecycle.api.ShardingOperateAPI

Disable job sharding

Method signature：void disable(String jobName, String item)

• Parameters:
  • jobName — Job name
  • item — Job sharding item

Enable job sharding

Method signature：void enable(String jobName, String item)

• Parameters:
  • jobName — Job name
  • item — Job sharding item

Job statistics API

Class name：org.apache.shardingsphere.elasticjob.lite.lifecycle.api.JobStatisticsAPI

Get the total count of jobs

Method signature：int getJobsTotalCount()

• Returns: the total count of jobs

Get brief job information

Method signature：JobBriefInfo getJobBriefInfo(String jobName)

• Parameters:

  • jobName — Job name
• Returns: The brief job information

Get brief information about all jobs.

Method signature：Collection getAllJobsBriefInfo()

• Returns: Brief collection of all job information

Get brief information of all jobs under this IP

Method signature：Collection getJobsBriefInfo(String ip)

• Parameters:

  • ip — server IP
• Returns: Brief collection of job information

Job server status display API

Class name：org.apache.shardingsphere.elasticjob.lite.lifecycle.api.ServerStatisticsAPI

Total count of job servers

Method signature：int getServersTotalCount()

• Returns: Get the total count of job servers

Get brief information about all job servers

Method signature：Collection getAllServersBriefInfo()

• Returns: Brief collection of job information

Job sharding status display API

Class name：org.apache.shardingsphere.elasticjob.lite.lifecycle.api.ShardingStatisticsAPI

Get job sharding information collection

Method signature：Collection getShardingInfo(String jobName)

• Parameters:

  • jobName — Job name
• Returns: The collection of job sharding information