com.so.net

Class SignApi.Behaviour.Builder

java.lang.Object

com.so.net.SignApi.Behaviour.Builder

Enclosing class:

SignApi.Behaviour

public static final class SignApi.Behaviour.Builder
extends Object

Builds a behaviour.

Method Summary

Modifier and Type	Method and Description
Optional<SignApi.Behaviour>	build() Builds the behaviour.
SignApi.Behaviour.Builder	doDigestAction(SignApi.Behaviour.DigestCallback callback) Whether to call a callback when the digest has been calculated.
SignApi.Behaviour.Builder	doHardwareSign() Whether to use hardware signing.
static SignApi.Behaviour.Builder	getDefault() The default behaviour.
SignApi.Behaviour.Builder	setExternalSignatureImage(BufferedImage externalSignatureImage) Image signing: Whether the "external signature image " feature shall be used.
SignApi.Behaviour.Builder	signInDocument(SignApi.Behaviour.DocSign.Rectangle.Builder docSignRectangleBuilder) Whether the "sign-in-document" feature shall be used.
SignApi.Behaviour.Builder	signInDocument(SignApi.Behaviour.DocSign.Rectangle docSignRectangle) Whether the "sign-in-document" feature shall be used.
SignApi.Behaviour.Builder	signInDocument(SignApi.Behaviour.DocSign.Rectangle docSignRectangle, boolean crop) Whether the "sign-in-document" feature shall be used.
SignApi.Behaviour.Builder	stamp(Color color, SignApi.Behaviour.Stamp.Font font, SignApi.Behaviour.Stamp.TextBuilder stampTextBuilder) The stamp is visible text in the signature image.
SignApi.Behaviour.Builder	useRectangle(SignApi.Behaviour.StdSign.Rectangle SignRectangle) Whether the "sign-in-standard" feature shall be used.
SignApi.Behaviour.Builder	useTsa(String address) Whether a TSA-signed-timestamp shall be part of the signature.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

build

public Optional<SignApi.Behaviour> build()

Builds the behaviour.

Returns:

The built behaviour in case of success.

getDefault

public static SignApi.Behaviour.Builder getDefault()

The default behaviour.

Returns:

A default builder.

useTsa

public SignApi.Behaviour.Builder useTsa(String address)

Whether a TSA-signed-timestamp shall be part of the signature.

Parameters:

address - The TSA's address.

Returns:

The changed builder.

doHardwareSign

public SignApi.Behaviour.Builder doHardwareSign()

Whether to use hardware signing.

Returns:

The changed builder.

useRectangle

public SignApi.Behaviour.Builder useRectangle(SignApi.Behaviour.StdSign.Rectangle SignRectangle)

Whether the "sign-in-standard" feature shall be used.

Parameters:

SignRectangle - Where the signature rectangle shall appear on the device display.

Returns:

The changed builder.

setExternalSignatureImage

public SignApi.Behaviour.Builder setExternalSignatureImage(BufferedImage externalSignatureImage)

Image signing: Whether the "external signature image " feature shall be used.

Parameters:

externalSignatureImage - the signature image shall appear on the pdf acroform.

Returns:

The changed builder.

signInDocument

public SignApi.Behaviour.Builder signInDocument(SignApi.Behaviour.DocSign.Rectangle docSignRectangle)

Whether the "sign-in-document" feature shall be used.

Parameters:

docSignRectangle - Where the signature rectangle shall appear on the device display.

Returns:

The changed builder.

signInDocument

public SignApi.Behaviour.Builder signInDocument(SignApi.Behaviour.DocSign.Rectangle.Builder docSignRectangleBuilder)

Whether the "sign-in-document" feature shall be used.

Parameters:

docSignRectangleBuilder - Where the signature rectangle shall appear on the device display.

Returns:

The changed builder.

signInDocument

public SignApi.Behaviour.Builder signInDocument(SignApi.Behaviour.DocSign.Rectangle docSignRectangle,
                                                boolean crop)

Whether the "sign-in-document" feature shall be used.

Parameters:

docSignRectangle - Where the signature rectangle shall appear on the device display.

crop - Whether the rendered document section shall be cropped to the size of the display area.

Returns:

The changed builder.

doDigestAction

public SignApi.Behaviour.Builder doDigestAction(SignApi.Behaviour.DigestCallback callback)

Whether to call a callback when the digest has been calculated.

Parameters:

callback - The callback.

Returns:

The changed builder.

stamp

public SignApi.Behaviour.Builder stamp(Color color,
                                       SignApi.Behaviour.Stamp.Font font,
                                       SignApi.Behaviour.Stamp.TextBuilder stampTextBuilder)

The stamp is visible text in the signature image.

Parameters:

color - The stamp text color.

font - A font. Pass null to use the default.

stampTextBuilder - A stamp text builder. Pass null to use the default;

Returns:

True in case of success.