Property samples

Aspectos 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 (path) válidos de documento, carpeta, correo o expediente.

Consejo

Ejemplo de nodeId:

• Usando UUID -> “f123a950-0329-4d62-8328-0ff500fd42db”;
• Usando path -> “/okm:root/logo.png”

Métodos

addCategory

Descripción:

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

El valor del parámetro catId debe ser el UUID o la ruta (path) de una carpeta de categoría.

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.addCategory("/okm:root/logo.png", "/okm:categories/test");
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

removeCategory

Descripción:

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

El valor del parámetro catId debe ser el UUID o la ruta (path) de una carpeta de categoría.

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.removeCategory("/okm:root/logo.png", "/okm:categories/test");
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

addKeyword

Descripción:

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

La palabra clave debe ser una única palabra sin espacios. Formatos permitidos:

• “test”
• “two_words” (el carácter “_” se usa como separador).

Nota

También le recomendamos añadir las palabras clave en minúsculas, ya que OpenKM distingue entre mayúsculas y minúsculas.

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.addKeyword("/okm:root/logo.png", "test");
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

removeKeyword

Descripción:

Método	Valores de retorno	Descripción
removeKeyword(String nodeId, String keyword)	void	Elimina una palabra clave de un 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.removeKeyword("/okm:root/logo.png", "test");
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

setEncryption

Descripción:

Método	Valores de retorno	Descripción
setEncryption(String nodeId, String cipherName)	void	Marca un documento como datos binarios cifrados en el repositorio.

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

El parámetro cipherName almacena información sobre el mecanismo de cifrado.

Precaución

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

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.setEncryption("/okm:root/logo.png", "phrase");
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

unsetEncryption

Descripción:

Método	Valores de retorno	Descripción
unsetEncryption(String nodeId)	void	Marca un documento como datos binarios normales en el repositorio.

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

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.

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.unsetEncryption("/okm:root/logo.png");
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

setSigned

Descripción:

Método	Valores de retorno	Descripción
setSigned(String nodeId, boolean signed)	void	Marca un documento como datos binarios firmados o sin firmar en el repositorio.

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

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.

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.setSigned("/okm:root/logo.pdf", true);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}