Repository samples

Basics

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);

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 Repository methods from the "repository" class as shown below:

ws.repository.getAppVersion();

Methods

getRootFolder

Description:

Method	Return values	Description
getRootFolder()	Folder	Returns the Folder object for node "/okm:root".

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);
            System.out.println(ws.repository.getRootFolder());
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getTrashFolder

Description:

Method	Return values	Description
getTrashFolder()	Folder	Returns the Folder object for node "/okm:trash/{userId}".
The returned folder will be the user's trash folder. For example, if the method is executed by the user "okmAdmin", then the returned folder will be "/okm:trash/okmAdmin".

Method

Return values

Description

getTrashFolder()

Folder

Returns the Folder object for node "/okm:trash/{userId}".

The returned folder will be the user's trash folder.

For example, if the method is executed by the user "okmAdmin", then the returned folder will be "/okm:trash/okmAdmin".

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);
            System.out.println(ws.repository.getTrashFolder());
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getTrashFolderBase

Description:

Method	Return values	Description
getTrashFolderBase()	Folder	Returns the Folder object for node "/okm:trash".

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);
            System.out.println(ws.repository.getTrashFolderBase());
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getTemplatesFolder

Description:

Method	Return values	Description
getTemplatesFolder()	Folder	Returns the Folder object for node "/okm:templates".

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);
            System.out.println(ws.repository.getTemplatesFolder());
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getPersonalFolder

Description:

Method	Return values	Description
getPersonalFolder()	Folder	Returns the Folder object for node "/okm:personal/{userId}".
The returned folder will be the user's personal folder. For example, if the method is executed by the user "okmAdmin", then the returned folder will be "/okm:personal/okmAdmin".

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);
            System.out.println(ws.repository.getPersonalFolder());
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getPersonalFolderBase

Description:

Method	Return values	Description
getPersonalFolderBase()	Folder	Returns the Folder object for node "/okm:personal".

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);
            System.out.println(ws.repository.getPersonalFolderBase());
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getMailFolder

Description:

Method	Return values	Description
getMailFolder()	Folder	Returns the Folder object for node "/okm:mail/{userId}".
The returned folder will be the user's mail folder. For example, if the method is executed by the user "okmAdmin", then the returned folder will be "/okm:mail/okmAdmin".

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);
            System.out.println(ws.repository.getMailFolder());
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getMailFolderBase

Description:

Method	Return values	Description
getMailFolderBase()	Folder	Returns the Folder object for node "/okm:mail".

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);
            System.out.println(ws.repository.getMailFolderBase());
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getCategoriesFolder

Description:

Method	Return values	Description
getCategoriesFolder()	Folder	Returns the Folder object for node "/okm:categories".

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);
            System.out.println(ws.repository.getCategoriesFolder());
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

purgeTrash

Description:

Method	Return values	Description
purgeTrash()	void	Permanently removes from the repository all nodes in "/okm:trash/{userId}".
For example, if the method is executed by the user "okmAdmin", then the purged trash will be "/okm:trash/okmAdmin". When a node is purged it can only be restored from a previous repository backup. The purge action permanently removes the node from the repository.

Method

Return values

Description

purgeTrash()

void

Permanently removes from the repository all nodes in "/okm:trash/{userId}".

For example, if the method is executed by the user "okmAdmin", then the purged trash will be "/okm:trash/okmAdmin".

When a node is purged it can only be restored from a previous repository backup. The purge action permanently removes the node from the repository.

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);
            ws.repository.purgeTrash();
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getUpdateMessage

Description:

Method	Return values	Description
getUpdateMessage()	String	Retrieves a message when there is a new OpenKM release.
There is an official OpenKM update message service available which is based on your local OpenKM version. The most common message is that a new OpenKM version has been released.

Method

Return values

Description

getUpdateMessage()

String

Retrieves a message when there is a new OpenKM release.

There is an official OpenKM update message service available which is based on your local OpenKM version.

