OKMNode

Fundamentos

En casi todos los métodos verá un parámetro llamado “nodeId”. El valor de este parámetro puede ser un UUID de nodo válido.

Consejo

Ejemplo de docId:

• Usando UUID -> “c41f9ea0-0d6c-45da-bae4-d72b66f42d0f”;

Sobre el parámetro llamado “fldId”, el valor de este parámetro puede ser un UUID de carpeta válido o un nodo de tipo record.

Consejo

Ejemplo de fldId:

• Usando UUID -> “c6785440-0d6c-45da-1234-d9874563d0f”;

Sobre el parámetro llamado “dstId”, el valor de este parámetro puede ser un UUID de carpeta válido o un nodo de tipo record.

Consejo

Ejemplo de dstId:

• Usando UUID -> “c4455667-0d6c-45da-1234-d98564323e0”;

Además, en todos los métodos verá un parámetro llamado “token”. Como las tareas de crontab se ejecutan en segundo plano sin autenticación, los métodos usados en ese escenario pueden usar el parámetro token. Desde el contexto de ejecución por defecto de la aplicación, debe usar el valor “null”, que indica que la aplicación debe usar la “sesión del usuario”.

Consejo

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

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

Métodos

getNodeByUuid

Descripción:

Método	Valores de retorno	Descripción
getNodeByUuid(String token, String uuid)	Node	Obtiene un nodo por UUID.

Ejemplo:

package com.openkm;

import com.openkm.api.OKMNode;
import com.openkm.bean.Node;
import com.openkm.util.ContextWrapper;

public class Test {

