OKMStamp

Métodos

calculateStampCoordinates

Descripción:

Método	Valores de retorno	Descripción
calculateStampCoordinates(String token, long imgToStampWidth, long imgToStampHeight, long floatingDivWidth,long floatingDivHeight, String exprX, String exprY, String stampType, String stampAlign)	StampCoordinates	Devuelve las coordenadas calculadas del sello.

Nota

En los campos de entrada Expr. X y Expr. Y puede introducir algo más que un simple número. Actualmente están definidas las siguientes macros:

• IMAGE_WIDTH
• IMAGE_HEIGHT
• PAGE_WIDTH
• PAGE_HEIGHT
• PAGE_CENTER
• PAGE_MIDDLE

Así, para centrar un sello en la página puede usar:

Expr. X	PAGE_CENTER
Expr. Y	PAGE_MIDDLE
:::

Nota

Valores disponibles:

• text
• image

Nota

Valores disponibles:

• left
• center
• right

• El parámetro stampAlign.
• El parámetro stampAlign es la alineación del texto

Ejemplo:

package com.openkm;

import com.openkm.api.OKMStamp;
import com.openkm.util.ContextWrapper;
import com.openkm.ws.rest.util.StampCoordinates;

public class Test {

    public static void main(String[] args) {
        try {
            OKMStamp okmStamp = ContextWrapper.getContext().getBean(OKMStamp.class);
            // Parameters
            long imgToStampWidth = 100;
            long imgToStampHeight = 100;
            long floatingDivWidth = 250;
            long floatingDivHeight = 300;
            String exprX = "PAGE_CENTER - IMAGE_WIDTH / 2";
            String exprY = "PAGE_MIDDLE - IMAGE_HEIGHT / 2";
            String stampType = "text";
            String stampAlign = "center";
            StampCoordinates stampCoordinates = okmStamp.calculateStampCoordinates(null, imgToStampWidth, imgToStampHeight,
                    floatingDivWidth, floatingDivHeight, exprX, exprY, stampType, stampAlign);
            System.out.println("X = " + stampCoordinates.getX() + ", Y = " + stampCoordinates.getY());
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

calculateStampExpressions

Descripción:

Método	Valores de retorno	Descripción
calculateStampExpressions(String token, long imgToStampWidth, long imgToStampHeight, long posX, long posY)	StampExpressions	Devuelve las expresiones calculadas del sello para X e Y.

Ejemplo:

package com.openkm;

import com.openkm.api.OKMStamp;
import com.openkm.util.ContextWrapper;
import com.openkm.ws.rest.util.StampExpressions;

public class Test {

    public static void main(String[] args) {
        try {
            OKMStamp okmStamp = ContextWrapper.getContext().getBean(OKMStamp.class);
            // Parameters
            long imgToStampWidth = 100;
            long imgToStampHeight = 100;
            long posX = 10;
            long posY = 50;
            StampExpressions stampExpressions = okmStamp.calculateStampExpressions(null, imgToStampWidth, imgToStampHeight, posX, posY);
            System.out.println("X = " + stampExpressions.getExprX() + ", Y = " + stampExpressions.getExprY());
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

stampDocument

Descripción:

Método	Valores de retorno	Descripción
stampDocument(String token, long id, int type, String uuid)	void	Sella el documento.

Nota

• Valor 0 para el tipo texto
• Valor 1 para el tipo imagen

• El parámetro type.

Ejemplo:

package com.openkm;

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

public class Test {

    public static void main(String[] args) {
        try {
            OKMStamp okmStamp = ContextWrapper.getContext().getBean(OKMStamp.class);
            long stampId = 1;
            okmStamp.stampDocument(null, stampId, 1, "babe24df-c443-49a5-9453-39dfc9b27924");
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

stampTextCustom

Descripción:

Método	Valores de retorno	Descripción
stampTextCustom(String token, String docId, long stId, String exprX, String exprY, String range, String text)	void	Sella un documento con texto personalizado.

Nota

El id es el id de un sello de imagen creado por el administrador.

exprX es la expresión para establecer la posición en las coordenadas X.

exprY es la expresión para establecer la posición en las coordenadas Y.

Nota

En los campos de entrada Expr. X y Expr. Y puede introducir algo más que un simple número. Actualmente están definidas las siguientes macros:

• IMAGE_WIDTH
• IMAGE_HEIGHT
• PAGE_WIDTH
• PAGE_HEIGHT
• PAGE_CENTER
• PAGE_MIDDLE

Así, para centrar un sello en la página puede usar:

Expr. X	PAGE_CENTER
Expr. Y	PAGE_MIDDLE
:::

Ejemplo:

package com.openkm;

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

public class Test {

    public static void main(String[] args) {
        try {
            OKMStamp okmStamp = ContextWrapper.getContext().getBean(OKMStamp.class);
            long stampTextId = 1;
            String text = "OpenKM";
            String exprX = "PAGE_CENTER";
            String exprY = "PAGE_MIDDLE";
            okmStamp.stampTextCustom(null, "05b14eee-2e57-4d1d-925a-c9bc3f526e24", stampTextId, exprX, exprY, "", text);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

stampImageCustom

Descripción:

Método	Valores de retorno	Descripción
stampImageCustom(String token, String uuid, long id, String exprX, String exprY, String range, String personalStampUuid)	void	Sella un documento con una imagen personalizada.

Nota

personalStampUuid debe ser un UUID de documento válido. El documento debe ser una imagen (jpg o png).

Ejemplo:

package com.openkm;

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

public class Test {

    public static void main(String[] args) {
        try {
            OKMStamp okmStamp = ContextWrapper.getContext().getBean(OKMStamp.class);
            long stampId = 3;
            String exprX = "PAGE_CENTER - IMAGE_WIDTH / 2";
            String exprY = "PAGE_MIDDLE - IMAGE_HEIGHT / 2";
            okmStamp.stampImageCustom(null, "babe24df-c443-49a5-9453-39dfc9b27924", stampId, exprX, exprY, "",
                    "928de61e-6ceb-4f94-bf20-9ba2405c5cee");
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

stampImageCustom

Descripción:

Método	Valores de retorno	Descripción
stampImageCustom(String token, String uuid, long id, String exprX, String exprY, String range, byte[] image)	void	Sella un documento con una imagen personalizada.

Nota

image debe ser una imagen (jpg o png).

Ejemplo:

package com.openkm;

import com.openkm.api.OKMStamp;
import com.openkm.util.ContextWrapper;
import org.apache.commons.io.*;
import java.io.*;

public class Test {

    public static void main(String[] args) {
        try {
            OKMStamp okmStamp = ContextWrapper.getContext().getBean(OKMStamp.class);
            InputStream is = new FileInputStream("/home/test/image.png");
            byte[] image = IOUtils.toByteArray(is);
            long stampId = 3;
            String exprX = "PAGE_CENTER - IMAGE_WIDTH / 2";
            String exprY = "PAGE_MIDDLE - IMAGE_HEIGHT / 2";
            okmStamp.stampImageCustom(null, "babe24df-c443-49a5-9453-39dfc9b27924", stampId, exprX, exprY, "", image);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getAllStamps

Descripción:

Método	Valores de retorno	Descripción
getAllStamps(String token)	List	Devuelve una lista de sellos.

Ejemplo:

package com.openkm;

import java.util.List;

import com.openkm.api.OKMStamp;
import com.openkm.util.ContextWrapper;
import com.openkm.ws.rest.util.StampItem;

public class Test {

    public static void main(String[] args) {
        try {
            OKMStamp okmStamp = ContextWrapper.getContext().getBean(OKMStamp.class);
            List<StampItem> result = okmStamp.getAllStamps(null);
            for (StampItem stampItem : result) {
                System.out.println(stampItem.getName());
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getStampTextByPk

Descripción:

Método	Valores de retorno	Descripción
getStampTextByPk(String token, long itemId, String docId)	StampText	Devuelve el objeto de sello por id.

Ejemplo:

package com.openkm;

import com.openkm.api.OKMStamp;
import com.openkm.db.bean.StampText;
import com.openkm.util.ContextWrapper;

public class Test {

    public static void main(String[] args) {
        try {
            OKMStamp okmStamp = ContextWrapper.getContext().getBean(OKMStamp.class);
            int stampId = 1;
            StampText stampText = okmStamp.getStampTextByPk(null, stampId, "928de61e-6ceb-4f94-bf20-9ba2405c5cee");
            System.out.println(stampText.getName());
            System.out.println(stampText.getDescription());
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getStampImageByPk

Descripción:

Método	Valores de retorno	Descripción
getStampImageByPk(String token, long id, String docId)	StampImage	Devuelve el objeto de sello por id.

Ejemplo:

package com.openkm;

import com.openkm.api.OKMStamp;
import com.openkm.db.bean.StampImage;
import com.openkm.util.ContextWrapper;

public class Test {

    public static void main(String[] args) {
        try {
            OKMStamp okmStamp = ContextWrapper.getContext().getBean(OKMStamp.class);
            int stampId = 3;
            StampImage stampImage = okmStamp.getStampImageByPk(null, stampId, "928de61e-6ceb-4f94-bf20-9ba2405c5cee");
            System.out.println(stampImage.getName());
            System.out.println(stampImage.getDescription());
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getStampBarcodeByPk

Descripción:

Método	Valores de retorno	Descripción
getStampBarcodeByPk(String token, long id, String docId)	StampBarcode	Devuelve el objeto de sello por id.

Ejemplo:

package com.openkm;

import com.openkm.api.OKMStamp;
import com.openkm.db.bean.StampBarcode;
import com.openkm.util.ContextWrapper;

public class Test {

    public static void main(String[] args) {
        try {
            OKMStamp okmStamp = ContextWrapper.getContext().getBean(OKMStamp.class);
            int stampId = 3;
            StampBarcode stampBarcode = okmStamp.getStampBarcodeByPk(null, stampId, "928de61e-6ceb-4f94-bf20-9ba2405c5cee");
            System.out.println(stampBarcode.getName());
            System.out.println(stampBarcode.getDescription());
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

calculateFlyImageDimensions

Descripción:

Método	Valores de retorno	Descripción
calculateFlyImageDimensions(String token, String uuid, long imgToStampWidth, long imgToStampHeight,long floatingImageWidth, long floatingImageHeight, int pageNumber)	StampImageSize	Devuelve las dimensiones de imagen calculadas del sello.

Ejemplo:

package com.openkm;

import com.openkm.api.OKMStamp;
import com.openkm.util.ContextWrapper;
import com.openkm.ws.rest.util.StampImageSize;

public class Test {

    public static void main(String[] args) {
        try {
            OKMStamp okmStamp = ContextWrapper.getContext().getBean(OKMStamp.class);
            // Parameters
            long imgToStampWidth = 100;
            long imgToStampHeight = 100;
            long floatingImageWidth = 300;
            long floatingImageHeight = 300;
            int pageNumber = 2;

            StampImageSize stampImageSize = okmStamp.calculateFlyImageDimensions(null, "babe24df-c443-49a5-9453-39dfc9b27924", imgToStampWidth, imgToStampHeight, floatingImageWidth, floatingImageHeight, pageNumber);
            System.out.println(stampImageSize);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getPersonalStamps

Descripción:

Método	Valores de retorno	Descripción
getPersonalStamps(String token)	List	Devuelve una lista de sellos personales.

Nota

Devuelve una lista de documentos de tipo imagen (jpg o png) de /okm:templates/userId/stamps

Ejemplo:

package com.openkm;

import java.util.List;

import com.openkm.api.OKMStamp;
import com.openkm.bean.Document;
import com.openkm.util.ContextWrapper;

public class Test {

    public static void main(String[] args) {
        try {
            OKMStamp okmStamp = ContextWrapper.getContext().getBean(OKMStamp.class);
            List<Document> result = okmStamp.getPersonalStamps(null);
            for (Document doc : result) {
                System.out.println(doc);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getPersonalStampImage

Descripción:

Método	Valores de retorno	Descripción
getPersonalStampImage(String token, String docId, String imgId, long id)	StampPersonalImage	Devuelve el sello personal procesado.

Nota

Al sellar un documento con una imagen, la imagen también puede tener una capa de texto.

Este método procesa la imagen y devuelve una imagen con la capa de texto.

uuid debe ser uno de los valores devueltos por el método getPersonalStamps.

Ejemplo:

package com.openkm;

import com.openkm.api.OKMStamp;
import com.openkm.util.ContextWrapper;
import com.openkm.ws.rest.util.StampPersonalImage;

public class Test {

    public static void main(String[] args) {
        try {
            OKMStamp okmStamp = ContextWrapper.getContext().getBean(OKMStamp.class);
            long stampId = 1;
            String imgId = ""; // stamp image id
            StampPersonalImage stampPersonalImage = okmStamp.getPersonalStampImage(null, "928de61e-6ceb-4f94-bf20-9ba2405c5cee", imgId, stampId);
            System.out.println(stampPersonalImage);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}