Cron samples

Cron expression format

The expression field follows a 6-field cron format:

 ? ? ? ? ? ?
 │ │ │ │ │ └── day of week  (MON, TUE, WED, THU, FRI, SAT, SUN)
 │ │ │ │ └──── month        (1 - 12)
 │ │ │ └────── day of month (1 - 31)
 │ │ └──────── hour         (0 - 23)
 │ └────────── min          (0 - 59)
 └──────────── seconds      (0 - 59)

Field	Values
seconds	0–59
minute	0–59
hour	0–23
day of month	1–31
month	1–12
day of week	MON, TUE, WED, THU, FRI, SAT, SUN

Methods

findAll

Description:

Method	Return values	Description
findAll()	List	Returns a list of all crontabs.

Example:

package com.openkm;

import com.openkm.sdk4j.OKMWebservicesFactory;
import com.openkm.sdk4j.bean.CronTab;
import com.openkm.sdk4j.impl.OKMWebservices;

import java.util.List;

public class Test {

    public static void main(String[] args) {
        String host = "http://localhost:8080/openkm";
        String user = "okmAdmin";
        String password = "admin";
        OKMWebservices ws = OKMWebservicesFactory.getInstance(host);

        try {
            ws.login(user, password);
            List<CronTab> cronTabs = ws.cronTab.findAll();
            for (CronTab ct : cronTabs) {
                System.out.println(ct);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

update

Description:

Method	Return values	Description
update(long id, String name, String expression, Boolean active)	void	Update a crontab.

Example:

package com.openkm;

import com.openkm.sdk4j.OKMWebservicesFactory;
import com.openkm.sdk4j.impl.OKMWebservices;

public class Test {

    public static void main(String[] args) {
        String host = "http://localhost:8080/openkm";
        String user = "okmAdmin";
        String password = "admin";
        OKMWebservices ws = OKMWebservicesFactory.getInstance(host);

        try {
            ws.login(user, password);
            long cronTabId = 1; // A valid crontab id
            ws.cronTab.update(cronTabId, "My task", "0 0 8-10 * * *", true);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

reset

Description:

Method	Return values	Description
reset(long id)	void	Reset error and set end time for a crontab.

Example:

package com.openkm;

import com.openkm.sdk4j.OKMWebservicesFactory;
import com.openkm.sdk4j.impl.OKMWebservices;

public class Test {

    public static void main(String[] args) {
        String host = "http://localhost:8080/openkm";
        String user = "okmAdmin";
        String password = "admin";
        OKMWebservices ws = OKMWebservicesFactory.getInstance(host);

        try {
            ws.login(user, password);
            long cronTabId = 1; // A valid crontab id
            ws.cronTab.reset(cronTabId);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

execute

Description:

Method	Return values	Description
execute(long id)	void	Execute a crontab task manually.

Example:

package com.openkm;

import com.openkm.sdk4j.OKMWebservicesFactory;
import com.openkm.sdk4j.impl.OKMWebservices;

public class Test {

    public static void main(String[] args) {
        String host = "http://localhost:8080/openkm";
        String user = "okmAdmin";
        String password = "admin";
        OKMWebservices ws = OKMWebservicesFactory.getInstance(host);

        try {
            ws.login(user, password);
            long cronTabId = 1; // A valid crontab id
            ws.cronTab.execute(cronTabId);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}