com.lacunasoftware.restpki

Class CadesSignatureStarter2

java.lang.Object

com.lacunasoftware.restpki.SignatureStarter2

com.lacunasoftware.restpki.CadesSignatureStarter2

public class CadesSignatureStarter2
extends SignatureStarter2

Field Summary

Fields inherited from class com.lacunasoftware.restpki.SignatureStarter2

callbackArgument, certificateBase64, client, ignoreRevocationStatusUnknown, securityContextId, signaturePolicyId

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	setCmsToCoSign(byte[] cmsToCoSign) Sets the CMS to be co-signed as a byte array.
void	setCmsToCoSign(FileResult fileResult) Sets the file resulted from a previous signature to be co-signed.
void	SetCmsToCoSign(FileResult fileResult) Deprecated.
void	setCmsToCoSign(java.io.InputStream stream) Sets the CMS to be co-signed.
void	setCmsToCoSign(java.nio.file.Path path) Sets the path of the CMS file to be co-signed.
void	setCmsToCoSign(java.lang.String path) Sets the path of the CMS file to be co-signed.
void	setContentToSign(byte[] content) Sets the content to be signed as a byte array.
void	setContentToSign(java.io.InputStream stream) Sets the content to be signed.
void	setEncapsulateContent(java.lang.Boolean encapsulateContent) Optionally denotes whether the resulting CMS should include the content signed.
void	setFileToSign(java.nio.file.Path path) Sets the path of the file to be signed.
void	setFileToSign(java.lang.String path) Sets the path of the file to be signed.
SignatureStartResult	start() Performs the first step, should be called after setting the necessary parameters.
SignatureStartWithWebPkiResult	startWithWebPki() Performs the first step, should be called after setting the necessary parameters.

Methods inherited from class com.lacunasoftware.restpki.SignatureStarter2

setCallbackArgument, setIgnoreRevocationStatusUnknown, setSecurityContext, setSignaturePolicy, setSignerCertificate, setSignerCertificateBase64, setSignerCertificateRaw

Methods inherited from class java.lang.Object

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

Constructor Detail

CadesSignatureStarter2

public CadesSignatureStarter2(RestPkiClient client)

Create a new instance using the given RestPkiClient.

Parameters:

client - the RestPkiClient which shall be used.

Method Detail

setContentToSign

public void setContentToSign(java.io.InputStream stream)

Sets the content to be signed.

Parameters:

stream - a pre-opened InputStream linked to the file that will be signed. The stream is NOT closed by this method.

setContentToSign

public void setContentToSign(byte[] content)

Sets the content to be signed as a byte array.

Parameters:

content - Binary content to be signed.

setFileToSign

public void setFileToSign(java.lang.String path)

Sets the path of the file to be signed.

Parameters:

path - Path of the file to be signed.

setFileToSign

public void setFileToSign(java.nio.file.Path path)

Sets the path of the file to be signed.

Parameters:

path - Path of the file to be signed.

setCmsToCoSign

public void setCmsToCoSign(java.io.InputStream stream)

Sets the CMS to be co-signed.

Parameters:

stream - a pre-opened InputStream linked to the CMS file that will be co-signed. The stream is NOT closed by this method.

setCmsToCoSign

public void setCmsToCoSign(byte[] cmsToCoSign)

Sets the CMS to be co-signed as a byte array.

Parameters:

cmsToCoSign - Binary content of the CMS to be co-signed.

setCmsToCoSign

public void setCmsToCoSign(java.lang.String path)

Sets the path of the CMS file to be co-signed.

Parameters:

path - Path of the CMS file to be co-signed.

setCmsToCoSign

public void setCmsToCoSign(java.nio.file.Path path)

Sets the path of the CMS file to be co-signed.

Parameters:

path - Path of the CMS file to be co-signed.

SetCmsToCoSign

@Deprecated
public void SetCmsToCoSign(FileResult fileResult)

Deprecated.

setCmsToCoSign

public void setCmsToCoSign(FileResult fileResult)

Sets the file resulted from a previous signature to be co-signed.

Parameters:

fileResult - FileResult from another signature process.

setEncapsulateContent

public void setEncapsulateContent(java.lang.Boolean encapsulateContent)

Optionally denotes whether the resulting CMS should include the content signed. If omitted or set to null, the following rules apply:

If no CmsToSign is given, the resulting CMS will include the content

If a CmsToCoSign is given, the resulting CMS will include the content if and only if the CmsToCoSign also includes the content

start

public SignatureStartResult start()
                           throws RestException,
                                  java.io.IOException

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.

Specified by:

start in class SignatureStarter2

Returns:

An instance of SignatureStartResult 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.

java.io.IOException - if an error occurs when trying to obtain the file to be signed or be cosign or when trying to compute all hashes from this file, both files had to be provided before this method is called.

startWithWebPki

public SignatureStartWithWebPkiResult startWithWebPki()
                                               throws RestException,
                                                      java.io.IOException

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.

Specified by:

startWithWebPki in class SignatureStarter2

Returns:

An instance of SignatureStartWithWebPkiResult containing the token that should be passed on the signWithRestPki() method of the Web PKI component (on the client-side logic) and the signer's certificate.

Throws:

RestException - if an error occurs when calling REST PKI.

java.io.IOException - if an error occurs when trying to obtain the file to be signed or be cosign or when trying to compute all hashes from this file, both files had to be provided before this method is called.