com.lacunasoftware.restpki

Class SignatureFinisher

java.lang.Object

com.lacunasoftware.restpki.SignatureFinisher

Direct Known Subclasses:

CadesSignatureFinisher, PadesSignatureFinisher, XmlSignatureFinisher

public abstract class SignatureFinisher
extends java.lang.Object

Base class for PadesSignatureFinisher and CadesSignatureFinisher

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	callbackArgument
protected PKCertificate	certificateInfo
protected RestPkiClient	client
protected boolean	done
protected java.lang.String	signature
protected java.lang.String	token

Constructor Summary

Constructors

Constructor and Description
SignatureFinisher(RestPkiClient client)

Method Summary

Modifier and Type	Method and Description
abstract byte[]	finish() Performs the step (should only be called after calling setToken()).
java.lang.String	getCallbackArgument() Returns the callback argument, if one was passed during the first step (must only be called after calling the finish() method).
PKCertificate	getCertificateInfo() Returns information about the signer's certificate (can only be called after calling the finish() method).
void	setSignature(java.lang.String signature) Sets the signature performed using the user certificate's private key (should not be used if the signature was started with the method startWithWebPki).
void	setToken(java.lang.String token) Sets the token previously yielded by the first step.

Methods inherited from class java.lang.Object

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

Field Detail

client

protected RestPkiClient client

token

protected java.lang.String token

signature

protected java.lang.String signature

done

protected boolean done

callbackArgument

protected java.lang.String callbackArgument

certificateInfo

protected PKCertificate certificateInfo

Constructor Detail

SignatureFinisher

public SignatureFinisher(RestPkiClient client)

Method Detail

setToken

public void setToken(java.lang.String token)

Sets the token previously yielded by the first step.

Parameters:

token - The token, a 43-character case-sensitive string containing only letters, numbers and the characters "-" and "_" (therefore URL and HTML safe).

setSignature

public void setSignature(java.lang.String signature)

Sets the signature performed using the user certificate's private key (should not be used if the signature was started with the method startWithWebPki).

Parameters:

signature - The signature operation output, encoded in Base64 (this is the format returned by the Web PKI component's signData and signHash methods).

finish

public abstract byte[] finish()
                       throws RestException

Performs the step (should only be called after calling setToken()). This method throws a ValidationException if the validation of the signature or of the user's certificate fails.

Returns:

The signature result (for PadesSignatureFinisher, the signed PDF's bytes, for CadesSignatureFinisher, the CMS's bytes)

Throws:

RestException - If an error occurs while calling the REST PKI API or if validation of the signature or of the user's certificate fails.

getCallbackArgument

public java.lang.String getCallbackArgument()

Returns the callback argument, if one was passed during the first step (must only be called after calling the finish() method).

Returns:

The callback argument passed previously on the first step, or null if no argument was passed.

getCertificateInfo

public PKCertificate getCertificateInfo()

Returns information about the signer's certificate (can only be called after calling the finish() method).

Returns:

The signer's certificate information.