Property samples
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.
Example of nodeId:
- Using UUID -> "f123a950-0329-4d62-8328-0ff500fd42db";
- Using path -> "/okm:root/logo.png"
Methods
addCategory
Description:
| Method | Return values | Description |
|---|---|---|
|
addCategory(String nodeId, String catId) |
void |
Set a relation between a category and a node. |
| The value of the catId parameter should be a category folder UUID or path. | ||
Example:
package com.openkm;
import com.openkm.sdk4j.OKMWebservices;
import com.openkm.sdk4j.OKMWebservicesFactory;
public class Test {
public static void main(String[] args) {
String host = "http://localhost:8080/OpenKM";
String username = "okmAdmin";
String password = "admin";
OKMWebservices ws = OKMWebservicesFactory.newInstance(host, username, password);
try {
ws.addCategory("/okm:root/logo.png", "/okm:categories/test");
} catch (Exception e) {
e.printStackTrace();
}
}
}removeCategory
Description:
| Method | Return values | Description |
|---|---|---|
|
removeCategory(String nodeId, String catId) |
void |
Removes a relation between a category and a node. |
| The value of the catId parameter should be a category folder UUID or path. | ||
Example:
package com.openkm;
import com.openkm.sdk4j.OKMWebservices;
import com.openkm.sdk4j.OKMWebservicesFactory;
public class Test {
public static void main(String[] args) {
String host = "http://localhost:8080/OpenKM";
String username = "okmAdmin";
String password = "admin";
OKMWebservices ws = OKMWebservicesFactory.newInstance(host, username, password);
try {
ws.removeCategory("/okm:root/logo.png", "/okm:categories/test");
} catch (Exception e) {
e.printStackTrace();
}
}
}addKeyword
Description:
| Method | Return values | Description |
|---|---|---|
|
addKeyword(String nodeId, String keyword) |
void |
Add a keyword in a node. |
|
The keyword should be a single word without spaces, formats allowed:
We also we suggest you to add keyword in lowercase format, because OpenKM is case sensitive. |
||
Example:
package com.openkm;
import com.openkm.sdk4j.OKMWebservices;
import com.openkm.sdk4j.OKMWebservicesFactory;
public class Test {
public static void main(String[] args) {
String host = "http://localhost:8080/OpenKM";
String username = "okmAdmin";
String password = "admin";
OKMWebservices ws = OKMWebservicesFactory.newInstance(host, username, password);
try {
ws.addKeyword("/okm:root/logo.png", "test");
} catch (Exception e) {
e.printStackTrace();
}
}
}removeKeyword
Description:
| Method | Return values | Description |
|---|---|---|
|
removeKeyword(String nodeId, String keyword) |
void |
Removes a keyword from a node. |
Example:
package com.openkm;
import com.openkm.sdk4j.OKMWebservices;
import com.openkm.sdk4j.OKMWebservicesFactory;
public class Test {
public static void main(String[] args) {
String host = "http://localhost:8080/OpenKM";
String username = "okmAdmin";
String password = "admin";
OKMWebservices ws = OKMWebservicesFactory.newInstance(host, username, password);
try {
ws.removeKeyword("/okm:root/logo.png", "test");
} catch (Exception e) {
e.printStackTrace();
}
}
}setEncryption
Description:
| Method | Return values | Description |
|---|---|---|
|
setEncryption(String nodeId, String cipherName) |
void |
Marks a document as an en cripted binary data in the repository. |
|
The parameter nodeId should be a document node. The parameter cipherName saves information about the encription mechanism. This method does not perform any kind of encryption, simply mark in the database that a document is encrypted. |
||
Example:
package com.openkm;
import com.openkm.sdk4j.OKMWebservices;
import com.openkm.sdk4j.OKMWebservicesFactory;
public class Test {
public static void main(String[] args) {
String host = "http://localhost:8080/OpenKM";
String username = "okmAdmin";
String password = "admin";
OKMWebservices ws = OKMWebservicesFactory.newInstance(host, username, password);
try {
ws.setEncryption("/okm:root/logo.png", "phrase");
} catch (Exception e) {
e.printStackTrace();
}
}
}unsetEncryption
Description:
| Method | Return values | Description |
|---|---|---|
|
unsetEncryption(String nodeId) |
void |
Marks a document is a normal binary data into repository. |
|
The parameter nodeId should be a document node. This method does not perform any kind of encryption, simply mark into the database that a document has been uncrypted. |
||
Example:
package com.openkm;
import com.openkm.sdk4j.OKMWebservices;
import com.openkm.sdk4j.OKMWebservicesFactory;
public class Test {
public static void main(String[] args) {
String host = "http://localhost:8080/OpenKM";
String username = "okmAdmin";
String password = "admin";
OKMWebservices ws = OKMWebservicesFactory.newInstance(host, username, password);
try {
ws.unsetEncryption("/okm:root/logo.png");
} catch (Exception e) {
e.printStackTrace();
}
}
}setSigned
Description:
| Method | Return values | Description |
|---|---|---|
|
setSigned(String nodeId, boolean signed) |
void |
Marks a document as signed or unsigned binary data into the repository. |
|
The parameter nodeId should be a document node. This method does not perform any kind of digital signature process, simply mark into the database that a document is signed. |
||
Example:
package com.openkm;
import com.openkm.sdk4j.OKMWebservices;
import com.openkm.sdk4j.OKMWebservicesFactory;
public class Test {
public static void main(String[] args) {
String host = "http://localhost:8080/OpenKM";
String username = "okmAdmin";
String password = "admin";
OKMWebservices ws = OKMWebservicesFactory.newInstance(host, username, password);
try {
ws.setSigned("/okm:root/logo.pdf", true);
} catch (Exception e) {
e.printStackTrace();
}
}
}
