OKMProperty

Conceptos básicos

En la mayoría de los métodos verá un parámetro llamado “nodeId”. El valor de este parámetro puede ser un UUID o una ruta válidos de documento, carpeta, correo o registro.

Sobre el parámetro llamado “catId”, el valor de este parámetro puede ser el UUID o la ruta de un nodo válido de la carpeta de categorías.

Además, en todos los métodos verá un parámetro llamado “token”. Al acceder a la aplicación a través de SOAP, el proceso de inicio de sesión devuelve un token que se utiliza para identificar al usuario en todos los métodos expuestos. Desde el contexto de ejecución por defecto de la aplicación debe utilizar el valor “null”, que indica a la aplicación que debe utilizar la “sesión del usuario”.

Métodos

addCategory

Descripción:

Método	Valores devueltos	Descripción
addCategory(String token, String nodeId, String catId)	void	Establece una relación entre una categoría y un nodo.

Ejemplo:

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

Descripción:

Método	Valores devueltos	Descripción
removeCategory(String token, String nodeId, String catId)	void	Elimina una relación entre una categoría y un nodo.

Ejemplo:

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

Descripción:

Método	Valores devueltos	Descripción
addKeyword(String token, String nodeId, String keyword)	String	Añade una palabra clave a un nodo.

La palabra clave debe ser una sola palabra sin espacios; formatos permitidos:

Ejemplo:

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

Descripción:

Método	Valores devueltos	Descripción
removeKeyword(String token, String nodeId, String keyword)	void	Elimina una palabra clave de un nodo.

Ejemplo:

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

Descripción:

Método	Valores devueltos	Descripción
setEncryption(String token, String nodeId, String cipherName)	void	Marca un documento como dato binario cifrado en el repositorio.

El parámetro nodeId debe ser un nodo de documento.
El parámetro cipherName guarda información sobre el mecanismo de cifrado.

Ejemplo:

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

Descripción:

Método	Valores devueltos	Descripción
unsetEncryption(String token, String nodeId)	void	Marca un documento como dato binario normal en el repositorio.

El parámetro nodeId debe ser un nodo de documento.

Ejemplo:

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

Descripción:

Método	Valores devueltos	Descripción
setSigned(String token, String nodeId, boolean signed)	void	Marca un documento como dato binario firmado o sin firmar en el repositorio.

El parámetro nodeId debe ser un nodo de documento.

Ejemplo:

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