Import samples

Basics

Caution

We suggest executing the methods below for large imports or for simple creation cases.

These methods execute fewer steps in the background than what is described in Document samples and Folder samples. That means you will get better performance because less logic is executed on the server side.

Suggested code sample

First, you must create the webservice object:

OKMWebservices ws = OKMWebservicesFactory.getInstance(host);

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

ws.login(user, password);

Caution

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

At this point you can use all the import methods from “quickImport” class as shown below:

ws.quickImport.importDocument("1be884f4-5758-4985-94d1-f18bfe004db8", file);

Methods

importDocument

Description:

Method	Return values	Description
importDocument(String uuid, File file)	String	Creates a new document. Returns the UUID of the document.

The value of the uuid parameter should be a folder or record node UUID.

Example:

package com.openkm;

import java.io.File;

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);
            File file = new File("/home/gnujavasergio/okm/logo.png");
            String uuid = ws.quickImport.importDocument("1be884f4-5758-4985-94d1-f18bfe004db8", file);
            System.out.println(uuid);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

importFolder

Description:

Method	Return values	Description
importFolder(String uuid, String name)	String	Creates a new folder. Returns the UUID of the folder.

The value of the uuid parameter should be a folder or record node UUID.

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);
            String uuid = ws.quickImport.importFolder("1be884f4-5758-4985-94d1-f18bfe004db8", "folder-name");
            System.out.println(uuid);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}