Ejemplos de Property

Conceptos básicos

El valor de este parámetro puede ser un UUID válido de documento, carpeta, correo o expediente.

Consejo

Ejemplo de nodeId:

• Usando UUID -> “f123a950-0329-4d62-8328-0ff500fd42db”;

Ejemplo de código sugerido

Primero, debes crear el objeto de servicio web:

OKMWebservices ws = OKMWebservicesFactory.getInstance(host);

A continuación debes iniciar sesión usando el método “login”. Puedes acceder al método “login” desde el objeto de servicio web “ws” como se muestra a continuación:

ws.login(user, password);

Precaución

Una vez que has iniciado sesión en los servicios web, la sesión se mantiene en el objeto de servicio web. A partir de ahí puedes usar el resto de métodos de la API.

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

ws.property.addCategory("eee9d70f-6af9-4783-82a7-b8ac94c234b6", "58c9b25f-d83e-4006-bd78-e26d7c6fb648");

Métodos

addCategory

Descripción:

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

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.property.addCategory("eee9d70f-6af9-4783-82a7-b8ac94c234b6", "58c9b25f-d83e-4006-bd78-e26d7c6fb648");
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

removeCategory

Descripción:

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

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.property.removeCategory("eee9d70f-6af9-4783-82a7-b8ac94c234b6", "58c9b25f-d83e-4006-bd78-e26d7c6fb648");
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

addKeyword

Descripción:

Método	Valores de retorno	Descripción
addKeyword(String uuid, String keyword)	void	Añade una palabra clave a un nodo.

Nota

También sugerimos añadir las palabras clave en minúsculas, ya que 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.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.property.addKeyword("eee9d70f-6af9-4783-82a7-b8ac94c234b6", "test");
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

removeKeyword

Descripción:

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

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.property.removeKeyword("eee9d70f-6af9-4783-82a7-b8ac94c234b6", "test");
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

setEncryption

Descripción:

Método	Valores de retorno	Descripción
setEncryption(String uuid, 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 tipo documento.
• El parámetro cipherName almacena información sobre el mecanismo de cifrado.

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.property.setEncryption("eee9d70f-6af9-4783-82a7-b8ac94c234b6", "phrase");
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

unsetEncryption

Descripción:

Método	Valores de retorno	Descripción
unsetEncryption(String uuid)	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 uuid debe ser un nodo de tipo documento.

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.property.unsetEncryption("eee9d70f-6af9-4783-82a7-b8ac94c234b6");
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

setSigned

Descripción:

Método	Valores de retorno	Descripción
setSigned(String uuid, boolean signed)	void	Marca un documento como firmado o no firmado 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 uuid debe ser un nodo de tipo documento.

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.property.setSigned("eee9d70f-6af9-4783-82a7-b8ac94c234b6", true);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

isSigned

Descripción:

Método	Valores de retorno	Descripción
isSigned(String uuid)	boolean	Devuelve un booleano que indica si el documento está firmado.

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

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("Is the document signed: " + ws.property.isSigned("6330d2a0-529f-4c14-baa1-ce6a92004e01"));
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}