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 el UUID válido de un documento, una carpeta, un correo o un expediente.

Consejo

Ejemplo de nodeId:

• Utilizando UUID -> “b153c4b7-3d1c-4589-bd42-0ed0f34fd338”;

Para el parámetro llamado “catId”, el valor de este parámetro puede ser el UUID válido de un nodo de carpeta de categoría.

Consejo

Ejemplo de nodeId:

• Utilizando UUID -> “5cbc35fc-23c0-48f5-a7bc-3cfa1e7be25f”;

Asimismo, en todos los métodos verá un parámetro llamado “token”. Dado que las tareas cron se ejecutan en segundo plano sin autenticación, los métodos utilizados en este escenario pueden emplear el parámetro token. Desde el contexto de ejecución predeterminado de la aplicación debe utilizar el valor “null”, que indica que la aplicación debe usar la “sesión de usuario”.

Consejo

En casos especiales puede ser “promovido a Administrador” mediante el “token de administrador”.

String systemToken = DbSessionManager.getInstance().getSystemToken();

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;
import com.openkm.util.ContextWrapper;

public class Test {

    public static void main(String[] args) {
        try {
            OKMProperty okmProperty = ContextWrapper.getContext().getBean(OKMProperty.class);
            okmProperty.addCategory(null, "b153c4b7-3d1c-4589-bd42-0ed0f34fd338", "5cbc35fc-23c0-48f5-a7bc-3cfa1e7be25f");
        } 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;
import com.openkm.util.ContextWrapper;

public class Test {

    public static void main(String[] args) {
        try {
            OKMProperty okmProperty = ContextWrapper.getContext().getBean(OKMProperty.class);
            okmProperty.removeCategory(null, "b153c4b7-3d1c-4589-bd42-0ed0f34fd338", "5cbc35fc-23c0-48f5-a7bc-3cfa1e7be25f");
        } 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.

Nota

También le sugerimos que añada las palabras clave en minúsculas, porque OpenKM distingue entre mayúsculas y minúsculas.

• La palabra clave debe ser una única palabra sin espacios, formatos permitidos:

Ejemplo:

package com.openkm;

import com.openkm.api.OKMProperty;
import com.openkm.util.ContextWrapper;

public class Test {

    public static void main(String[] args) {
        try {
            OKMProperty okmProperty = ContextWrapper.getContext().getBean(OKMProperty.class);
            String keyword = okmProperty.addKeyword(null, "b153c4b7-3d1c-4589-bd42-0ed0f34fd338", "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;
import com.openkm.util.ContextWrapper;

public class Test {

    public static void main(String[] args) {
        try {
            OKMProperty okmProperty = ContextWrapper.getContext().getBean(OKMProperty.class);
            okmProperty.removeKeyword(null, "b153c4b7-3d1c-4589-bd42-0ed0f34fd338", "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 datos binarios cifrados en el repositorio.

Precaución

Este método no realiza ningún tipo de cifrado; simplemente marca en la base de datos que un documento está cifrado.

• 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;
import com.openkm.util.ContextWrapper;

public class Test {

    public static void main(String[] args) {
        try {
            OKMProperty okmProperty = ContextWrapper.getContext().getBean(OKMProperty.class);
            okmProperty.setEncryption(null, "b153c4b7-3d1c-4589-bd42-0ed0f34fd338", "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 datos binarios normales en el repositorio.

Precaución

Este método no realiza ningún tipo de cifrado; simplemente marca en la base de datos que un documento no está cifrado.

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

Ejemplo:

package com.openkm;

import com.openkm.api.OKMProperty;
import com.openkm.util.ContextWrapper;

public class Test {

    public static void main(String[] args) {
        try {
            OKMProperty okmProperty = ContextWrapper.getContext().getBean(OKMProperty.class);
            okmProperty.unsetEncryption(null, "b153c4b7-3d1c-4589-bd42-0ed0f34fd338");
        } 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 datos binarios firmados o sin firmar en el repositorio.

Precaución

Este método no realiza ningún proceso de firma digital; simplemente marca en la base de datos que un documento está firmado.

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

Ejemplo:

package com.openkm;

import com.openkm.api.OKMProperty;
import com.openkm.util.ContextWrapper;

public class Test {

    public static void main(String[] args) {
        try {
            OKMProperty okmProperty = ContextWrapper.getContext().getBean(OKMProperty.class);
            okmProperty.setSigned(null, "b153c4b7-3d1c-4589-bd42-0ed0f34fd338", true);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

isSigned

Descripción:

Método	Valores devueltos	Descripción
isSigned(String token, String nodeId)	boolean	Devuelve un valor booleano que indica si el documento está firmado.

Precaución

Este método se añadió en la versión 7.1.28 de OpenKM.

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

Ejemplo:

package com.openkm;

import com.openkm.api.OKMProperty;
import com.openkm.util.ContextWrapper;

public class Test {

    public static void main(String[] args) {
        try {
            OKMProperty okmProperty = ContextWrapper.getContext().getBean(OKMProperty.class);
            System.out.println("Is the document signed: " + okmProperty.isSigned(null, "6330d2a0-529f-4c14-baa1-ce6a92004e01"));
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}