OKMRepository

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 usar 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 algunos casos especiales puede ser “promovido a administrador” mediante el “token de administrador”.

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

Métodos

getRootFolder

Descripción:

Método	Valores devueltos	Descripción
getRootFolder(String token)	Folder	Devuelve el objeto Folder del nodo “/okm:root”.

Ejemplo:

package com.openkm;

import com.openkm.api.OKMRepository;
import com.openkm.bean.Folder;
import com.openkm.util.ContextWrapper;

public class Test {

    public static void main(String[] args) {
        try {
            OKMRepository okmRepository = ContextWrapper.getContext().getBean(OKMRepository.class);
            Folder fld = okmRepository.getRootFolder(null);
            System.out.println(fld);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getTrashFolder

Descripción:

Método	Valores devueltos	Descripción
getTrashFolder(String token)	Folder	Devuelve el objeto Folder del nodo “/okm:trash/{userId}”.

Nota

Por ejemplo, si el método lo ejecuta el usuario “okmAdmin”, la carpeta devuelta será “/okm:trash/okmAdmin”.

• La carpeta devuelta será la carpeta de la papelera del usuario.

Ejemplo:

package com.openkm;

import com.openkm.api.OKMRepository;
import com.openkm.bean.Folder;
import com.openkm.util.ContextWrapper;

public class Test {

    public static void main(String[] args) {
        try {
            OKMRepository okmRepository = ContextWrapper.getContext().getBean(OKMRepository.class);
            Folder fld = okmRepository.getTrashFolder(null);
            System.out.println(fld);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getTrashFolderBase

Descripción:

Método	Valores devueltos	Descripción
getTrashFolderBase(String token)	Folder	Devuelve el objeto Folder del nodo “/okm:trash”.

Ejemplo:

package com.openkm;

import com.openkm.api.OKMRepository;
import com.openkm.bean.Folder;
import com.openkm.util.ContextWrapper;

public class Test {

    public static void main(String[] args) {
        try {
            OKMRepository okmRepository = ContextWrapper.getContext().getBean(OKMRepository.class);
            Folder fld = okmRepository.getTrashFolderBase(null);
            System.out.println(fld);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getTemplatesFolder

Descripción:

Método	Valores devueltos	Descripción
getTemplatesFolder(String token)	Folder	Devuelve el objeto Folder del nodo “/okm:templates”.

Ejemplo:

package com.openkm;

import com.openkm.api.OKMRepository;
import com.openkm.bean.Folder;
import com.openkm.util.ContextWrapper;

public class Test {

    public static void main(String[] args) {
        try {
            OKMRepository okmRepository = ContextWrapper.getContext().getBean(OKMRepository.class);
            Folder fld = okmRepository.getTemplatesFolder(null);
            System.out.println(fld);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getPersonalFolder

Descripción:

Método	Valores devueltos	Descripción
getPersonalFolder(String token)	Folder	Devuelve el objeto Folder del nodo “/okm:personal/{userId}”.

Nota

Por ejemplo, si el método lo ejecuta el usuario “okmAdmin”, la carpeta devuelta será “/okm:personal/okmAdmin”.

• La carpeta devuelta será la carpeta personal del usuario.

Ejemplo:

package com.openkm;

import com.openkm.api.OKMRepository;
import com.openkm.bean.Folder;
import com.openkm.util.ContextWrapper;

public class Test {

    public static void main(String[] args) {
        try {
            OKMRepository okmRepository = ContextWrapper.getContext().getBean(OKMRepository.class);
            Folder fld = okmRepository.getPersonalFolder(null);
            System.out.println(fld);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getPersonalFolderBase

Descripción:

Método	Valores devueltos	Descripción
getPersonalFolderBase(String token)	Folder	Devuelve el objeto Folder del nodo “/okm:personal”.

Ejemplo:

package com.openkm;

import com.openkm.api.OKMRepository;
import com.openkm.bean.Folder;
import com.openkm.util.ContextWrapper;

public class Test {

    public static void main(String[] args) {
        try {
            OKMRepository okmRepository = ContextWrapper.getContext().getBean(OKMRepository.class);
            Folder fld = okmRepository.getPersonalFolderBase(null);
            System.out.println(fld);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getMailFolder

Descripción:

Método	Valores devueltos	Descripción
getMailFolder(String token)	Folder	Devuelve el objeto Folder del nodo “/okm:mail/{userId}”.

Nota

Por ejemplo, si el método lo ejecuta el usuario “okmAdmin”, la carpeta devuelta será “/okm:mail/okmAdmin”.

• La carpeta devuelta será la carpeta de correo del usuario.

Ejemplo:

package com.openkm;

import com.openkm.api.OKMRepository;
import com.openkm.bean.Folder;
import com.openkm.util.ContextWrapper;

public class Test {

    public static void main(String[] args) {
        try {
            OKMRepository okmRepository = ContextWrapper.getContext().getBean(OKMRepository.class);
            Folder fld = okmRepository.getMailFolder(null);
            System.out.println(fld);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getMailFolderBase

Descripción:

Método	Valores devueltos	Descripción
getMailFolderBase(String token)	Folder	Devuelve el objeto Folder del nodo “/okm:mail”.

Ejemplo:

package com.openkm;

import com.openkm.api.OKMRepository;
import com.openkm.bean.Folder;
import com.openkm.util.ContextWrapper;

public class Test {

    public static void main(String[] args) {
        try {
            OKMRepository okmRepository = ContextWrapper.getContext().getBean(OKMRepository.class);
            Folder fld = okmRepository.getMailFolderBase(null);
            System.out.println(fld);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getThesaurusFolder

Descripción:

Método	Valores devueltos	Descripción
getThesaurusFolder(String token)	Folder	Devuelve el objeto Folder del nodo “/okm:thesaurus”.

Ejemplo:

package com.openkm;

import com.openkm.api.OKMRepository;
import com.openkm.bean.Folder;
import com.openkm.util.ContextWrapper;

public class Test {

    public static void main(String[] args) {
        try {
            OKMRepository okmRepository = ContextWrapper.getContext().getBean(OKMRepository.class);
            Folder fld = okmRepository.getThesaurusFolder(null);
            System.out.println(fld);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getCategoriesFolder

Descripción:

Método	Valores devueltos	Descripción
getCategoriesFolder(String token)	Folder	Devuelve el objeto Folder del nodo “/okm:categories”.

Ejemplo:

package com.openkm;

import com.openkm.api.OKMRepository;
import com.openkm.bean.Folder;
import com.openkm.util.ContextWrapper;

public class Test {

    public static void main(String[] args) {
        try {
            OKMRepository okmRepository = ContextWrapper.getContext().getBean(OKMRepository.class);
            Folder fld = okmRepository.getCategoriesFolder(null);
            System.out.println(fld);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

purgeTrash

Descripción:

Método	Valores devueltos	Descripción
purgeTrash(String token)	Folder	Elimina de forma permanente del repositorio todos los nodos de “/okm:trash/{userId}”.

Nota

Por ejemplo, si el método lo ejecuta el usuario “okmAdmin”, la papelera purgada será “/okm:trash/okmAdmin”.

Precaución

Cuando se purga un nodo, solo se puede restaurar a partir de una copia de seguridad anterior del repositorio. La acción de purga elimina el nodo de forma permanente del repositorio.

Ejemplo:

package com.openkm;

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

public class Test {

    public static void main(String[] args) {
        try {
            OKMRepository okmRepository = ContextWrapper.getContext().getBean(OKMRepository.class);
            okmRepository.purgeTrash(null);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getUpdateMessage

Descripción:

Método	Valores devueltos	Descripción
getUpdateMessage(String token)	String	Recupera un mensaje cuando hay una nueva versión de OpenKM.

Nota

El mensaje más habitual indica que se ha publicado una nueva versión de OpenKM.

• Existe un servicio oficial de mensajes de actualización de OpenKM basado en su versión local de OpenKM.

Ejemplo:

package com.openkm;

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

public class Test {

    public static void main(String[] args) {
        try {
            OKMRepository okmRepository = ContextWrapper.getContext().getBean(OKMRepository.class);
            String msg = okmRepository.getUpdateMessage(null);
            System.out.println(msg);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getRepositoryUuid

Descripción:

Método	Valores devueltos	Descripción
getRepositoryUuid(String token)	String	Recupera el identificador único de la instalación.

Ejemplo:

package com.openkm;

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

public class Test {

    public static void main(String[] args) {
        try {
            OKMRepository okmRepository = ContextWrapper.getContext().getBean(OKMRepository.class);
            String uuid = okmRepository.getRepositoryUuid(null);
            System.out.println(uuid);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

hasNode

Descripción:

Método	Valores devueltos	Descripción
hasNode(String token, String nodeId)	boolean	Devuelve un valor booleano que indica si existe un nodo.

• El valor del parámetro nodeId puede ser un UUID válido.

Ejemplo:

package com.openkm;

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

public class Test {

    public static void main(String[] args) {
        try {
            OKMRepository okmRepository = ContextWrapper.getContext().getBean(OKMRepository.class);
            boolean found = okmRepository.hasNode(null, "b67fe3ae-bcca-4947-b8ea-0cc7aedd4474");
            System.out.println(found);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getNodePath

Descripción:

Método	Valores devueltos	Descripción
getNodePath(String token, String uuid)	String	Convierte el UUID de un nodo en una ruta.

Ejemplo:

package com.openkm;

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

public class Test {

    public static void main(String[] args) {
        try {
            OKMRepository okmRepository = ContextWrapper.getContext().getBean(OKMRepository.class);
            String path = okmRepository.getNodePath(null, "b67fe3ae-bcca-4947-b8ea-0cc7aedd4474");
            System.out.println(path);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getNodeUuid

Descripción:

Método	Valores devueltos	Descripción
getNodeUuid(String token, String path)	String	Convierte la ruta de un nodo en un UUID.

Ejemplo:

package com.openkm;

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

public class Test {

    public static void main(String[] args) {
        try {
            OKMRepository okmRepository = ContextWrapper.getContext().getBean(OKMRepository.class);
            String uuid = okmRepository.getNodeUuid(null, "/okm:root/api");
            System.out.println(uuid);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getAppVersion

Descripción:

Método	Valores devueltos	Descripción
getAppVersion(String token)	AppVersion	Devuelve información sobre la versión de OpenKM.

Ejemplo:

package com.openkm;
import com.openkm.api.OKMRepository;
import com.openkm.bean.AppVersion;
import com.openkm.util.ContextWrapper;

public class Test {

    public static void main(String[] args) {
        try {
            OKMRepository okmRepository = ContextWrapper.getContext().getBean(OKMRepository.class);
            AppVersion appVersion = okmRepository.getAppVersion(null);
            System.out.println(appVersion);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

copyAttributes

Descripción:

Método	Valores devueltos	Descripción
copyAttributes(String token, String srcId, String dstId, ExtendedAttributes extAttr)	void	Copia atributos de un nodo a otro.

Nota

• Cuando el parámetro category es true, se copiarán los valores originales de las categorías.
• Cuando el parámetro keywords es true, se copiarán los valores originales de las palabras clave.
• Cuando el parámetro property Groups es true, se copiarán los valores originales de los grupos de metadatos.
• Cuando el parámetro notes es true, se copiarán los valores originales de las notas.
• Cuando el parámetro wiki es true, se copiarán los valores originales de la wiki.

• Los valores del parámetro dstId deben ser el UUID de un nodo.

Ejemplo:

package com.openkm;

import com.openkm.api.OKMRepository;
import com.openkm.bean.ExtendedAttributes;
import com.openkm.util.ContextWrapper;

public class Test {

    public static void main(String[] args) {
        try {
            OKMRepository okmRepository = ContextWrapper.getContext().getBean(OKMRepository.class);
            ExtendedAttributes extAttr = new ExtendedAttributes();
            extAttr.setKeywords(true);
            extAttr.setCategories(true);
            extAttr.setNotes(true);
            extAttr.setPropertyGroups(true);
            extAttr.setWiki(true);
            okmRepository.copyAttributes(null, "d168924d-e801-426d-a222-00124a1461bd", "9f64248c-e049-4706-b89e-6d725842c7f7", extAttr);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getMetadataFolder

Descripción:

Método	Valores devueltos	Descripción
getMetadataFolder(String token)	Folder	Devuelve la carpeta de metadatos.

Ejemplo:

package com.openkm;

import com.openkm.api.OKMRepository;
import com.openkm.bean.Folder;
import com.openkm.util.ContextWrapper;

public class Test {

    public static void main(String[] args) {
        try {
            OKMRepository okmRepository = ContextWrapper.getContext().getBean(OKMRepository.class);

            Folder folder = okmRepository.getMetadataFolder(null);
            System.out.println(folder);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getChangeLog

Descripción:

Método	Valores devueltos	Descripción
getChangeLog(String token, String nodePath, Calendar modifyFrom)	List	Devuelve la lista de cambios en una ruta y sus subcarpetas.

Consejo

• El método lo utiliza la aplicación de sincronización de escritorio para recuperar los cambios.

Ejemplo:

package com.openkm;

import java.util.Calendar;

import com.openkm.api.OKMRepository;
import com.openkm.bean.ChangeLogged;
import com.openkm.util.ContextWrapper;

public class Test {

    public static void main(String[] args) {
        try {
            OKMRepository okmRepository = ContextWrapper.getContext().getBean(OKMRepository.class);

            Calendar now = Calendar.getInstance();
            for (ChangeLogged cl : okmRepository.getChangeLog(null, "/okm:root/synchronized", now)) {
                System.out.println(cl);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getAppLicense

Descripción:

Método	Valores devueltos	Descripción
getAppLicense(String token)	LicenseInfo	Devuelve información sobre la licencia.

Ejemplo:

package com.openkm;

import com.openkm.api.OKMRepository;
import com.openkm.util.ContextWrapper;
import com.openkm.util.Update.LicenseInfo;

public class Test {

    public static void main(String[] args) {
        try {
            OKMRepository okmRepository = ContextWrapper.getContext().getBean(OKMRepository.class);

            LicenseInfo licenseInfo = okmRepository.getAppLicense(null);
            System.out.println(licenseInfo);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}