The most common message is that a new OpenKM version has been released.

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);
            System.out.println(ws.repository.getUpdateMessage());
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getRepositoryUuid

Description:

Method	Return values	Description
getRepositoryUuid()	String	Retrieves the installation's unique identifier.

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);
            System.out.println(ws.repository.getRepositoryUuid());
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

hasNode

Description:

Method	Return values	Description
hasNode(String nodeId)	Boolean	Returns a value that indicates whether a node exists or not.
The value of the parameter nodeId can be a valid UUID or path.

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);
            System.out.println("Exists node:" + ws.repository.hasNode("373bcdd0-c082-4e7b-addd-e10ef813946e"));
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getNodePath

Description:

Method	Return values	Description
getNodePath(String uuid)	String	Converts a node UUID to a path.

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);
            System.out.println(ws.repository.getNodePath("373bcdd0-c082-4e7b-addd-e10ef813946e"));
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getNodeUuid

Description:

Method	Return values	Description
getNodeUuid(String nodePath)	String	Converts a node path to a 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);
            System.out.println(ws.repository.getNodeUuid("/okm:root/test"));
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getAppVersion

Description:

Method	Return values	Description
getAppVersion()	AppVersion	Returns information about the OpenKM version.

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);
            System.out.println(ws.repository.getAppVersion());
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

copyAttributes

Description:

Method	Return values	Description
copyAttributes(String uuid, String dstId, boolean categories, boolean keywords, boolean propertyGroups, boolean notes)	void	Copies attributes from one node to another.
The value of the dstId parameter should be a node UUID. When the categories parameter is true, the original values of the categories will be copied. When the keywords parameter is true, the original values of the keywords will be copied. When the propertyGroups parameter is true, the original values of the metadata groups will be copied. When the notes parameter is true, the original values of the notes will be copied.

Method

Return values

Description

copyAttributes(String uuid, String dstId, boolean categories, boolean keywords, boolean propertyGroups, boolean notes)

void

Copies attributes from one node to another.

The value of the dstId parameter should be a node UUID.

When the categories parameter is true, the original values of the categories will be copied.
When the keywords parameter is true, the original values of the keywords will be copied.
When the propertyGroups parameter is true, the original values of the metadata groups will be copied.
When the notes parameter is true, the original values of the notes will be copied.

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);
            ws.repository.copyAttributes("46762f90-82c6-4886-8d21-ad3017dd78a7", "ac9fe744-8e45-4bf4-a293-85dafe1bfbca", true, true, true, true);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

executeScript

Description:

Method Return values Description

Method	Return values	Description
executeScript(InputStream is)	ScriptExecutionResult	Executes a script.
The local script - test.bsh - used in the sample below: `import com.openkm.api.OKMFolder; import com.openkm.bean.Folder; import com.openkm.util.ContextWrapper; try { OKMFolder okmFolder = ContextWrapper.getContext().getBean(OKMFolder.class); for (Folder fld : okmFolder.getChildren(null, "/okm:root")) { print(fld.getPath() + "\n"); } } catch (Exception e) { e.printStackTrace(); } // Some value can also be returned as string return "test result";` This action can only be performed by a superuser (a user with ROLE_ADMIN).

executeScript(InputStream is)

ScriptExecutionResult

Executes a script.

The local script - test.bsh - used in the sample below:

import com.openkm.api.OKMFolder;
import com.openkm.bean.Folder;
import com.openkm.util.ContextWrapper;

try {
    OKMFolder okmFolder = ContextWrapper.getContext().getBean(OKMFolder.class);
    for (Folder fld : okmFolder.getChildren(null, "/okm:root")) {
        print(fld.getPath() + "\n");
    }
} catch (Exception e) {
    e.printStackTrace();
}

// Some value can also be returned as string
return "test result";

This action can only be performed by a superuser (a user with ROLE_ADMIN).

Example:

package com.openkm;

import java.io.FileInputStream;
import java.io.InputStream;

import org.apache.commons.io.IOUtils;

