OKMProperty

Basics

On most methods you’ll see parameter named “nodeId”. The value of this parameter can be a valid document, folder, mail or record UUID or path.

Tip

Example of nodeId:

• Using UUID -> “f123a950-0329-4d62-8328-0ff500fd42db”;
• Using path -> “/okm:root/logo.png”

About the parameter named “catId”, the value of this parameter can be a valid categories folder UUID or path node.

Tip

Example of nodeId:

• Using UUID -> “f1678435-0329-4d62-8328-09846e6739823”;
• Using path -> “/okm:categories/category1”

Also on all methods you’ll see parameter named “token”. When accessing application across SOAP the login process returns a token, what is used to identify the user on all the exposed methods. From default application execution context you must use “null” value what indicates to the application must use the “user session”.

Tip

On special cases you might be “promoted as Administrator” using the “administrator token”.

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

Methods

addCategory

Description:

Method	Return values	Description
addCategory(String token, String nodeId, String catId)	void	Set a relation between a category and a node.

Example:

package com.openkm;

import com.openkm.api.OKMProperty;

public class Test {
    public static void main(String[] args) {
        try {
            OKMProperty.getInstance().addCategory(null, "/okm:root/logo.png", "/okm:categories/test");
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

removeCategory

Description:

Method	Return values	Description
removeCategory(String token, String nodeId, String catId)	void	Removes a relation between a category and a node.

Example:

package com.openkm;

import com.openkm.api.OKMProperty;

public class Test {
    public static void main(String[] args) {
        try {
            OKMProperty.getInstance().addCategory(null, "/okm:root/logo.png", "/okm:categories/test");
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

addKeyword

Description:

Method	Return values	Description
addKeyword(String token, String nodeId, String keyword)	String	Add a keyword in a node.

Note

We also we suggest you to add keyword in lowercase format, because OpenKM is case sensitive.

• The keyword should be a single word without spaces, formats allowed:

Example:

package com.openkm;

import com.openkm.api.OKMProperty;

public class Test {
    public static void main(String[] args) {
        try {
            String keyword = OKMProperty.getInstance().addKeyword(null, "/okm:root/logo.png", "test");
            System.out.println(keyword);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

removeKeyword

Description:

Method	Return values	Description
removeKeyword(String token, String nodeId, String keyword)	void	Removes a keyword from a node.

Example:

package com.openkm;

import com.openkm.api.OKMProperty;

public class Test {
    public static void main(String[] args) {
        try {
            OKMProperty.getInstance().removeKeyword(null, "/okm:root/logo.png", "test");
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

setEncryption

Description:

Method	Return values	Description
setEncryption(String token, String nodeId, String cipherName)	void	Marks a document as an en cripted binary data in the repository.

Caution

This method does not perform any kind of encryption, simply mark in the database that a document is encrypted.

• The parameter nodeId should be a document node. 
• The parameter cipherName saves information about the encription mechanism.

Example:

package com.openkm;

import com.openkm.api.OKMProperty;

public class Test {
    public static void main(String[] args) {
        try {
            OKMProperty.getInstance().setEncryption(null, "/okm:root/logo.png", "phrase");
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

unsetEncryption

Description:

Method	Return values	Description
unsetEncryption(String token, String nodeId)	void	Marks a document is a normal binary data into repository.

Caution

This method does not perform any kind of encryption, simply mark into the database that a document has been uncrypted.

• The parameter nodeId should be a document node. 

Example:

package com.openkm;

import com.openkm.api.OKMProperty;

public class Test {
    public static void main(String[] args) {
        try {
            OKMProperty.getInstance().unsetEncryption(null, "/okm:root/logo.png");
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

setSigned

Description:

Method	Return values	Description
setSigned(String token, String nodeId, boolean signed)	void	Marks a document as signed or unsigned binary data into the repository.

Caution

This method does not perform any kind of digital signature process, simply mark into the database that a document is signed.

• The parameter nodeId should be a document node.

Example:

package com.openkm;

import com.openkm.api.OKMProperty;

public class Test {
    public static void main(String[] args) {
        try {
            OKMProperty.getInstance().setSigned(null, "/okm:root/logo.png", true);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}