PDF samples

Aspectos básicos

Ejemplo de código sugerido

Primero debe crear el objeto webservice:

OKMWebservices ws = OKMWebservicesFactory.getInstance(host);

A continuación, debe iniciar sesión mediante el método “login”. Puede acceder al método “login” desde el objeto webservice “ws”, tal y como se muestra a continuación:

ws.login(user, password);

Llegados a este punto puede usar todos los métodos de Pdf desde la clase “pdf”, tal y como se muestra a continuación:

InputStream is = ws.pdf.getImage("e7d6860a-7e0b-4823-bd3d-75f88be1eedf", 1);

Métodos

getImage

Descripción:

Método	Valores de retorno	Descripción
getImage(String uuid, int page, String size)	InputStream	Devuelve la imagen de una página.

El valor de uuid es el UUID del documento.

El valor de page es el número de página del documento, empezando por el valor “1”.

El valor de size es opcional. Si se indica, se usa para redimensionar la imagen de la página; en caso contrario se usa el valor por defecto.

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.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 = ws.pdf.getImage("e7d6860a-7e0b-4823-bd3d-75f88be1eedf", 1, null);
            OutputStream fos = new FileOutputStream("/home/openkm/page-1.png");
            IOUtils.copy(is, fos);
            IOUtils.closeQuietly(is);
            IOUtils.closeQuietly(fos);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

split

Descripción:

Método	Valores de retorno	Descripción
split(String uuid, String dstId, String baseName, List pages)	boolean	Devuelve true cuando las páginas del documento se han dividido.

El valor de uuid es el UUID del documento.

El valor de baseName es el nombre base para crear un documento dividido; por ejemplo, si baseName es “test” y pages es “1,3”, los ficheros creados serán “test-001.pdf” y “test-003.pdf”.

El valor de pages son los números de las páginas por las que se dividirá el documento.

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.sdk4j.OKMWebservicesFactory;
import com.openkm.sdk4j.impl.OKMWebservices;

public class Test {

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

        try {
            ws.login(username, password);
            List<Integer> pages = new ArrayList<>();
            pages.add(2);
            pages.add(3);
            boolean value = ws.pdf.split("e7d6860a-7e0b-4823-bd3d-75f88be1eedf", "0be057f1-efac-4e09-9c10-e7f27c731442", "split", pages);
            if (value) {
                System.out.println("split done");
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

extract

Descripción:

Método	Valores de retorno	Descripción
extract(String uuid, String dstId, String name, List pages)	boolean	Devuelve true cuando las páginas elegidas del documento se han extraído.

El valor de uuid es el UUID del documento.

El valor de dstId es el UUID del destino (carpeta o expediente).

El valor de name es el nombre del nuevo documento con las páginas extraídas.

El valor de pages son los números de las páginas que se extraerán.

Ejemplo:

package com.openkm;

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

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

public class PdfExample {

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

        try {
            ws.login(username, password);
            //extract
            List<Integer> pages = new ArrayList<>();
            pages.add(2);
            pages.add(3);
            if (ws.pdf.extract("e7d6860a-7e0b-4823-bd3d-75f88be1eedf", "0be057f1-efac-4e09-9c10-e7f27c731442", "extract", pages)) {
                System.out.println("extract done");
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

remove

Descripción:

Método	Valores de retorno	Descripción
remove(String uuid, String dstId, String name, List pages)	boolean	Devuelve true cuando las páginas del documento se han eliminado.

El valor de uuid es el UUID del documento.

El valor de dstId es el UUID del destino (carpeta o expediente).

El valor de name es el nombre del nuevo documento con las páginas extraídas.

El valor de pages son los números de las páginas que se eliminarán.

Ejemplo:

package com.openkm;

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

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

public class PdfExample {

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

        try {
            ws.login(username, password);
            // remove
            List<Integer> pages = new ArrayList<>();
            pages.add(2);
            pages.add(3);
            if (ws.pdf.extract("e7d6860a-7e0b-4823-bd3d-75f88be1eedf", "0be057f1-efac-4e09-9c10-e7f27c731442", "remove", pages)) {
                System.out.println("remove done");
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

rotate

Descripción:

Método	Valores de retorno	Descripción
rotate(String uuid, String dstId, String name, String angle, List pages)	boolean	Devuelve true cuando las páginas del documento se han rotado.

El valor de uuid es el UUID del documento.

El valor de dstId es el UUID del destino (carpeta o expediente).

El valor de name es el nombre del nuevo documento con las páginas extraídas.

El valor de angle es la rotación aplicada a las páginas elegidas.

El valor de pages son los números de las páginas que se rotarán.

Ejemplo:

package com.openkm;

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

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

public class PdfExample {

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

        try {
            ws.login(username, password);
            // rotate
            List<Integer> pages = new ArrayList<>();
            pages.add(2);
            pages.add(3);
            if (ws.pdf.rotate("e7d6860a-7e0b-4823-bd3d-75f88be1eedf", "0be057f1-efac-4e09-9c10-e7f27c731442", "rotate", "180",
                    pages)) {
                System.out.println("rotation done");
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

insertPages

Descripción:

Método	Valores de retorno	Descripción
insertPages(String uuid, String srcId, int sourceFromPage, int sourceToPage, int insertFromPage)	boolean	Devuelve true cuando las páginas se han insertado en el documento.

El valor de uuid es el UUID del documento de destino donde se insertarán las páginas.

El valor de srcId es el UUID del documento de origen del que se extraerán las páginas.

El valor de sourceFromPage es el número de la página inicial del documento de origen a partir de la cual se extraen las páginas.

El valor de sourceToPage es el número de la página final del documento de origen para la extracción. La extracción incluye esta página.

El valor de insertFromPage es el número de página del documento de destino en el que se insertarán las páginas extraídas.

Ejemplo:

package com.openkm;

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

public class PdfExample {

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

        try {
            ws.login(username, password);
            ws.pdf.insertPages("6a54d98b-6454-4484-8172-8359a2b4f2f2", "a573da75-ba1e-4f5b-98d2-fbb7da5f1cf1", 1, 3, 1);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}