Activity samples

Basics

Suggested code sample

First, you must create the webservice object:

OKMWebservices ws = OKMWebservicesFactory.getInstance(host);

Then you should log in using the "login" method. You can access the "login" method from the webservice object "ws" as shown below:

ws.login(user, password);

Once you are logged in to the webservice, the session is kept in the webservice object. Then you can use the other API methods.

At this point you can use all the Activity methods from the "activity" class as shown below:

ActivityList results = ws.activity.findActivityLog(0, 20, beginDate, endDate, user, "", item, "");

Methods

findActivityLog

Description:

MethodReturn valuesDescription

findActivityLog(int page, int length, Calendar beginDate, Calendar endDate, String user, String action, String item, String hostname)

ActivityList

Returns a list of all activity logs by date, user, action, item and hostname.

The value of the item is the UUID of the node (document, folder, mail, or record).

The value of the hostname is the host from which the activity was originated. An empty string returns activities from all hosts.

Example:

package com.openkm;

import java.util.Calendar;

import com.openkm.sdk4j.OKMWebservicesFactory;
import com.openkm.sdk4j.bean.Activity;
import com.openkm.sdk4j.bean.ActivityList;
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);    
            
            Calendar beginDate = Calendar.getInstance();
            beginDate.add(Calendar.MONTH, -1);
            Calendar endDate = Calendar.getInstance();
            String item = "f84a2e1f-a858-4e53-9c09-36519d903782";
            String hostname = "";

            ActivityList results = ws.activity.findActivityLog(0, 20, beginDate, endDate, user, "", item, hostname);
            for(Activity activity: results.getActivities()) {
            	System.out.println(activity);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getActivityActions

Description:

MethodReturn valuesDescription

getActivityActions()

List<String>

Returns a list of all activity log actions.

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);
            for (String action : ws.activity.getActivityActions()) {
                System.out.println(action);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}