Document samples

Aspectos básicos

En la mayoría de los métodos verá un parámetro llamado “docId”. El valor de este parámetro puede ser un UUID o una ruta (path) válidos de documento.

Consejo

Ejemplo de docId:

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

Métodos

createDocument

Descripción:

Método	Valores de retorno	Descripción
createDocument(Document doc, InputStream is)	Document	Crea un nuevo documento y devuelve como resultado un objeto Document con las propiedades del documento creado.

Precaución

El resto de variables del objeto Document (doc) no tendrán ningún efecto en la creación del documento.

Le recomendamos usar el método siguiente, createDocumentSimple, en lugar de este.

• La variable path del parámetro doc debe inicializarse. Indica dónde debe almacenarse el documento dentro de OpenKM.

Ejemplo:

package com.openkm;

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

import org.apache.commons.io.IOUtils;

import com.openkm.sdk4j.OKMWebservices;
import com.openkm.sdk4j.OKMWebservicesFactory;
import com.openkm.sdk4j.bean.Document;

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 {
            InputStream is = new FileInputStream("/home/files/logo.png");
            Document doc = new Document();
            doc.setPath("/okm:root/logo.png");
            ws.createDocument(doc, is);
            IOUtils.closeQuietly(is);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

createDocumentSimple

Descripción:

Método	Valores de retorno	Descripción
createDocumentSimple(String docPath, InputStream is)	Document	Crea un nuevo documento y devuelve como resultado un objeto Document con las propiedades del documento creado.

Ejemplo:

package com.openkm;

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

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 {
            InputStream is = new FileInputStream("/home/files/logo.png");
            ws.createDocumentSimple("/okm:root/logo.png", is);
            IOUtils.closeQuietly(is);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

deleteDocument

Descripción:

Método	Valores de retorno	Descripción
deleteDocument(String docId)	void	Elimina un documento.

Nota

Cuando se elimina un documento, se mueve automáticamente a la carpeta /okm:trash/userId.

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

getDocumentProperties

Descripción:

Método	Valores de retorno	Descripción
getDocumentProperties(String docId)	Document	Devuelve las propiedades del documento.

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

getContent

Descripción:

Método	Valores de retorno	Descripción
getContent(String docId)	InputStream	Recupera el contenido del documento (datos binarios) de la versión actual del documento.

Precaución

Si envía el fichero a través de la respuesta de un Servlet, le sugerimos establecer la longitud del contenido con:

Document doc = ws.getDocumentProperties("/okm:root/logo.png");
response.setContentLength(new Long(doc.getActualVersion().getSize()).intValue());

Peligro

Hemos encontrado problemas de tamaño incorrecto al usar:

response.setContentLength(is.available());

Ejemplo:

package com.openkm;

import java.io.FileOutputStream;
import java.io.InputStream;
import java.io.OutputStream;

import org.apache.commons.io.IOUtils;

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 {
            OutputStream fos = new FileOutputStream("/home/files/logo.png");
            InputStream is = ws.getContent("/okm:root/logo.png");
            IOUtils.copy(is, fos);
            IOUtils.closeQuietly(is);
            IOUtils.closeQuietly(fos);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getContentByVersion

Descripción:

Método	Valores de retorno	Descripción
getContentByVersion(String docId, String versionId)	InputStream	Recupera el contenido (datos binarios) de una versión concreta del documento.

Precaución

Si envía el fichero a través de la respuesta de un Servlet, le sugerimos establecer la longitud del contenido con:

Document doc = ws.getDocumentProperties("/okm:root/logo.png");
response.setContentLength(new Long(doc.getActualVersion().getSize()).intValue());

Peligro

Hemos encontrado problemas de tamaño incorrecto al usar:

response.setContentLength(is.available());

Ejemplo:

package com.openkm;

import java.io.FileOutputStream;
import java.io.InputStream;
import java.io.OutputStream;

import org.apache.commons.io.IOUtils;

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 {
            OutputStream fos = new FileOutputStream("/home/files/logo.png");
            InputStream is = ws.getContentByVersion("/okm:root/logo.png","1.1");
            IOUtils.copy(is, fos);
            IOUtils.closeQuietly(is);
            IOUtils.closeQuietly(fos);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getDocumentChildren

Descripción:

Método	Valores de retorno	Descripción
getDocumentChildren(String fldId)	List	Devuelve una lista con todos los documentos cuyo padre es fldId.

Ejemplo:

package com.openkm;

import com.openkm.sdk4j.OKMWebservices;
import com.openkm.sdk4j.OKMWebservicesFactory;
import com.openkm.sdk4j.bean.Document;

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 {
            for (Document doc : ws.getDocumentChildren("/okm:root")) {
                System.out.println(doc);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

renameDocument

Descripción:

Método	Valores de retorno	Descripción
renameDocument(String docId, String newName)	void	Cambia el nombre de un documento.

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.renameDocument("f123a950-0329-4d62-8328-0ff500fd42db", "logo_rename.png");
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

setProperties

Descripción:

Método	Valores de retorno	Descripción
setProperties(Document doc)	void	Cambia algunas propiedades del documento.

Precaución

Solo se tendrán en cuenta las variables que no sean nulas ni estén vacías.

• Variables que se pueden cambiar:

Ejemplo:

package com.openkm;

import com.openkm.sdk4j.OKMWebservices;
import com.openkm.sdk4j.OKMWebservicesFactory;
import com.openkm.sdk4j.bean.Document;

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 {
            Document doc = ws.getDocumentProperties("f123a950-0329-4d62-8328-0ff500fd42db");
            doc.setDescription("some description");
            doc.getKeywords().add("test");
            ws.setProperties(doc);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

checkout

Descripción:

Método	Valores de retorno	Descripción
checkout(String docId)	void	Marca el documento para su edición.

• Solo un usuario puede modificar un documento a la vez.
• Antes de empezar la edición debe ejecutar una acción de checkout que bloquea el proceso de edición para el resto de usuarios y permite editar únicamente al usuario que ejecutó la acción.

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.checkout("/okm:root/logo.png");
            // At this point the document is locked for other users except for the user who executed the action
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

cancelCheckout

Descripción:

Método	Valores de retorno	Descripción
cancelCheckout(String docId)	void	Cancela la edición de un documento.

Precaución

Esta acción solo puede realizarla el usuario que ejecutó previamente la acción de checkout.

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 {
            // At this point the document is locked for other users except for the user who executed the action
            ws.cancelCheckout("/okm:root/logo.png");
            // At this point other users are allowed to execute a checkout and modify the document
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

forceCancelCheckout

Descripción:

Método	Valores de retorno	Descripción
forceCancelCheckout(String docId)	void	Cancela la edición de un documento.

Precaución

Esta acción solo puede realizarla un superusuario (usuario con ROLE_ADMIN).

• Este método permite cancelar la edición de cualquier documento.
• No es obligatorio que esta acción la ejecute el mismo usuario que ejecutó previamente la acción de checkout.

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 {
            // At this point the document is locked for other users except for the user who executed the action
            ws.forceCancelCheckout("/okm:root/logo.png");
            // At this point other users are allowed to execute a checkout and modify the document
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

isCheckedOut

Descripción:

Método	Valores de retorno	Descripción
isCheckedOut(String docId)	Boolean	Devuelve un booleano que indica si el documento está en edición o no.

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 {
            System.out.println("Is the document checkout:"+ws.isCheckedOut("/okm:root/logo.png"));
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

checkin

Descripción:

Método	Valores de retorno	Descripción
checkin(String docId, InputStream is, String comment)	Version	Actualiza un documento con una nueva versión y devuelve un objeto con los valores de la nueva Version.

Precaución

Solo el usuario que inició la edición (checkout) puede actualizar el documento.

Ejemplo:

package com.openkm;

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

import org.apache.commons.io.IOUtils;

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 {
            InputStream is = new FileInputStream("/home/files/logo.png");
            ws.checkin("/okm:root/logo.png", is, "optional some comment");
            IOUtils.closeQuietly(is);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getVersionHistory

Descripción:

Método	Valores de retorno	Descripción
getVersionHistory(String docId)	List	Devuelve una lista con todas las versiones del documento.

Ejemplo:

package com.openkm;

import com.openkm.sdk4j.OKMWebservices;
import com.openkm.sdk4j.OKMWebservicesFactory;
import com.openkm.sdk4j.bean.Version;

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 {
            for (Version version : ws.getVersionHistory("/okm:root/logo.png")) {
                System.out.println(version);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

lock

Descripción:

Método	Valores de retorno	Descripción
lock(String docId)	LockInfo	Bloquea un documento 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.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.lock("/okm:root/logo.png");
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

unlock

Descripción:

Método	Valores de retorno	Descripción
unlock(String docId)	void	Desbloquea un documento bloqueado.

Precaución

Solo el usuario que bloqueó el documento puede desbloquearlo.

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

forceUnlock

Descripción:

Método	Valores de retorno	Descripción
forceUnlock(String docId)	void	Desbloquea un documento bloqueado.

Precaución

Esta acción solo puede realizarla un superusuario (usuario con ROLE_ADMIN).

• Este método permite desbloquear cualquier documento bloqueado.
• No es obligatorio que esta acción la ejecute el mismo usuario que ejecutó previamente la acción de bloqueo (checkout).

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

isLocked

Descripción:

Método	Valores de retorno	Descripción
isLocked(String docId)	Boolean	Devuelve un booleano que indica si el documento está bloqueado o no.

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 {
            System.out.println("Is document locked:"+ws.isLocked("/okm:root/logo.png"));
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getLockInfo

Descripción:

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

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

purgeDocument

Descripción:

Método	Valores de retorno	Descripción
purgeDocument(String docId)	void	El documento se elimina definitivamente del repositorio.

Precaución

Cuando se purga un documento, solo puede restaurarse a partir de una copia de seguridad anterior del repositorio. La acción de purga elimina el documento definitivamente del repositorio.

• Normalmente se purgan documentos en /okm:trash/userId - las ubicaciones personales de la papelera de cada usuario - pero es posible purgar directamente cualquier documento de todo el repositorio.

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

moveDocument

Descripción:

Método	Valores de retorno	Descripción
moveDocument(String docId, String dstId)	void	Mueve un documento a una carpeta o expediente.

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

copyDocument

Descripción:

Método	Valores de retorno	Descripción
copyDocument(String docId, String dstId)	void	Copia un documento a una carpeta o expediente.

Precaución

Solo se copian los datos binarios y los permisos de seguridad al destino; los metadatos, palabras clave, etc. del documento no se copian.

• El valor del parámetro dstId debe ser un UUID o una ruta (path) de carpeta o de expediente.

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

restoreVersion

Descripción:

Método	Valores de retorno	Descripción
restoreVersion(String docId, String versionId)	void	Restaura una versión anterior del documento como versión actual.

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 {
            // Actual version is 1.2
            ws.restoreVersion("/okm:root/logo.png","1.1");
            // Actual version is 1.1
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

purgeVersionHistory

Descripción:

Método	Valores de retorno	Descripción
purgeVersionHistory(String docId)	void	Purga todas las versiones del documento excepto la versión actual.

Precaución

Esta acción no se puede revertir.

• Esta acción compacta el histórico de versiones de un documento.

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 {
            // Version history has version 1.3,1.2,1.1 and 1.0
            ws.purgeVersionHistory("/okm:root/logo.png");            // Version history has only version 1.3        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getVersionHistorySize

Descripción:

Método	Valores de retorno	Descripción
getVersionHistorySize(String docId)	long	Devuelve el tamaño total en bytes de todos los documentos del historial de versiones.

Ejemplo:

package com.openkm;

import java.util.Locale;

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 {
            String[] UNITS = new String[] { "B", "KB", "MB", "GB", "TB", "PB", "EB" };
            long bytes = ws.getVersionHistorySize("/okm:root/logo.png");
            String value = "";                        for (int i = 6; i > 0; i--) {
                double step = Math.pow(1024, i);
                if (bytes > step)
                    value = String.format(Locale.ROOT, "%3.1f %s", bytes / step, UNITS[i]);
      }

            if (value.isEmpty()) {
                value = Long.toString(bytes) + " " + UNITS[0];
            }
                        System.out.println(value);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

isValidDocument

Descripción:

Método	Valores de retorno	Descripción
isValidDocument(String docId)	Boolean	Devuelve un booleano que indica si el nodo es un documento o no.

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

getDocumentPath

Descripción:

Método	Valores de retorno	Descripción
getDocumentPath(String uuid)	String	Convierte el UUID de un documento en su ruta.

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 {
            System.out.println(ws.getDocumentPath("f123a950-0329-4d62-8328-0ff500fd42dbg"));
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

extendedDocumentCopy

Descripción:

Método	Valores de retorno	Descripción
extendedDocumentCopy(String docId, String dstId, String name, boolean categories, boolean keywords, boolean propertyGroups, boolean notes, boolean wiki)	void	Copia un documento con los datos asociados a una carpeta o expediente.

Nota

Por defecto solo se copian los datos binarios y los permisos de seguridad; los metadatos, palabras clave, etc. del documento no se copian.

Adicionalmente:

• Cuando el parámetro category es true, se copian los valores originales de las categorías.
• Cuando el parámetro keywords es true, se copian los valores originales de las palabras clave.
• Cuando el parámetro propertyGroups es true, se copian los valores originales de los grupos de metadatos.
• Cuando el parámetro notes es true, se copia el valor original de las notas.
• Cuando el parámetro wiki es true, se copia el valor original del wiki.

• El valor del parámetro dstId debe ser un UUID o una ruta (path) de carpeta o de expediente.
• Cuando el valor del parámetro newName es null, el documento conservará el mismo nombre.

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

createFromTemplate

Descripción:

Método	Valores de retorno	Descripción
Document createFromTemplate(String docId, String dstPath, boolean categories, boolean keywords, boolean propertyGroups, boolean notes, boolean wiki, Map<String, String> properties)	Document	Crea un nuevo documento a partir de la plantilla y devuelve un objeto Document.

Nota

Para más información sobre plantillas y metadatos, consulte: Creating templates.

Nota

Adicionalmente:

• 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 copian los valores originales de las palabras clave.
• Cuando el parámetro property Groups es true, se copian los valores originales de los grupos de metadatos.
• Cuando el parámetro notes es true, se copian los valores originales de las notas.
• Cuando el parámetro wiki es true, se copian los valores originales del wiki.

• El dstPath debe ser una carpeta.
• Cuando la plantilla usa grupos de metadatos para rellenar campos, estos valores son obligatorios y deben establecerse en el parámetro properties.

Ejemplo:

Nota

El siguiente ejemplo se basa en la muestra Creating PDF template.

package com.openkm;

import com.openkm.sdk4j.OKMWebservices;
import com.openkm.sdk4j.OKMWebservicesFactory;
import com.openkm.sdk4j.bean.Document;
import com.openkm.sdk4j.util.ISO8601;

import java.util.Calendar;
import java.util.HashMap;
import java.util.Map;

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 {
            // createFromTemplate
            Map<String, String> properties = new HashMap<>();
            // okg:tpl
            properties.put("okp:tpl.name", "sdk name");
            Calendar cal = Calendar.getInstance();
            // Value must be converted to String ISO 8601 compliant
            properties.put("okp:tpl.bird_date", ISO8601.formatBasic(cal));
            properties.put("okp:tpl.language", "java");

            // Property okg:technology
            properties.put("okp:technology.comment", "sdk name");

            Document document = ws.createFromTemplate("fc638b93-0072-49ac-ad88-d4eeb098fd5a", "/okm:root/sdk/template.pdf", true, true, true, true, true, properties);
            System.out.println(document);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}