Repository samples
Métodos
Sección titulada «Métodos»getRootFolder
Sección titulada «getRootFolder»Descripción:
| Método | Valores de retorno | Descripción |
|---|---|---|
| getRootFolder() | Folder | Devuelve el objeto Folder del nodo “/okm:root”. |
Ejemplo:
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 { System.out.println(ws.getRootFolder()); } catch (Exception e) { e.printStackTrace(); } }}getTrashFolder
Sección titulada «getTrashFolder»Descripción:
| Método | Valores de retorno | Descripción |
|---|---|---|
| getTrashFolder() | Folder | Devuelve el objeto Folder del nodo “/okm:trash/{userId}”. |
La carpeta devuelta será la papelera del usuario.
Ejemplo:
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 { System.out.println(ws.getTrashFolder()); } catch (Exception e) { e.printStackTrace(); } }}getTrashFolderBase
Sección titulada «getTrashFolderBase»Descripción:
| Método | Valores de retorno | Descripción |
|---|---|---|
| getTrashFolderBase() | Folder | Devuelve el objeto Folder del nodo “/okm:trash”. |
Ejemplo:
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 { System.out.println(ws.getTrashFolderBase()); } catch (Exception e) { e.printStackTrace(); } }}getTemplatesFolder
Sección titulada «getTemplatesFolder»Descripción:
| Método | Valores de retorno | Descripción |
|---|---|---|
| getTemplatesFolder() | Folder | Devuelve el objeto Folder del nodo “/okm:templates”. |
Ejemplo:
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 { System.out.println(ws.getTemplatesFolder()); } catch (Exception e) { e.printStackTrace(); } }}getPersonalFolder
Sección titulada «getPersonalFolder»Descripción:
| Método | Valores de retorno | Descripción |
|---|---|---|
| getPersonalFolder() | Folder | Devuelve el objeto Folder del nodo “/okm:personal/{userId}”. |
La carpeta devuelta será la carpeta personal del usuario.
Ejemplo:
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 { System.out.println(ws.getPersonalFolder()); } catch (Exception e) { e.printStackTrace(); } }}getPersonalFolderBase
Sección titulada «getPersonalFolderBase»Descripción:
| Método | Valores de retorno | Descripción |
|---|---|---|
| getPersonalFolderBase() | Folder | Devuelve el objeto Folder del nodo “/okm:personal”. |
Ejemplo:
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 { System.out.println(ws.getPersonalFolderBase()); } catch (Exception e) { e.printStackTrace(); } }}getMailFolder
Sección titulada «getMailFolder»Descripción:
| Método | Valores de retorno | Descripción |
|---|---|---|
| getMailFolder() | Folder | Devuelve el objeto Folder del nodo “/okm:mail/{userId}”. |
La carpeta devuelta será la carpeta de correo del usuario.
Ejemplo:
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 { System.out.println(ws.getMailFolder()); } catch (Exception e) { e.printStackTrace(); } }}getMailFolderBase
Sección titulada «getMailFolderBase»Descripción:
| Método | Valores de retorno | Descripción |
|---|---|---|
| getMailFolderBase() | Folder | Devuelve el objeto Folder del nodo “/okm:mail”. |
Ejemplo:
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 { System.out.println(ws.getMailFolderBase()); } catch (Exception e) { e.printStackTrace(); } }}getThesaurusFolder
Sección titulada «getThesaurusFolder»Descripción:
| Método | Valores de retorno | Descripción |
|---|---|---|
| getThesaurusFolder() | Folder | Devuelve el objeto Folder del nodo “/okm:thesaurus”. |
Ejemplo:
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 { System.out.println(ws.getThesaurusFolder()); } catch (Exception e) { e.printStackTrace(); } }}getCategoriesFolder
Sección titulada «getCategoriesFolder»Descripción:
| Método | Valores de retorno | Descripción |
|---|---|---|
| getCategoriesFolder() | Folder | Devuelve el objeto Folder del nodo “/okm:categories”. |
Ejemplo:
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 { System.out.println(ws.getCategoriesFolder()); } catch (Exception e) { e.printStackTrace(); } }}purgeTrash
Sección titulada «purgeTrash»Descripción:
| Método | Valores de retorno | Descripción |
|---|---|---|
| purgeTrash() | void | Elimina permanentemente del repositorio todos los nodos de “/okm:trash/{userId}”. |
Ejemplo:
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.purgeTrash(); } catch (Exception e) { e.printStackTrace(); } }}getUpdateMessage
Sección titulada «getUpdateMessage»Descripción:
| Método | Valores de retorno | Descripción |
|---|---|---|
| getUpdateMessage() | String | Recupera un mensaje cuando hay una nueva versión de OpenKM disponible. |
Existe un servicio oficial de mensajes de actualización de OpenKM, basado en la versión local de OpenKM.
Ejemplo:
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 { System.out.println(ws.getUpdateMessage()); } catch (Exception e) { e.printStackTrace(); } }}getRepositoryUuid
Sección titulada «getRepositoryUuid»Descripción:
| Método | Valores de retorno | Descripción |
|---|---|---|
| getRepositoryUuid() | String | Recupera el identificador único de la instalación. |
Ejemplo:
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 { System.out.println(ws.getRepositoryUuid()); } catch (Exception e) { e.printStackTrace(); } }}hasNode
Sección titulada «hasNode»Descripción:
| Método | Valores de retorno | Descripción |
|---|---|---|
| hasNode(String nodeId) | Boolean | Devuelve un booleano que indica si existe un nodo. |
El valor del parámetro nodeId puede ser un UUID o una ruta válidos.
Ejemplo:
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 { System.out.println("Exists node:" + ws.hasNode("064ff51a-b815-4f48-a096-b4946876784f")); } catch (Exception e) { e.printStackTrace(); } }}getNodePath
Sección titulada «getNodePath»Descripción:
| Método | Valores de retorno | Descripción |
|---|---|---|
| getNodePath(String uuid) | String | Convierte un UUID de nodo en una ruta. |
Ejemplo:
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 { System.out.println(ws.getNodePath("064ff51a-b815-4f48-a096-b4946876784f")); } catch (Exception e) { e.printStackTrace(); } }}getNodeUuid
Sección titulada «getNodeUuid»Descripción:
| Método | Valores de retorno | Descripción |
|---|---|---|
| getNodeUuid(String path) | String | Convierte una ruta de nodo en un UUID. |
Ejemplo:
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 { System.out.println(ws.getNodeUuid("/okm:root/tmp")); } catch (Exception e) { e.printStackTrace(); } }}getAppVersion
Sección titulada «getAppVersion»Descripción:
| Método | Valores de retorno | Descripción |
|---|---|---|
| getAppVersion() | AppVersion | Devuelve información sobre la versión de OpenKM. |
Ejemplo:
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 { System.out.println(ws.getAppVersion()); } catch (Exception e) { e.printStackTrace(); } }}copyAttributes
Sección titulada «copyAttributes»Descripción:
| Método | Valores de retorno | Descripción |
|---|---|---|
| copyAttributes(String nodeId, String dstId, boolean categories, boolean keywords, boolean propertyGroups, boolean notes, boolean wiki) |
void | Copia los atributos de un nodo a otro. |
El valor del parámetro dstId debe ser un UUID o una ruta de nodo.
Ejemplo:
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.copyAttributes("/okm:root/invoice.pdf", "/okm:root/cloned_invoice.pdf", true, true, true, true, true); } catch (Exception e) { e.printStackTrace(); } }}executeScript
Sección titulada «executeScript»Descripción:
| Método | Valores de retorno | Descripción |
|---|---|---|
| executeScript(InputStream is) | ScriptExecutionResult | Ejecuta un script. |
El script local - test.bsh - utilizado en el ejemplo siguiente:
import com.openkm.bean.*;import com.openkm.api.*;
for (Folder fld : OKMFolder.getInstance().getChildren(null,"/okm:root")) { print(fld + "\n");}
// Some value can also be returned as stringreturn "some result";Ejemplo:
package com.openkm;
import java.io.FileInputStream;import java.io.InputStream;
import org.apache.commons.io.IOUtils;
import com.openkm.sdk4j.OKMWebservices;import com.openkm.sdk4j.OKMWebservicesFactory;import com.openkm.sdk4j.bean.ScriptExecutionResult;
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 { InputStream is = new FileInputStream("/opt/files/test.bsh"); ScriptExecutionResult result = ws.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(); } }}executeSqlQuery
Sección titulada «executeSqlQuery»Descripción:
| Método | Valores de retorno | Descripción |
|---|---|---|
| executeSqlQuery(InputStream is) | SqlQueryResults | Ejecuta sentencias SQL. |
El script test.sql utilizado en el ejemplo siguiente:
SELECT NBS_UUID, NBS_NAME FROM OKM_NODE_BASE LIMIT 10;Ejemplo:
package com.openkm;
import java.io.FileInputStream;import java.io.InputStream;
import org.apache.commons.io.IOUtils;
import com.openkm.sdk4j.OKMWebservices;import com.openkm.sdk4j.OKMWebservicesFactory;import com.openkm.sdk4j.bean.SqlQueryResultColumns;import com.openkm.sdk4j.bean.SqlQueryResults;
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 { InputStream is = new FileInputStream("/opt/files/test.sql"); SqlQueryResults result = ws.executeSqlQuery(is);
for (SqlQueryResultColumns row : result.getResults()) { System.out.println("uuid" + row.getColumns().get(0) + ", name:" + row.getColumns().get(1)); }
IOUtils.closeQuietly(is); } catch (Exception e) { e.printStackTrace(); } }}También se puede establecer el InputStream de la siguiente forma:
String sql = "SELECT NBS_UUID, NBS_NAME FROM OKM_NODE_BASE LIMIT 10;";InputStream is = new ByteArrayInputStream(sql.getBytes("UTF-8"));executeHqlQuery
Sección titulada «executeHqlQuery»Descripción:
| Método | Valores de retorno | Descripción |
|---|---|---|
| executeHqlQuery(InputStream is) | HqlQueryResults | Ejecuta sentencias HQL. |
El script test.sql utilizado en el ejemplo siguiente:
SELECT uuid, name from NodeBase where name = 'okm:root';Ejemplo:
package com.openkm;
import java.io.FileInputStream;import java.io.InputStream;
import org.apache.commons.io.IOUtils;
import com.openkm.sdk4j.OKMWebservices;import com.openkm.sdk4j.OKMWebservicesFactory;import com.openkm.sdk4j.bean.HqlQueryResults;
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 { InputStream is = new FileInputStream("/opt/files/test.sql"); HqlQueryResults result = ws.executeHqlQuery(is);
for (String column : result.getResults()) { System.out.println(column); }
IOUtils.closeQuietly(is); } catch (Exception e) { e.printStackTrace(); } }}También se puede establecer el InputStream de la siguiente forma:
String sql = "SELECT uuid, name from NodeBase where name = 'okm:root';";InputStream is = new ByteArrayInputStream(sql.getBytes("UTF-8"));getTranslations
Sección titulada «getTranslations»Descripción:
| Método | Valores de retorno | Descripción |
|---|---|---|
| getTranslations(String lang, String module) | Map<String, String> | Recupera las traducciones de un módulo en un Map de valores. |
Ejemplo:
package com.openkm;
import java.util.Map;
import com.openkm.sdk4j.OKMWebservices;import com.openkm.sdk4j.OKMWebservicesFactory;
public class Test { public static void main(String[] args) { String host = "http://localhost:8180/OpenKM"; String username = "okmAdmin"; String password = "admin"; OKMWebservices ws = OKMWebservicesFactory.newInstance(host, username, password);
try { Map<String, String> translations = ws.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
Sección titulada «getConfiguration»Descripción:
| Método | Valores de retorno | Descripción |
|---|---|---|
| getConfiguration(String key) | Configuration | Recupera el valor de un parámetro de configuración. |
Ejemplo:
package com.openkm;
import com.openkm.sdk4j.OKMWebservices;import com.openkm.sdk4j.OKMWebservicesFactory;import com.openkm.sdk4j.bean.Configuration;
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 { Configuration configuration = ws.getConfiguration("system.ocr"); System.out.println(configuration); } catch (Exception e) { e.printStackTrace(); } }}executePlugin
Sección titulada «executePlugin»Descripción:
| Método | Valores de retorno | Descripción |
|---|---|---|
| executePlugin(String className, Map<String, String> parameters, Class<?> clazz, InputStream is) Este método está obsoleto en favor de “executePostPlugin”. Le recomendamos usar este último en lugar de executePlugin. Para más información, consulte Plugin samples. |
Object | Devuelve el valor Object resultante de ejecutar una clase que implementa RestPlugin. |
Ejemplo:
package com.openkm;
import java.util.HashMap;import java.util.Map;
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 { Map<String, String> parameters = new HashMap<>(); parameters.put("param1", "value1"); parameters.put("param2", "value2"); String value = (String) ws.executePlugin("com.openkm.plugin.rest.TestRestPlugin", parameters, String.class, null); System.out.println(value); } catch (Exception e) { e.printStackTrace(); } }}getChangeLog
Sección titulada «getChangeLog»Descripción:
| Método | Valores de retorno | Descripción |
|---|---|---|
| getChangeLog(String nodePath, Calendar modificationsFrom) | List |
Devuelve la lista de cambios de una ruta y sus subcarpetas. |
Ejemplo:
package com.openkm;
import java.util.Calendar;
import com.openkm.sdk4j.OKMWebservices;import com.openkm.sdk4j.OKMWebservicesFactory;import com.openkm.sdk4j.bean.ChangeLogged;
public class Test2 { 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 { Calendar now = Calendar.getInstance(); for (ChangeLogged cl : ws.getChangeLog("/okm:root/synchronized", now)) { System.out.println(cl); } } catch (Exception e) { e.printStackTrace(); } }}getServerTime()
Sección titulada «getServerTime()»Descripción:
| Método | Valores de retorno | Descripción |
|---|---|---|
| getServerTime() | String | Devuelve la hora actual del servidor. |
Ejemplo:
package com.openkm;
import java.util.Calendar;
import com.openkm.sdk4j.OKMWebservices;import com.openkm.sdk4j.OKMWebservicesFactory;import com.openkm.sdk4j.bean.ChangeLogged;
public class Test2 { 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 { System.out.println(ws.getServerTime()); } catch (Exception e) { e.printStackTrace(); } }}