    public static void main(String[] args) {
        try {
            OKMNode okmNode = ContextWrapper.getContext().getBean("okmNode", OKMNode.class);
            Node node = okmNode.getNodeByUuid(null, "78f9c377-e557-48c7-804e-35c0ca284739");
            System.out.println(node);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getVersionHistory

Descripción:

Método	Valores de retorno	Descripción
getVersionHistory(String token, String nodeId)	List	Devuelve la lista del historial de versiones de un nodo.

Ejemplo:

package com.openkm;

import java.util.List;

import com.openkm.api.OKMNode;
import com.openkm.bean.Version;
import com.openkm.util.ContextWrapper;

public class Test {

    public static void main(String[] args) {
        try {
            OKMNode okmNode = ContextWrapper.getContext().getBean("okmNode", OKMNode.class);
            List<Version> versions = okmNode.getVersionHistory(null, "78f9c377-e557-48c7-804e-35c0ca284739");
            for (Version version : versions) {
                System.out.println(version);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

restoreVersion

Descripción:

Método	Valores de retorno	Descripción
restoreVersion(String token, String nodeId, String versionId)	void	Restaura la versión de un nodo.

Ejemplo:

package com.openkm;

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

public class Test {

    public static void main(String[] args) {
        try {
            OKMNode okmNode = ContextWrapper.getContext().getBean("okmNode", OKMNode.class);
            okmNode.restoreVersion(null, "78f9c377-e557-48c7-804e-35c0ca284739", "1.2");
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

renameVersion

Descripción:

Método	Valores de retorno	Descripción
renameVersion(String token, String nodeId, String versionId, String newName)	void	Renombra la versión de un nodo.

Ejemplo:

package com.openkm;

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

public class Test {

    public static void main(String[] args) {
        try {
            OKMNode okmNode = ContextWrapper.getContext().getBean("okmNode", OKMNode.class);
            okmNode.renameVersion(null, "78f9c377-e557-48c7-804e-35c0ca284739", "1.2", "newName");
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

deleteVersion

Descripción:

Método	Valores de retorno	Descripción
deleteVersion(String token, String nodeId, String versionId)	void	Elimina una versión específica de un nodo.

Ejemplo:

package com.openkm;

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

public class Test {

    public static void main(String[] args) {
        try {
            OKMNode okmNode = ContextWrapper.getContext().getBean("okmNode", OKMNode.class);
            okmNode.deleteVersion(null, "78f9c377-e557-48c7-804e-35c0ca284739", "1.2");
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

purgeVersionHistory

Descripción:

Método	Valores de retorno	Descripción
purgeVersionHistory(String token, String nodeId)	void	Purga el historial de versiones de un nodo.

Ejemplo:

package com.openkm;

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

public class Test {

    public static void main(String[] args) {
        try {
            OKMNode okmNode = ContextWrapper.getContext().getBean("okmNode", OKMNode.class);
            okmNode.purgeVersionHistory(null, "3767deb4-21e7-4272-82be-fece5384fbab");
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

compactVersion

Descripción:

Método	Valores de retorno	Descripción
compactVersion(String token, String nodeId, String versionId)	Version	Combina la versión indicada de un nodo con la inmediatamente anterior en una única entrada del historial. Esto solo funciona cuando, entre la versión indicada y su predecesora, una de las dos es una operación de contenido (creación de documento/record, o un check-in de documento) y la otra es una operación de grupo de propiedades (se añadió un grupo o se cambiaron sus propiedades), en cualquier orden. La fila de la versión indicada se conserva, manteniendo el contenido y las propiedades combinados, y la versión predecesora se elimina del historial.

Ejemplo:

package com.openkm;

import com.openkm.api.OKMNode;
import com.openkm.bean.Version;
import com.openkm.util.ContextWrapper;

public class Test {

    public static void main(String[] args) {
        try {
            OKMNode okmNode = ContextWrapper.getContext().getBean("okmNode", OKMNode.class);
            Version version = okmNode.compactVersion(null, "78f9c377-e557-48c7-804e-35c0ca284739", "1.2");
            System.out.println(version);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

mayBePromotedAsRecord

Descripción:

Método	Valores de retorno	Descripción
mayBePromotedAsRecord(String token, String nodeId, boolean fullEvaluation)	PromoteAsRecordEvaluation	Devuelve el resultado de la evaluación para promover un nodo al estado de “record”. Cuando el nodo no puede promoverse al estado de “record”, el resultado de la evaluación contiene información sobre el motivo por el que no puede promoverse.

Ejemplo:

package com.openkm;

import com.openkm.api.OKMNode;
import com.openkm.plugin.fileplan.record.bean.PromoteAsRecordEvaluation;
import com.openkm.util.ContextWrapper;

public class Test {

    public static void main(String[] args) {
        try {
            OKMNode okmNode = ContextWrapper.getContext().getBean("okmNode", OKMNode.class);
            PromoteAsRecordEvaluation pre = okmNode.mayBePromotedAsRecord(null, "3767deb4-21e7-4272-82be-fece5384fbab", false);
            System.out.println(pre);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

promoteAsRecord

Descripción:

Método	Valores de retorno	Descripción
promoteAsRecord(String token, String nodeId)	void	Promueve el nodo al estado de “record”.

Ejemplo:

package com.openkm;

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

public class Test {

    public static void main(String[] args) {
        try {
            OKMNode okmNode = ContextWrapper.getContext().getBean("okmNode", OKMNode.class);
            okmNode.promoteAsRecord(null, "3767deb4-21e7-4272-82be-fece5384fbab");
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

degradeRecord

Descripción:

Método	Valores de retorno	Descripción
degradeRecord(String token, String nodeId)	void	Degrada un nodo con estado de “record”.

Precaución

Esta acción solo puede realizarla un administrador.

Ejemplo:

package com.openkm;

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

public class Test {

    public static void main(String[] args) {
        try {
            OKMNode okmNode = ContextWrapper.getContext().getBean("okmNode", OKMNode.class);
            okmNode.degradeRecord(null, "3767deb4-21e7-4272-82be-fece5384fbab");
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

isElectronicRecordPath

Descripción:

Método	Valores de retorno	Descripción
isElectronicRecordPath(String token, String nodeId)	boolean	Devuelve true cuando el nodo está dentro de un electronic record.

Nota

Devuelve true cuando uno de los padres del nodo es un electronic record.

Ejemplo:

package com.openkm;

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

public class Test {

    public static void main(String[] args) {
        try {
            OKMNode okmNode = ContextWrapper.getContext().getBean("okmNode", OKMNode.class);
            System.out.println(okmNode.isElectronicRecordPath(null, "3767deb4-21e7-4272-82be-fece5384fbab"));
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getElectronicRecordInPath

Descripción:

Método	Valores de retorno	Descripción
getElectronicRecordInPath(String token, String nodeId)	Record	Obtiene el electronic record en la ruta del nodo.

Nota

Devuelve el primer electronic record en la ruta del nodo.

Ejemplo:

package com.openkm;

import com.openkm.api.OKMNode;
import com.openkm.bean.Record;
import com.openkm.util.ContextWrapper;

public class Test {

    public static void main(String[] args) {
        try {
            OKMNode okmNode = ContextWrapper.getContext().getBean("okmNode", OKMNode.class);
            Record record = okmNode.getElectronicRecordInPath(null, "3767deb4-21e7-4272-82be-fece5384fbab");
            System.out.println(record);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getChildrenPaginated

Descripción:

Método	Valores de retorno	Descripción
getChildrenPaginated(String token, String nodeId, int offset, int limit, String filter, String orderByField, boolean orderAsc, List<Class<? extends NodeBase>> filteredByNodeTypeList, String pluginName)	PageInfo	Obtiene los nodos hijos, paginados.

Consejo

Los parámetros “limit” y “offset” permiten recuperar solo una parte de los resultados de una consulta.

• El parámetro “limit” se usa para limitar el número de resultados devueltos.
• El parámetro “offset” especifica cuántos resultados omitir antes de empezar a devolver resultados.

El parámetro “orderByField” puede tener los siguientes valores: name o created.

Nota

Por ejemplo, si su consulta tiene 1000 resultados, pero solo quiere devolver los primeros 10, debe usar estos valores:

• limit=10
• offset=0

Ahora suponga que quiere mostrar los resultados del 11 al 20; debe usar estos valores:

• limit=10
• offset=10

Ejemplo:

package com.openkm;

import java.util.ArrayList;
import java.util.List;

import com.openkm.api.OKMNode;
import com.openkm.bean.PageInfo;
import com.openkm.db.bean.NodeBase;
import com.openkm.db.bean.NodeDocument;
import com.openkm.db.bean.NodeFolder;
import com.openkm.db.bean.NodeMail;
import com.openkm.db.bean.NodeRecord;
import com.openkm.util.ContextWrapper;

public class Test {

    public static void main(String[] args) {
        try {
            OKMNode okmNode = ContextWrapper.getContext().getBean("okmNode", OKMNode.class);
            List<Class<? extends NodeBase>> filteredByNodeTypeList = new ArrayList<>();
            filteredByNodeTypeList.add(NodeDocument.class);
            filteredByNodeTypeList.add(NodeFolder.class);
            filteredByNodeTypeList.add(NodeMail.class);
            filteredByNodeTypeList.add(NodeRecord.class);

            // nodeId Folder and Record UUID or Path
            String nodeId = "39479efe-de5e-468e-91a7-24d2aa3f8837";
            String orderByField = "created";
            boolean orderAsc = true;
            PageInfo pageInfo = okmNode.getChildrenPaginated(null, nodeId, 0, 10, "", orderByField, orderAsc,
                    filteredByNodeTypeList, null);
            System.out.println("Filtered Elements: " + pageInfo.getFilteredElements());
            System.out.println("Total Elements: " + pageInfo.getTotalElements());
            for (Object object : pageInfo.getObjects()) {
                NodeBase nodeBase = (NodeBase) object;
                System.out.println(nodeBase.getPath());
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getChildrenByCategoryPaginated

Descripción:

Método	Valores de retorno	Descripción
getChildrenByCategoryPaginated(String token, String nodeId, int offset, int limit, String filter, String orderByField, boolean orderAsc, List<Class<? extends NodeBase>> filteredByNodeTypeList, String pluginName)	PageInfo	Obtiene los nodos hijos por categoría, paginados.

Consejo

Los parámetros “limit” y “offset” permiten recuperar solo una parte de los resultados de una consulta.

• El parámetro “limit” se usa para limitar el número de resultados devueltos.
• El parámetro “offset” especifica cuántos resultados omitir antes de empezar a devolver resultados.

El parámetro “orderByField” puede tener los siguientes valores: name o created.

Nota

Por ejemplo, si su consulta tiene 1000 resultados, pero solo quiere devolver los primeros 10, debe usar estos valores:

• limit=10
• offset=0

Ahora suponga que quiere mostrar los resultados del 11 al 20; debe usar estos valores:

• limit=10
• offset=10

Ejemplo:

package com.openkm;

import java.util.ArrayList;
import java.util.List;

import com.openkm.api.OKMNode;
import com.openkm.bean.PageInfo;
import com.openkm.db.bean.NodeBase;
import com.openkm.db.bean.NodeDocument;
import com.openkm.db.bean.NodeFolder;
import com.openkm.db.bean.NodeMail;
import com.openkm.db.bean.NodeRecord;
import com.openkm.util.ContextWrapper;

public class Test {

    public static void main(String[] args) {
        try {
            OKMNode okmNode = ContextWrapper.getContext().getBean("okmNode", OKMNode.class);
            List<Class<? extends NodeBase>> filteredByNodeTypeList = new ArrayList<>();
            filteredByNodeTypeList.add(NodeDocument.class);
            filteredByNodeTypeList.add(NodeFolder.class);
            filteredByNodeTypeList.add(NodeMail.class);
            filteredByNodeTypeList.add(NodeRecord.class);

            // nodeId Folder and Record UUID or Path
            String nodeId = "39479efe-de5e-468e-91a7-24d2aa3f8837";
            String orderByField = "created";
            boolean orderAsc = true;
            PageInfo pageInfo = okmNode.getChildrenByCategoryPaginated(null, nodeId, 0, 10, "", orderByField, orderAsc,
                    filteredByNodeTypeList, null);
            System.out.println("Filtered Elements: " + pageInfo.getFilteredElements());
            System.out.println("Total Elements: " + pageInfo.getTotalElements());
            for (Object object : pageInfo.getObjects()) {
                NodeBase nodeBase = (NodeBase) object;
                System.out.println(nodeBase.getPath());
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getBreadcrumb

Descripción:

Método	Valores de retorno	Descripción
getBreadcrumb(String token, String fldId)	List	Obtiene el breadcrumb.

Ejemplo:

package com.openkm;

import java.util.List;

import com.openkm.api.OKMNode;
import com.openkm.bean.BreadCrumbItem;
import com.openkm.util.ContextWrapper;

public class Test {

    public static void main(String[] args) {
        try {
            OKMNode okmNode = ContextWrapper.getContext().getBean("okmNode", OKMNode.class);
            List<BreadCrumbItem> list = okmNode.getBreadcrumb(null, "39479efe-de5e-468e-91a7-24d2aa3f8837");
            for (BreadCrumbItem item : list) {
                System.out.println(item.getPath());
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

subscribe

Descripción:

Método	Valores de retorno	Descripción
subscribe(String token, String nodeId)	void	Añade una suscripción a un nodo.

Ejemplo:

package com.openkm;

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

public class Test {

    public static void main(String[] args) {
        try {
            OKMNode okmNode = ContextWrapper.getContext().getBean("okmNode", OKMNode.class);
            okmNode.subscribe(null, "39479efe-de5e-468e-91a7-24d2aa3f8837");
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

unsubscribe

Descripción:

Método	Valores de retorno	Descripción
unsubscribe(String token, String nodeId)	void	Elimina una suscripción de un nodo.

Ejemplo:

package com.openkm;

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

public class Test {

    public static void main(String[] args) {
        try {
            OKMNode okmNode = ContextWrapper.getContext().getBean("okmNode", OKMNode.class);
            okmNode.unsubscribe(null, "39479efe-de5e-468e-91a7-24d2aa3f8837");
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

importZip

Descripción:

Método	Valores de retorno	Descripción
importZip(String token, String fldUuid, InputStream inputStream)	void	Importa un fichero ZIP.

Ejemplo:

package com.openkm;

import java.io.FileInputStream;
import java.io.InputStream;

import org.apache.commons.io.IOUtils;

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

public class Test {

    public static void main(String[] args) {
        try {
            OKMNode okmNode = ContextWrapper.getContext().getBean("okmNode", OKMNode.class);
            InputStream is = new FileInputStream("/home/gnujavasergio/okm/import.zip");
            okmNode.importZip(null, "212e7c1f-443d-4aac-a12c-0b818ca03419", is);
            IOUtils.closeQuietly(is);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

unzip

Descripción:

Método	Valores de retorno	Descripción
unzip(String token, String uuid, String destinationPath)	void	Descomprime un fichero.

Ejemplo:

package com.openkm;

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

public class Test {

    public static void main(String[] args) {
        try {
            OKMNode okmNode = ContextWrapper.getContext().getBean("okmNode", OKMNode.class);
            String uuid = "82555dd1-bcc2-4e64-81cb-5f7c2b0d7801"; // zip File
            String destinationPath = "/okm:root/test"; // destination path
            okmNode.unzip(null, uuid, destinationPath);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

exportZip

Descripción:

Método	Valores de retorno	Descripción
exportZip(List paths, boolean withPath, boolean background, boolean excludeProperties)	ByteArrayInputStream	Exporta como un fichero ZIP.

Ejemplo:

package com.openkm;

import java.io.FileOutputStream;
import java.io.InputStream;
import java.io.OutputStream;
import java.util.ArrayList;
import java.util.List;

import org.apache.commons.io.IOUtils;

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

public class Test {

    public static void main(String[] args) {
        try {
            OKMNode okmNode = ContextWrapper.getContext().getBean("okmNode", OKMNode.class);
            List<String> uuids = new ArrayList<>();
            uuids.add("/okm:root/test/logo.png");
            uuids.add("/okm:root/test/invoice.pdf");

            OutputStream fos = new FileOutputStream("/home/openkm/import.zip");

            InputStream is = okmNode.exportZip(uuids, true, true, true);
            IOUtils.copy(is, fos);
            IOUtils.closeQuietly(is);
            IOUtils.closeQuietly(fos);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getNodesFromUuids

Descripción:

Método	Valores de retorno	Descripción
getNodesFromUuids(String token, String[] uuids)	List	Devuelve una lista de nodos.

Ejemplo:

package com.openkm;

import java.util.List;

import com.openkm.api.OKMNode;
import com.openkm.bean.Node;
import com.openkm.util.ContextWrapper;

public class Test {

    public static void main(String[] args) {
        try {
            OKMNode okmNode = ContextWrapper.getContext().getBean("okmNode", OKMNode.class);
            String[] uuids = {"0f6463f3-4d36-4091-b518-4fe7c353ee70", "d386cff8-1d4d-472f-9c6d-f21955ec499a"};
            List<Node> nodes = okmNode.getNodesFromUuids(null, uuids);
            for (Node node : nodes) {
                System.out.println(node);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

evaluateZipDownload

Descripción:

Método	Valores de retorno	Descripción
evaluateZipDownload(String token, List uuids)	ZipDownloadEvaluationResult	Evalúa si un fichero ZIP puede descargarse en tiempo real o en segundo plano.

Nota

Parámetros de configuración relacionados:

• download.zip.live.max.file.size
• download.zip.live.max.files

Más información en Performance configuration parameters

Ejemplo:

package com.openkm;

import java.util.ArrayList;
import java.util.List;

import com.openkm.api.OKMNode;
import com.openkm.bean.ZipDownloadEvaluationResult;
import com.openkm.util.ContextWrapper;

public class Test {

    public static void main(String[] args) {
        try {
            OKMNode okmNode = ContextWrapper.getContext().getBean("okmNode", OKMNode.class);
            List<String> uuids = new ArrayList<>();
            uuids.add("0f6463f3-4d36-4091-b518-4fe7c353ee70");
            uuids.add("d386cff8-1d4d-472f-9c6d-f21955ec499a");

            ZipDownloadEvaluationResult result = okmNode.evaluateZipDownload(null, uuids);
            System.out.println(result);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

restore

Descripción:

Método	Valores de retorno	Descripción
restore(String token, String nodeId)	Node	Restaura un nodo desde la papelera.

Nota

Cuando un nodo se mueve a la papelera, la aplicación conserva la ubicación original. Cuando sea posible, la aplicación intentará restaurarlo en la misma ubicación original (a veces esto no es posible porque la ubicación original ya no existe o la configuración de seguridad ha cambiado, etc.).

Ejemplo:

package com.openkm;

import com.openkm.api.OKMNode;
import com.openkm.bean.Node;
import com.openkm.util.ContextWrapper;

public class Test {

    public static void main(String[] args) {
        try {
            OKMNode okmNode = ContextWrapper.getContext().getBean("okmNode", OKMNode.class);
            Node node = okmNode.restore(null, "0f6463f3-4d36-4091-b518-4fe7c353ee70");
            System.out.println(node);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

hasNodesLockedByOtherUser

Descripción:

Método	Valores de retorno	Descripción
hasNodesLockedByOtherUser(String token, String nodeId)	boolean	Comprueba si el nodo y sus descendientes han sido bloqueados por otros usuarios.

Nota

Este método se usa para evaluar si es posible bloquear una jerarquía. Por ejemplo, en el caso de un record, el bloqueo afecta a todos los nodos dentro de él.

Ejemplo:

package com.openkm;

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

public class Test {

    public static void main(String[] args) {
        try {
            OKMNode okmNode = ContextWrapper.getContext().getBean("okmNode", OKMNode.class);
            if (okmNode.hasNodesLockedByOtherUser(null, "0f6463f3-4d36-4091-b518-4fe7c353ee70")) {
                System.out.println("Is blocked");
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

lock

Descripción:

Método	Valores de retorno	Descripción
lock(String token, String nodeId)	LockInfo	Bloquea un nodo y devuelve un objeto con la información del bloqueo.

Precaución

Solo el usuario que bloqueó el documento puede desbloquearlo.

Un documento bloqueado no puede ser modificado por otros usuarios.

Ejemplo:

package com.openkm;

import com.openkm.api.OKMNode;
import com.openkm.bean.LockInfo;
import com.openkm.util.ContextWrapper;

public class Test {

    public static void main(String[] args) {
        try {
            OKMNode okmNode = ContextWrapper.getContext().getBean("okmNode", OKMNode.class);
            LockInfo lockInfo = okmNode.lock(null, "1ec49da9-1746-4875-ae32-9281d7303a62");
            System.out.println(lockInfo);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

forceLock

Descripción:

Método	Valores de retorno	Descripción
forceLock(String token, String nodeId)	LockInfo	Bloquea un nodo, sobrescribiendo cualquier bloqueo existente. Devuelve la nueva información del bloqueo.

Precaución

Esta acción solo puede realizarla un usuario con privilegios de administrador.

• Este método permite bloquear cualquier nodo ya bloqueado.

Ejemplo:

package com.openkm;

import com.openkm.api.OKMNode;
import com.openkm.bean.LockInfo;
import com.openkm.util.ContextWrapper;

public class Test {

    public static void main(String[] args) {
        try {
            OKMNode okmNode = ContextWrapper.getContext().getBean("okmNode", OKMNode.class);
            LockInfo lockInfo = okmNode.forceLock(null, "1ec49da9-1746-4875-ae32-9281d7303a62");
            System.out.println(lockInfo);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

unlock

Descripción:

Método	Valores de retorno	Descripción
unlock(String token, String nodeId)	void	Desbloquea un nodo bloqueado.

Precaución

Solo el usuario que bloqueó el documento puede desbloquearlo.

Ejemplo:

package com.openkm;

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

public class Test {

    public static void main(String[] args) {
        try {
            OKMNode okmNode = ContextWrapper.getContext().getBean("okmNode", OKMNode.class);
            okmNode.unlock(null, "1ec49da9-1746-4875-ae32-9281d7303a62");
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

forceUnlock

Descripción:

Método	Valores de retorno	Descripción
forceUnlock(String token, String nodeId)	void	Desbloquea un nodo bloqueado.

Precaución

Esta acción solo puede realizarla un usuario con privilegios de administrador.

• Este método permite desbloquear cualquier nodo bloqueado.
• No es necesario que sea el mismo usuario que ejecutó previamente la acción de bloqueo el que realice esta acción.

Ejemplo:

package com.openkm;

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

public class Test {

    public static void main(String[] args) {
        try {
            OKMNode okmNode = ContextWrapper.getContext().getBean("okmNode", OKMNode.class);
            okmNode.forceUnlock(null, "1ec49da9-1746-4875-ae32-9281d7303a62");
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

isLocked

Descripción:

Método	Valores de retorno	Descripción
isLocked(String token, String nodeId)	boolean	Devuelve un booleano que indica si el nodo está bloqueado.

Ejemplo:

package com.openkm;

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

public class Test {

    public static void main(String[] args) {
        try {
            OKMNode okmNode = ContextWrapper.getContext().getBean("okmNode", OKMNode.class);
            boolean locked = okmNode.isLocked(null, "1ec49da9-1746-4875-ae32-9281d7303a62");
            System.out.println(locked);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getLockInfo

Descripción:

Método	Valores de retorno	Descripción
getLockInfo(String token, String nodeId)	LockInfo	Devuelve un objeto con la información del bloqueo.

Ejemplo:

package com.openkm;

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

public class Test {

    public static void main(String[] args) {
        try {
            OKMNode okmNode = ContextWrapper.getContext().getBean("okmNode", OKMNode.class);
            System.out.println(okmNode.getLockInfo(null, "1ec49da9-1746-4875-ae32-9281d7303a62"));
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

setComment

Descripción:

Método	Valores de retorno	Descripción
setComment(String token, String nodeId, String versionName, String comment)	void	Establece el comentario de una versión específica de un nodo.

Ejemplo:

package com.openkm;

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

public class Test {

    public static void main(String[] args) {
        try {
            OKMNode okmNode = ContextWrapper.getContext().getBean("okmNode", OKMNode.class);
            okmNode.setComment(null, "1ec49da9-1746-4875-ae32-9281d7303a62", "1.14", "Update comment");
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

exists

Descripción:

Método	Valores de retorno	Descripción
exists(String token, String parentUuid, String name)	boolean	Devuelve true si existe un nodo con el nombre dado como hijo directo del padre indicado.

• El parámetro parentUuid debe ser un UUID de carpeta o record válido. El parámetro name es el nombre del nodo a comprobar.

Ejemplo:

package com.openkm;

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

public class Test {

    public static void main(String[] args) {
        try {
            OKMNode okmNode = ContextWrapper.getContext().getBean("okmNode", OKMNode.class);
            boolean exists = okmNode.exists(null, "39479efe-de5e-468e-91a7-24d2aa3f8837", "document.pdf");
            System.out.println(exists);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}