import com.openkm.sdk4j.OKMWebservicesFactory;
import com.openkm.sdk4j.bean.ScriptExecutionResult;
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);
            InputStream is = new FileInputStream("/home/openkm/test.bsh");
            ScriptExecutionResult result = ws.repository.executeScript(is);
            System.out.println(result.getResult());
            System.out.println(result.getStdout());

            if (!result.getStderr().isEmpty()) {
                System.out.println("Error happened");
                System.out.println(result.getStderr());
            }

            IOUtils.closeQuietly(is);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

executeScript

Description:

Method	Return values	Description
executeScript(String script)	ScriptExecutionResult	Executes a script.
This action can only be performed by a superuser (a user with ROLE_ADMIN).

Example:

package com.openkm;

import java.io.FileInputStream;
import java.io.InputStream;

import org.apache.commons.io.IOUtils;

import com.openkm.sdk4j.OKMWebservicesFactory;
import com.openkm.sdk4j.bean.ScriptExecutionResult;
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 script = "import com.openkm.util.ContextWrapper;"
                    + " import org.springframework.web.context.WebApplicationContext;"
                    + " import com.openkm.api.OKMFolder;"
                    + " import com.openkm.bean.Folder;"
                    + " WebApplicationContext cc = (WebApplicationContext) ContextWrapper.getContext();"
                    + " OKMFolder okmFolder = cc.getBean(OKMFolder.class);"
                    + " for (Folder fld : okmFolder.getChildren(null,\"/okm:root\")) {"
                    + " print(fld.getPath());"
                    + "}";
            ScriptExecutionResult result = ws.repository.executeScript(script);
            System.out.println(result.getResult());
            System.out.println(result.getStdout());
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

executeSqlQuery

Description:

Method Return values Description

Method	Return values	Description
executeSqlQuery(InputStream is)	SqlQueryResults	Executes SQL statements.
The test.sql script used in the sample below: `SELECT NBS_UUID, NBS_NAME FROM OKM_NODE_BASE LIMIT 10;` The SQL script can only contain a single SQL statement. This action can only be performed by a superuser (a user with ROLE_ADMIN).

executeSqlQuery(InputStream is)

SqlQueryResults

Executes SQL statements.

The test.sql script used in the sample below:

SELECT NBS_UUID, NBS_NAME FROM OKM_NODE_BASE LIMIT 10;

The SQL script can only contain a single SQL statement.

This action can only be performed by a superuser (a user with ROLE_ADMIN).

Example:

package com.openkm;

import java.io.FileInputStream;
import java.io.InputStream;

import org.apache.commons.io.IOUtils;

import com.openkm.sdk4j.OKMWebservicesFactory;
import com.openkm.sdk4j.bean.SqlQueryResultColumns;
import com.openkm.sdk4j.bean.SqlQueryResults;
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);
            InputStream is = new FileInputStream("/home/gnujavasergio/okm/test.sql");
            SqlQueryResults result = ws.repository.executeSqlQuery(is);
            for (SqlQueryResultColumns columns : result.getResults()) {
                System.out.println("UUID:" + columns.getColumns().get(0));
                System.out.println("Context:" + columns.getColumns().get(1));
                System.out.println("Name:" + columns.getColumns().get(2));
            }
            IOUtils.closeQuietly(is);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

Also the InputStream can be set as:

String sql = "SELECT NBS_UUID, NBS_CONTEXT, NBS_NAME FROM OKM_NODE_BASE LIMIT 10;";
InputStream is = new ByteArrayInputStream(sql.getBytes("UTF-8"));

executeSqlQuery

Description:

Method	Return values	Description
executeSqlQuery(String sql)	SqlQueryResults	Executes SQL statements.
The SQL script can only contain a single SQL statement. This action can only be performed by a superuser (a user with ROLE_ADMIN).

Example:

package com.openkm;

