com.lacunasoftware.restpki

Class SignatureStarter

java.lang.Object

com.lacunasoftware.restpki.SignatureStarter

Direct Known Subclasses:

CadesSignatureStarter, PadesSignatureStarter, XmlSignatureStarter

public abstract class SignatureStarter
extends java.lang.Object

Base class for PadesSignatureStarter and CadesSignatureStarter.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	callbackArgument
protected java.lang.String	certificate
protected PKCertificate	certificateInfo
protected RestPkiClient	client
protected boolean	done
protected boolean	ignoreRevocationStatusUnknown
protected java.lang.String	securityContextId
protected java.lang.String	signaturePolicyId

Constructor Summary

Constructors

Constructor and Description
SignatureStarter(RestPkiClient client) Create a new instance using the given RestPkiClient.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getCallbackArgument()
PKCertificate	getCertificateInfo() If the signer's certificate was given, this method returns its information (can only be called after calling the start() or startWithWebPki() methods).
RestPkiClient	getClient()
java.lang.String	getSecurityContext()
java.lang.String	getSecurityContextId() Deprecated.
java.lang.String	getSignaturePolicyId()
java.lang.String	getSignerCertificate()
void	setCallbackArgument(java.lang.String argument) Optional, sets a callback argument that will be returned on the second step.
void	setClient(RestPkiClient client)
void	setIgnoreRevocationStatusUnknown(boolean ignoreRevocationStatusUnknown) Sets the option of "IgnoreRevocationStatusUnknown".
void	setSecurityContext(SecurityContext securityContext) Sets the security context to be used to validate the signature.
java.lang.String	setSecurityContextId() Deprecated.
void	setSignaturePolicy(SignaturePolicy signaturePolicy) Sets the signature policy to be used for the signature.
void	setSignerCertificate(java.lang.String certificate) Sets the signer's certificate.
abstract ClientSideSignatureInstructions	start() Performs the first step, should be called after setting the necessary parameters.
abstract java.lang.String	startWithWebPki() Performs the first step, should be called after setting the necessary parameters.

Methods inherited from class java.lang.Object

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

Field Detail

client

protected RestPkiClient client

certificate

protected java.lang.String certificate

signaturePolicyId

protected java.lang.String signaturePolicyId

securityContextId

protected java.lang.String securityContextId

callbackArgument

protected java.lang.String callbackArgument

ignoreRevocationStatusUnknown

protected boolean ignoreRevocationStatusUnknown

done

protected boolean done

certificateInfo

protected PKCertificate certificateInfo

Constructor Detail

SignatureStarter

public SignatureStarter(RestPkiClient client)

Create a new instance using the given RestPkiClient.

Parameters:

client - the RestPkiClient which shall be used.

Method Detail

getSignerCertificate

public java.lang.String getSignerCertificate()

setSignerCertificate

public void setSignerCertificate(java.lang.String certificate)

Sets the signer's certificate. This is optional if the startWithWebPki() method will be used instead of the start() method.

Parameters:

certificate - The signer's certificate, encoded in Base64. If you're using the Web PKI component on the client-side, this is the format given by the component.

getSignaturePolicyId

public java.lang.String getSignaturePolicyId()

setSignaturePolicy

public void setSignaturePolicy(SignaturePolicy signaturePolicy)

Sets the signature policy to be used for the signature.

Parameters:

signaturePolicy - The signature policy. Depending on the policy, it might also be necessary to set a security context.

getSecurityContext

public java.lang.String getSecurityContext()

getSecurityContextId

@Deprecated
public java.lang.String getSecurityContextId()

Deprecated.

setSecurityContext

public void setSecurityContext(SecurityContext securityContext)

Sets the security context to be used to validate the signature. Depending on the signature policy selected, this may be mandatory. If the signature policy does not require a security context to be set but one is nevertheless passed, the given security context overrides the one that would otherwise be inferred from the policy.

Parameters:

securityContext - The security context to be used to validate the signature.

setSecurityContextId

@Deprecated
public java.lang.String setSecurityContextId()

Deprecated.

getCallbackArgument

public java.lang.String getCallbackArgument()

setCallbackArgument

public void setCallbackArgument(java.lang.String argument)

Optional, sets a callback argument that will be returned on the second step.

The callback argument can be used to simplify the code of the client application. For instance, it might be the ID of the document being signed.

As the PDF content, the callback argument is also stored in the server with AES-128 encryption using a key which is never stored by the server, therefore it cannot read the value on its own, protecting it against compromise even in the event of a complete data leakage.

Parameters:

argument - The callback argument, a string whose UTF-8 encoding must not exceed 200 bytes.

getClient

public RestPkiClient getClient()

setClient

public void setClient(RestPkiClient client)

setIgnoreRevocationStatusUnknown

public void setIgnoreRevocationStatusUnknown(boolean ignoreRevocationStatusUnknown)

Sets the option of "IgnoreRevocationStatusUnknown".

Parameters:

ignoreRevocationStatusUnknown - The option of "IgnoreRevocationStatusUnknown".

start

public abstract ClientSideSignatureInstructions start()
                                               throws RestException

Performs the first step, should be called after setting the necessary parameters. If you intend to use the Web PKI component on the client-side, use the startWithWebPki() method instead.

Returns:

An instance of ClientSideSignatureInstructions with the information necessary to perform the client-side signature and later call the server back with the results.

Throws:

RestException - if an error occurs when calling REST PKI.

startWithWebPki

public abstract java.lang.String startWithWebPki()
                                          throws RestException

Performs the first step, should be called after setting the necessary parameters. This method should be used if the Web PKI component is being used on the client-side.

Returns:

The token that should be passed on the signWithRestPki method of the Web PKI component (on the client-side logic).

Throws:

RestException - if an error occurs when calling REST PKI

getCertificateInfo

public PKCertificate getCertificateInfo()

If the signer's certificate was given, this method returns its information (can only be called after calling the start() or startWithWebPki() methods).

Returns:

The signer's certificate information, or null if no certificate was given.