OKMStats

Basics

On all methods you’ll see a parameter named “token”. Because Cron tasks are executed in the background without authentication, the methods used in this scenario might use the token parameter. From the default application execution context you must use the “null” value, which indicates the application should use the “user session”.

Tip

In special cases you might be “promoted to Administrator” using the “administrator token”.

String systemToken = DbSessionManager.getInstance().getSystemToken();

Methods

getDocumentsByContext

Description:

Method	Return values	Description
getDocumentsByContext(String token)	StatsInfo	Returns stats information about documents by context.

Example:

package com.openkm;

import com.openkm.api.OKMStats;
import com.openkm.bean.StatsInfo;
import com.openkm.util.ContextWrapper;

public class Test {

    public static void main(String[] args) {
        try {
            OKMStats okmStats = ContextWrapper.getContext().getBean(OKMStats.class);
            StatsInfo sInfo = okmStats.getDocumentsByContext(null);
            System.out.println(sInfo);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getDocumentsSizeByContext

Description:

Method	Return values	Description
getDocumentsSizeByContext(String token)	StatsInfo	Returns stats information about document sizes by context.

Example:

package com.openkm;

import com.openkm.api.OKMStats;
import com.openkm.bean.StatsInfo;
import com.openkm.util.ContextWrapper;

public class Test {

    public static void main(String[] args) {
        try {
            OKMStats okmStats = ContextWrapper.getContext().getBean(OKMStats.class);
            StatsInfo sInfo = okmStats.getDocumentsSizeByContext(null);
            System.out.println(sInfo);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getFoldersByContext

Description:

Method	Return values	Description
getFoldersByContext(String token)	StatsInfo	Returns stats information about folders by context.

Example:

package com.openkm;

import com.openkm.api.OKMStats;
import com.openkm.bean.StatsInfo;
import com.openkm.util.ContextWrapper;

public class Test {

    public static void main(String[] args) {
        try {
            OKMStats okmStats = ContextWrapper.getContext().getBean(OKMStats.class);
            StatsInfo sInfo = okmStats.getFoldersByContext(null);
            System.out.println(sInfo);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getMailsByContext

Description:

Method	Return values	Description
getMailsByContext(String token)	StatsInfo	Returns stats information about mails by context.

Example:

package com.openkm;

import com.openkm.api.OKMStats;
import com.openkm.bean.StatsInfo;
import com.openkm.util.ContextWrapper;

public class Test {

    public static void main(String[] args) {
        try {
            OKMStats okmStats = ContextWrapper.getContext().getBean(OKMStats.class);
            StatsInfo sInfo = okmStats.getMailsByContext(null);
            System.out.println(sInfo);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getMailsSizeByContext

Description:

Method	Return values	Description
getMailsSizeByContext(String token)	StatsInfo	Returns stats information about mail sizes by context.

Example:

package com.openkm;

import com.openkm.api.OKMStats;
import com.openkm.bean.StatsInfo;
import com.openkm.util.ContextWrapper;

public class Test {

    public static void main(String[] args) {
        try {
            OKMStats okmStats = ContextWrapper.getContext().getBean(OKMStats.class);
            StatsInfo sInfo = okmStats.getMailsSizeByContext(null);
            System.out.println(sInfo);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getRecordsByContext

Description:

Method	Return values	Description
getRecordsByContext(String token)	StatsInfo	Returns stats information about records by context.

Example:

package com.openkm;

import com.openkm.api.OKMStats;
import com.openkm.bean.StatsInfo;
import com.openkm.util.ContextWrapper;

public class Test {

    public static void main(String[] args) {
        try {
            OKMStats okmStats = ContextWrapper.getContext().getBean(OKMStats.class);
            StatsInfo sInfo = okmStats.getRecordsByContext(null);
            System.out.println(sInfo);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}