Ejemplos de Conversion

Conceptos básicos

Ejemplo de código sugerido

Primero, debes crear el objeto de servicio web:

OKMWebservices ws = OKMWebservicesFactory.getInstance(host);

A continuación debes iniciar sesión usando el método “login”. Puedes acceder al método “login” desde el objeto de servicio web “ws” como se muestra a continuación:

ws.login(user, password);

Precaución

Una vez que has iniciado sesión con los servicios web, la sesión se mantiene en el objeto de servicio web. A partir de ahí puedes usar el resto de métodos de la API.

Llegados a este punto puedes usar todos los métodos de Conversion desde la clase “conversion” como se muestra a continuación:

ws.conversion.doc2pdf(is, "test.docx");

Métodos

doc2pdf

Descripción:

Método	Valores de retorno	Descripción
doc2pdf(InputStream is, String fileName)	InputStream	Obtiene el documento subido convertido a formato PDF.

Precaución

El servicio de OpenOffice debe estar habilitado en el servidor de OpenKM para que funcione.

• El parámetro fileName es el nombre del fichero del documento. La aplicación usa este parámetro para identificar el MIME TYPE del documento por su extensión.

Ejemplo:

package com.openkm;

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

import org.apache.commons.io.IOUtils;

import com.openkm.sdk4j.OKMWebservicesFactory;
import com.openkm.sdk4j.impl.OKMWebservices;

public class Test {

    public static void main(String[] args) {
        String host = "http://localhost:8080/openkm";
        String user = "okmAdmin";
        String password = "admin";
        OKMWebservices ws = OKMWebservicesFactory.getInstance(host);

        try {
            ws.login(user, password);
            InputStream is = new FileInputStream("/home/openkm/test.docx");
            FileOutputStream fos = new FileOutputStream("/home/openkm/out.pdf");
            InputStream convertedStream = ws.conversion.doc2pdf(is, "test.docx");
            IOUtils.copy(convertedStream, fos);
            is.close();
            convertedStream.close();
            fos.close();
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

imageConvert

Descripción:

Método	Valores de retorno	Descripción
imageConvert(InputStream is, String fileName, String params, String dstMimeType)	InputStream	Obtiene la imagen subida con la transformación aplicada.

Consejo

Al usar este método, en realidad estás ejecutando la herramienta convert de ImageMagick en el lado del servidor.

Puedes establecer muchos parámetros (transformaciones) en la variable params. Consulta la herramienta convert de ImageMagick para ver la lista completa.

Precaución

La herramienta de conversión de imágenes debe estar habilitada en el servidor de OpenKM para que funcione.

Cuando el valor de params no está vacío, siempre debe terminar con la secuencia “${fileIn} ${fileOut}”.

Asegúrate de que solo haya un único espacio en blanco como separador entre dos parámetros.

Al construir tus integraciones, te sugerimos instalar el software ImageMagick localmente, y comprobar primero tus transformaciones de imagen desde la línea de comandos.

• La variable fileName es el nombre del fichero del documento. La aplicación usa esta variable para identificar el MIME TYPE del documento por su extensión.
• El parámetro dstMimeType es el MIME TYPE de resultado esperado para el documento.

Ejemplo:

package com.openkm;

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

import org.apache.commons.io.IOUtils;

import com.openkm.sdk4j.OKMWebservicesFactory;
import com.openkm.sdk4j.impl.OKMWebservices;

public class Test {

    public static void main(String[] args) {
        String host = "http://localhost:8080/openkm";
        String user = "okmAdmin";
        String password = "admin";
        OKMWebservices ws = OKMWebservicesFactory.getInstance(host);

        try {
            ws.login(user, password);
            InputStream is = new FileInputStream("/home/openkm/test.png");
            FileOutputStream fos = new FileOutputStream("/home/openkm/out.jpg");
            InputStream convertedStream = ws.conversion.imageConvert(is, "test.png", "-resize 50% ${fileIn} ${fileOut}", "image/jpeg");
            IOUtils.copy(convertedStream, fos);
            is.close();
            convertedStream.close();
            fos.close();
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

html2pdf

Descripción:

Método	Valores de retorno	Descripción
html2pdf(String url)	InputStream	Obtiene el PDF de una URL.

Precaución

La herramienta de conversión de HTML a PDF debe estar habilitada en el servidor de OpenKM para que funcione.

Ejemplo:

package com.openkm;

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

import org.apache.commons.io.IOUtils;

import com.openkm.sdk4j.OKMWebservicesFactory;
import com.openkm.sdk4j.impl.OKMWebservices;

public class Test {

    public static void main(String[] args) {
        String host = "http://localhost:8080/openkm";
        String user = "okmAdmin";
        String password = "admin";
        OKMWebservices ws = OKMWebservicesFactory.getInstance(host);

        try {
            ws.login(user, password);
            FileOutputStream fos = new FileOutputStream("/home/openkm/out.pdf");
            InputStream is = ws.conversion.html2pdf("https://www.openkm.com/es/");
            IOUtils.copy(is, fos);
            is.close();
            fos.close();
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

doc2txt

Descripción:

Método	Valores de retorno	Descripción
doc2txt(InputStream is, String fileName)	String	Extrae el texto del documento subido.

Precaución

Debe haber un extractor de texto habilitado para el MIME TYPE del documento en el servidor de OpenKM para que funcione.

Ejemplo:

package com.openkm;

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

import com.openkm.sdk4j.OKMWebservicesFactory;
import com.openkm.sdk4j.impl.OKMWebservices;

public class Test {

    public static void main(String[] args) {
        String host = "http://localhost:8080/openkm";
        String user = "okmAdmin";
        String password = "admin";
        OKMWebservices ws = OKMWebservicesFactory.getInstance(host);

        try {
            ws.login(user, password);
            InputStream is = new FileInputStream("/home/openkm/test.docx");
            System.out.println(ws.conversion.doc2txt(is, "test.docx"));
            is.close();
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

img2txt

Descripción:

Método	Valores de retorno	Descripción
img2txt(InputStream is, String fileName)	String	Extrae el texto de la imagen subida.

Precaución

El motor de OCR debe estar habilitado en el servidor de OpenKM para que funcione.

Ejemplo:

package com.openkm;

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

import com.openkm.sdk4j.OKMWebservicesFactory;
import com.openkm.sdk4j.impl.OKMWebservices;

public class Test {

    public static void main(String[] args) {
        String host = "http://localhost:8080/openkm";
        String user = "okmAdmin";
        String password = "admin";
        OKMWebservices ws = OKMWebservicesFactory.getInstance(host);

        try {
            ws.login(user, password);
            InputStream is = new FileInputStream("/home/openkm/test.png");
            System.out.println(ws.conversion.img2txt(is, "test.png"));
            is.close();
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

barcode2txt

Descripción:

Método	Valores de retorno	Descripción
barcode2txt(InputStream is, String fileName)	String	Extrae el texto del código de barras de la imagen subida.

Precaución

La herramienta de código de barras debe estar habilitada en el servidor de OpenKM para que funcione.

Ejemplo:

package com.openkm;

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

import com.openkm.sdk4j.OKMWebservicesFactory;
import com.openkm.sdk4j.impl.OKMWebservices;

public class Test {

    public static void main(String[] args) {
        String host = "http://localhost:8080/openkm";
        String user = "okmAdmin";
        String password = "admin";
        OKMWebservices ws = OKMWebservicesFactory.getInstance(host);

        try {
            ws.login(user, password);
            InputStream is = new FileInputStream("/home/openkm/test.png");
            System.out.println(ws.conversion.barcode2txt(is, "test.png"));
            is.close();
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}