OKMStats
Basics
On all methods you'll see parameter named "token". Because the Cron Task are executed in background without authentication, the methods used in this scenario might use the token parameter. From default application execution context you must use "null" value what indicates to the application must use the "user session".
On special cases you might be "promoted as Administrator" using the "administrator token".
String systemToken = DbSessionManager.getInstance().getSystemToken();Methods
getDocumentsByContext
Description:
| Method | Return values | Description |
|---|---|---|
|
getDocumentsByContext(String token) |
StatsInfo |
Return 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 |
|---|---|---|
|
getDocumentsByContext(String token) |
StatsInfo |
Return stats information about documents size 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 |
Return 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 |
Return 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();
}
}
}getRecordsByContext
Description:
| Method | Return values | Description |
|---|---|---|
|
getRecordsByContext(String token) |
StatsInfo |
Return 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();
}
}
}
