Repository samples

Métodos

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

Descripción:

Método	Valores de retorno	Descripción
getTrashFolder()	Folder	Devuelve el objeto Folder del nodo “/okm:trash/{userId}”.

Nota

Por ejemplo, si el método lo ejecuta el usuario “okmAdmin”, la carpeta devuelta será “/okm:trash/okmAdmin”.

• 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();
        }
    }
}

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

Descripción:

Método	Valores de retorno	Descripción
getPersonalFolder()	Folder	Devuelve el objeto Folder del nodo “/okm:personal/{userId}”.

Nota

Por ejemplo, si el método lo ejecuta el usuario “okmAdmin”, la carpeta devuelta será “/okm:personal/okmAdmin”.

• 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();
        }
    }
}

getMailFolder

Descripción:

Método	Valores de retorno	Descripción
getMailFolder()	Folder	Devuelve el objeto Folder del nodo “/okm:mail/{userId}”.

Nota

Por ejemplo, si el método lo ejecuta el usuario “okmAdmin”, la carpeta devuelta será “/okm:mail/okmAdmin”.

• 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();
        }
    }
}

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

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

Descripción:

Método	Valores de retorno	Descripción
purgeTrash()	void	Purga definitivamente todos los nodos de “/okm:trash/{userId}”

Nota

Por ejemplo, si el método lo ejecuta el usuario “okmAdmin”, la papelera purgada será “/okm:trash/okmAdmin”.

Precaución

Cuando se purga un nodo, solo puede restaurarse a partir de una copia de seguridad anterior del repositorio. La acción de purga elimina el nodo de forma permanente del repositorio.

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

Descripción:

Método	Valores de retorno	Descripción
getUpdateMessage()	String	Recupera un mensaje en caso de que exista una versión más reciente de OpenKM.

Nota

El mensaje más habitual es que se ha publicado una nueva versión de OpenKM.

• Existe un servicio oficial de mensajes de actualización de OpenKM basado en su 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

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

Descripción:

Método	Valores de retorno	Descripción
hasNode(String nodeId)	Boolean	Comprueba si existe un nodo. Devuelve true cuando el nodo existe.

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

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

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

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

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

getPersonalFolderBase

Descripción:

Método	Valores de retorno	Descripción
getPersonalFolderBase()	Folder	Devuelve el objeto Folder del nodo “/okm:personal”.

Nota

Por ejemplo, si el método lo ejecuta el usuario “okmAdmin”, la papelera purgada será “/okm:personal/okmAdmin”.

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

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

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.

Nota

• Cuando el parámetro category es true, se copian los valores originales de las categorías.
• Cuando el parámetro keywords es true, se copian los valores originales de las palabras clave.
• Cuando el parámetro propertyGroups es true, se copiarán los valores originales de los grupos de metadatos.
• Cuando el parámetro notes es true, se copian los valores originales de las notas.
• Cuando el parámetro wiki es true, se copian los valores originales del wiki.

• 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

Descripción:

Método	Valores de retorno	Descripción
executeScript(InputStream is)	ScriptExecutionResult	Ejecuta un script.

Precaución

Esta acción solo puede realizarla un superusuario (usuario con ROLE_ADMIN).

• El script local - test.bsh - usado en el ejemplo de abajo:

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

Descripción:

Método	Valores de retorno	Descripción
executeSqlQuery(InputStream is)	SqlQueryResults	Ejecuta sentencias SQL.

Precaución

El script SQL solo puede contener una única sentencia SQL.

Esta acción solo puede realizarla un superusuario (usuario con ROLE_ADMIN).

• El script test.sql usado en el ejemplo de abajo:

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

Descripción:

Método	Valores de retorno	Descripción
executeHqlQuery(InputStream is)	HqlQueryResults	Ejecuta sentencias HQL.

Precaución

El script HQL solo puede contener una única sentencia HQL.

Esta acción solo puede realizarla un superusuario (usuario con ROLE_ADMIN).

• El script test.sql usado en el ejemplo de abajo:

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

getConfiguration

Descripción:

Método	Valores de retorno	Descripción
getConfiguration(String key)	Configuration	Recupera el valor de un parámetro de configuración.

Peligro

Si su versión de OpenKM dispone del parámetro de configuración denominado “webservices.visible.properties”, el acceso a los parámetros de configuración quedará restringido para los usuarios no administradores. Esto significa que cualquier usuario no administrador que intente acceder a parámetros de configuración a través de los webservices que no figuren en “webservices.visible.properties” recibirá una excepción de acceso denegado.

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