import com.openkm.sdk4j.OKMWebservicesFactory;
import com.openkm.sdk4j.bean.SqlQueryResultColumns;
import com.openkm.sdk4j.bean.SqlQueryResults;
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);
            SqlQueryResults result = ws.repository.executeSqlQuery("SESELECT NBS_UUID, NBS_CONTEXT, NBS_NAME FROM OKM_NODE_BASE LIMIT 10;");
            for (SqlQueryResultColumns columns : result.getResults()) {
                System.out.println("UUID:" + columns.getColumns().get(0));
                System.out.println("Context:" + columns.getColumns().get(1));
                System.out.println("Name:" + columns.getColumns().get(2));
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

executeHqlQuery

Description:

Method	Return values	Description
executeHqlQuery(InputStream is)	HqlQueryResults	Executes HQL statements.
The test.sql script used in the sample below: SELECT uuid, author from NodeBase where name = 'okm:root'; The HQL script can only contain a single HQL statement. This action can only be performed by a superuser (a user with ROLE_ADMIN).

Method

Return values

Description

executeHqlQuery(InputStream is)

HqlQueryResults

Executes HQL statements.

The test.sql script used in the sample below:

SELECT uuid, author from NodeBase where name = 'okm:root';

The HQL script can only contain a single HQL statement.

This action can only be performed by a superuser (a user with ROLE_ADMIN).

Example:

package com.openkm;

import java.io.FileInputStream;
import java.io.InputStream;

import org.apache.commons.io.IOUtils;

import com.openkm.sdk4j.OKMWebservicesFactory;
import com.openkm.sdk4j.bean.HqlQueryResultColumns;
import com.openkm.sdk4j.bean.HqlQueryResults;
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);
            InputStream is = new FileInputStream("/home/gnujavasergio/okm/test.sql");
            HqlQueryResults result = ws.repository.executeHqlQuery(is);

            for (HqlQueryResultColumns row : result.getResults()) {
                System.out.println("uuid: " + row.getColumns().get(0) + ", name: " + row.getColumns().get(1));
            }

            IOUtils.closeQuietly(is);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

Also the InputStream can be set as:

String sql = "SELECT uuid, name from NodeBase where name = 'okm:root';";
InputStream is = new ByteArrayInputStream(sql.getBytes("UTF-8"));

executeHqlQuery

Description:

Method	Return values	Description
executeHqlQuery(String hql)	HqlQueryResults	Executes HQL statements.
The HQL script can only contain a single HQL statement. This action can only be performed by a superuser (a user with ROLE_ADMIN).

Example:

package com.openkm;

import com.openkm.sdk4j.OKMWebservicesFactory;
import com.openkm.sdk4j.bean.HqlQueryResultColumns;
import com.openkm.sdk4j.bean.HqlQueryResults;
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);
            HqlQueryResults result = ws.repository.executeHqlQuery("SELECT uuid, author from NodeBase where name = 'okm:root';");
            for (HqlQueryResultColumns row : result.getResults()) {
                System.out.println("uuid: " + row.getColumns().get(0) + ", name: " + row.getColumns().get(1));
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getTranslations

Description:

Method	Return values	Description
getTranslations(String lang, String module)	Map<String, String>	Retrieves the translations of a module into a Map of values.
The OpenKM translations tables can be used to retrieve current OpenKM translations or create your own translations (insert values into a new module). By default, module values are: frontend (used by the default OpenKM UI). extension (used by the OpenKM extension UI). mobile (used by the OpenKM mobile UI). Example to add a new translation module: SQL values to be executed from Database query view: `DELETE FROM OKM_TRANSLATION WHERE TR_LANGUAGE='en-GB' and TR_MODULE='doc'; INSERT INTO OKM_TRANSLATION (TR_MODULE, TR_KEY, TR_TEXT, TR_LANGUAGE) VALUES ('doc', 'document.generator.title','Document generator', 'en-GB'); INSERT INTO OKM_TRANSLATION (TR_MODULE, TR_KEY, TR_TEXT, TR_LANGUAGE) VALUES ('doc', 'document.generator.logout','Logout', 'en-GB');` The code should then be: `Map<String, String> translations = ws.getTranslations("en-GB", "doc");`

Example:

package com.openkm;

import java.util.Map;

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);
            Map<String, String> translations = ws.repository.getTranslations("en-GB", "frontend");
            for (String key : translations.keySet()) {
                System.out.println("key:'" + key + "', with translation:'" + translations.get(key) + "'");
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getConfiguration

Description:

Method	Return values	Description
getConfiguration(String key)	Configuration	Retrieves the value of a configuration parameter.
If your OpenKM version has the configuration parameter named "webservices.visible.properties", access to configuration parameters will be restricted for non-administrator users. That means any non-administrator user who tries to access configuration parameters via the webservices that are not listed in "webservices.visible.properties" will receive an access denied exception.

Method

Return values

Description

getConfiguration(String key)

Configuration

Retrieves the value of a configuration parameter.

If your OpenKM version has the configuration parameter named "webservices.visible.properties", access to configuration parameters will be restricted for non-administrator users. That means any non-administrator user who tries to access configuration parameters via the webservices that are not listed in "webservices.visible.properties" will receive an access denied exception.

Example:

package com.openkm;

import com.openkm.sdk4j.OKMWebservicesFactory;
import com.openkm.sdk4j.bean.Configuration;
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);
            Configuration configuration = ws.repository.getConfiguration("system.ocr");
            System.out.println(configuration);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getChangeLog

