OKMRepository

En todos los métodos verá un parámetro llamado “token”. Al acceder a la aplicación a través de SOAP, el proceso de inicio de sesión devuelve un token que se utiliza para identificar al usuario en todos los métodos expuestos. Desde el contexto de ejecución por defecto de la aplicación debe utilizar el valor “null”, que indica a la aplicación que debe utilizar la “sesión del usuario”.

Consejo

En casos especiales puede ser “promovido a Administrador” utilizando 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;

public class Test {
    public static void main(String[] args) {
        try {
            Folder fld = OKMRepository.getInstance().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 papelera del usuario.

Ejemplo:

package com.openkm;

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

public class Test {
    public static void main(String[] args) {
        try {
            Folder fld = OKMRepository.getInstance().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;

public class Test {
    public static void main(String[] args) {
        try {
            Folder fld = OKMRepository.getInstance().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;

public class Test {
    public static void main(String[] args) {
        try {
            Folder fld = OKMRepository.getInstance().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;

public class Test {
    public static void main(String[] args) {
        try {
            Folder fld = OKMRepository.getInstance().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;

public class Test {
    public static void main(String[] args) {
        try {
            Folder fld = OKMRepository.getInstance().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;

public class Test {
    public static void main(String[] args) {
        try {
            Folder fld = OKMRepository.getInstance().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;

public class Test {
    public static void main(String[] args) {
        try {
            Folder fld = OKMRepository.getInstance().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;

public class Test {
    public static void main(String[] args) {
        try {
            Folder fld = OKMRepository.getInstance().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;

public class Test {
    public static void main(String[] args) {
        try {
            Folder fld = OKMRepository.getInstance().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 definitivamente 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 podrá restaurar desde una copia de seguridad previa del repositorio. La acción de purga elimina el nodo definitivamente del repositorio.

Ejemplo:

package com.openkm;

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

public class Test {
    public static void main(String[] args) {
        try {
            OKMRepository.getInstance().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 es 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;

public class Test {
    public static void main(String[] args) {
        try {
            String msg = OKMRepository.getInstance().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;

public class Test {
    public static void main(String[] args) {
        try {
            String uuid = OKMRepository.getInstance().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 que indica si un nodo existe o no.

• El valor del parámetro nodeId puede ser un UUID o una ruta válidos.

Ejemplo:

package com.openkm;

import com.openkm.api.OKMRepository;

public class Test {
    public static void main(String[] args) {
        try {
            boolean found = OKMRepository.getInstance().hasNode(null,"/okm:root/test");
            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 su ruta.

Ejemplo:

package com.openkm;

import com.openkm.api.OKMRepository;

public class Test {
    public static void main(String[] args) {
        try {
            String path = OKMRepository.getInstance().getNodePath(null, "064ff51a-b815-4f48-a096-b4946876784f");
            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 su UUID.

Ejemplo:

package com.openkm;

import com.openkm.api.OKMRepository;

public class Test {
    public static void main(String[] args) {
        try {
            String uuid = OKMRepository.getInstance().getNodeUuid(null, "/okm:root/tmp");
            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;

public class Test {
    public static void main(String[] args) {
        try {
            AppVersion appVersion = OKMRepository.getInstance().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 los 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 propertyGroups 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.

• El valor del parámetro dstId debe ser un UUID o una ruta de nodo.

Ejemplo:

package com.openkm;

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

public class Test {
    public static void main(String[] args) {
        try {
            ExtendedAttributes extAttr = new ExtendedAttributes();
            extAttr.setKeywords(true);
            extAttr.setCategories(true);
            extAttr.setNotes(true);
            extAttr.setPropertyGroups(true);
            extAttr.setWiki(true);
            OKMRepository.getInstance().copyAttributes(null, "/okm:root/invoice.pdf", "/okm:root/cloned_invoice.pdf", extAttr);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}