Repository samples

Aspectos básicos

Ejemplo de código sugerido

Primero, debe crear el objeto webservice:

OKMWebservices ws = OKMWebservicesFactory.getInstance(host);

A continuación, debe iniciar sesión utilizando el método “login”. Puede acceder al método “login” desde el objeto webservice “ws” como se muestra a continuación:

ws.login(user, password);

Precaución

Una vez que ha iniciado sesión en el webservice, la sesión se mantiene en el objeto webservice. A partir de entonces puede utilizar el resto de métodos de la API.

Llegados a este punto puede utilizar todos los métodos de Repository desde la clase “repository” como se muestra a continuación:

ws.repository.getAppVersion();

Métodos

getRootFolder

Descripción:

Método	Valores devueltos	Descripción
getRootFolder()	Folder	Devuelve el objeto Folder del nodo “/okm:root”.

Ejemplo:

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

Descripción:

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

La carpeta devuelta será la papelera del usuario.

Nota

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

Ejemplo:

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

Descripción:

Método	Valores devueltos	Descripción
getTrashFolderBase()	Folder	Devuelve el objeto Folder del nodo “/okm:trash”.

Ejemplo:

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

Descripción:

Método	Valores devueltos	Descripción
getTemplatesFolder()	Folder	Devuelve el objeto Folder del nodo “/okm:templates”.

Ejemplo:

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

Descripción:

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

La carpeta devuelta será la carpeta personal del usuario.

Nota

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

Ejemplo:

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

Descripción:

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

Ejemplo:

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

Descripción:

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

La carpeta devuelta será la carpeta de correo del usuario.

Nota

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

Ejemplo:

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

Descripción:

Método	Valores devueltos	Descripción
getMailFolderBase()	Folder	Devuelve el objeto Folder del nodo “/okm:mail”.

Ejemplo:

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

Descripción:

Método	Valores devueltos	Descripción
getCategoriesFolder()	Folder	Devuelve el objeto Folder del nodo “/okm:categories”.

Ejemplo:

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

Descripción:

Método	Valores devueltos	Descripción
purgeTrash()	void	Elimina permanentemente del repositorio 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 purgar elimina el nodo del repositorio de forma permanente.

Ejemplo:

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

Descripción:

Método	Valores devueltos	Descripción
getUpdateMessage()	String	Recupera un mensaje cuando hay disponible una nueva versión de OpenKM.

Ejemplo:

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

Descripción:

Método	Valores devueltos	Descripción
getRepositoryUuid()	String	Recupera el identificador único de la instalación.

Ejemplo:

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

Descripción:

Método	Valores devueltos	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.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

Descripción:

Método	Valores devueltos	Descripción
getNodePath(String uuid)	String	Convierte un UUID de nodo en una ruta.

Ejemplo:

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

Descripción:

Método	Valores devueltos	Descripción
getNodeUuid(String nodePath)	String	Convierte una ruta de nodo en un UUID.

Ejemplo:

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

Descripción:

Método	Valores devueltos	Descripción
getAppVersion()	AppVersion	Devuelve información sobre la versión de OpenKM.

Ejemplo:

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

Descripción:

Método	Valores devueltos	Descripción
copyAttributes(String uuid, String dstId, boolean categories, boolean keywords, boolean propertyGroups, boolean notes)	void	Copia los atributos de un nodo a otro.

El valor del parámetro dstId debe ser el UUID de un nodo.

Nota

• Cuando el parámetro categories es true, se copiarán los valores originales de las categorías.
• Cuando el parámetro keywords es true, se copiarán 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 copiarán los valores originales de las notas.

Ejemplo:

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

Descripción:

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

El script local - test.bsh - utilizado en el ejemplo siguiente:

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

// También se puede devolver un valor como string
return "test result";

Precaución

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

Ejemplo:

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

Descripción:

Método	Valores devueltos	Descripción
executeScript(String script)	ScriptExecutionResult	Ejecuta un script.

Precaución

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

Ejemplo:

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

Descripción:

Método	Valores devueltos	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;

Precaución

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

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

Ejemplo:

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

También se puede establecer el InputStream de la siguiente forma:

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

executeSqlQuery

Descripción:

Método	Valores devueltos	Descripción
executeSqlQuery(String sql)	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).

Ejemplo:

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

Descripción:

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

El script test.sql utilizado en el ejemplo siguiente:

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

Precaución

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

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

Ejemplo:

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

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

executeHqlQuery

Descripción:

Método	Valores devueltos	Descripción
executeHqlQuery(String hql)	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).

Ejemplo:

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

Descripción:

Método	Valores devueltos	Descripción
getTranslations(String lang, String module)	Map<String, String>	Recupera las traducciones de un módulo en un Map de valores.

Nota

Las tablas de traducciones de OpenKM se pueden utilizar para recuperar las traducciones actuales de OpenKM o para crear traducciones propias (insertando valores en un nuevo módulo).

Por defecto, los valores de módulo son:

• frontend (utilizado por la interfaz de usuario de OpenKM por defecto).
• extension (utilizado por la interfaz de usuario de la extensión de OpenKM).
• mobile (utilizado por la interfaz de usuario móvil de OpenKM).

Ejemplo para añadir un nuevo módulo de traducción:

Valores SQL a ejecutar desde la vista Database query:

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

El código quedaría entonces así:

Map<String, String> translations = ws.getTranslations("en-GB", "doc");

Ejemplo:

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

Descripción:

Método	Valores devueltos	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.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

Descripción:

Método	Valores devueltos	Descripción
getChangeLog(String nodePath, Calendar modificationsFrom)	List	Devuelve la lista de cambios de una ruta y sus subcarpetas.

Consejo

• El método lo utiliza la aplicación de sincronización de escritorio para recuperar los cambios.

Ejemplo:

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

Descripción:

Método	Valores devueltos	Descripción
getServerTime()	String	Devuelve la hora actual del servidor.

Nota

La hora del servidor devuelta está en formato ISO8601.

Consejo

• El método lo utiliza la aplicación de sincronización de escritorio para recuperar los cambios.

Ejemplo:

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

Descripción:

Método	Valores devueltos	Descripción
getAvailableLocales(String locale)	Map<String, String>	Devuelve los idiomas disponibles.

Ejemplo:

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

getLicenseInfo()

Descripción:

Método	Valores devueltos	Descripción
getLicenseInfo()	LicenseInfo	Devuelve información sobre la licencia.

Ejemplo:

package com.openkm;

import com.openkm.sdk4j.OKMWebservicesFactory;
import com.openkm.sdk4j.bean.LicenseInfo;
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);
            LicenseInfo licenseInfo = ws.repository.getLicenseInfo();
            System.out.println(licenseInfo);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getClusterUuid()

Descripción:

Método	Valores devueltos	Descripción
getClusterUuid()	String	Devuelve el UUID del clúster.

Ejemplo:

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

createShortenUrl()

Descripción:

Método	Valores devueltos	Descripción
createShortenUrl(String name, String url)	String	Devuelve la URL acortada.

Si la variable name no está vacía, la URL se generará utilizando ese valor como clave. En caso contrario, se utilizará una clave generada aleatoriamente.

Ejemplo:

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);
            String shortenURL = ws.repository.createShortenUrl("test1", "https://www.openkm.com");
            System.out.println(shortenURL);
            shortenURL = ws.repository.createShortenUrl("", "https://www.openkm.com");
            System.out.println(shortenURL);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}