Description:

Method	Return values	Description
getChangeLog(String nodePath, Calendar modificationsFrom)	List<ChangeLogged>	Returns the list of changes in a path and its subfolders.
The method is used by the desktop synchronization application to retrieve changes.

Example:

package com.openkm;

import java.util.Calendar;

import com.openkm.sdk4j.OKMWebservicesFactory;
import com.openkm.sdk4j.bean.ChangeLogged;
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 now = Calendar.getInstance();
            for (ChangeLogged cl : ws.repository.getChangeLog("/okm:root/synchronized", now)) {
                System.out.println(cl);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getServerTime()

Description:

Method	Return values	Description
getServerTime()	String	Returns the current server time.
The server time returned is in ISO8601 format. The method is used by the desktop synchronization application to retrieve changes.

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);
            System.out.println(ws.repository.getServerTime());
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getAvailableLocales

Description:

Method	Return values	Description
getAvailableLocales(String locale)	Map<String, String>	Returns the available languages.

Example:

package com.openkm;

import java.util.Map;

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);
            Map<String, String> locales = ws.repository.getAvailableLocales("en-GB");
            for (String key : locales.keySet()) {
                System.out.println("Language:" + key + "," + locales.get(key));
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

Table of contents [ Hide Show ]

Basics

Suggested code sample

Methods

getRootFolder
getTrashFolder
getTrashFolderBase
getTemplatesFolder
getPersonalFolder
getPersonalFolderBase
getMailFolder
getMailFolderBase
getCategoriesFolder
purgeTrash
getUpdateMessage
getRepositoryUuid
hasNode
getNodePath
getNodeUuid
getAppVersion
copyAttributes
executeScript
executeScript
executeSqlQuery
executeSqlQuery
executeHqlQuery
executeHqlQuery
getTranslations
getConfiguration
getChangeLog
getServerTime()
getAvailableLocales

SDK for Java 2.0-ce

Repository samples

Basics

Suggested code sample

Methods

getRootFolder

getTrashFolder

getTrashFolderBase

getTemplatesFolder

getPersonalFolder

getPersonalFolderBase

getMailFolder

getMailFolderBase

getCategoriesFolder

purgeTrash

getUpdateMessage

getRepositoryUuid

hasNode

getNodePath

getNodeUuid

getAppVersion

copyAttributes

executeScript

executeScript

executeSqlQuery

executeSqlQuery

executeHqlQuery

executeHqlQuery

getTranslations

getConfiguration

getChangeLog

getServerTime()

getAvailableLocales