Package no.digipost.signature.client.portal

Class PortalClient

java.lang.Object

no.digipost.signature.client.portal.PortalClient

public class PortalClient
extends Object

Constructor Summary

Constructors

Constructor	Description
PortalClient(ClientConfiguration config)

Method Summary

Modifier and Type	Method	Description
void	cancel(Cancellable cancellable)
void	confirm(PortalJobStatusChanged receivedStatusChanged)	Confirms that the status retrieved from getStatusChange() is received and may be discarded by the Signature service and not retrieved again.
PortalJobResponse	create(PortalJob job)
void	deleteDocuments(DeleteDocumentsUrl deleteDocumentsUrl)
ResponseInputStream	getPAdES(PAdESReference pAdESReference)
PortalJobStatusChanged	getStatusChange()	If there is a job with an updated status, the returned object contains necessary information to act on the status change.
PortalJobStatusChanged	getStatusChange(Sender sender)	If there is a job with an updated status, the returned object contains necessary information to act on the status change.
ResponseInputStream	getXAdES(XAdESReference xAdESReference)

Methods inherited from class java.lang.Object

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

Constructor Details

PortalClient

public PortalClient(ClientConfiguration config)

Method Details

create

public PortalJobResponse create(PortalJob job)

getStatusChange

public PortalJobStatusChanged getStatusChange()

If there is a job with an updated status, the returned object contains necessary information to act on the status change. The returned object can be queried using .is(NO_CHANGES) to determine if there has been a status change. When processing of the status change is complete, (e.g. retrieving PAdES and/or XAdES documents for a completed job where all signers have signed their documents), the returned status must be confirmed.

Returns:

the changed status for a job, or an instance indicating no changes, never null.

getStatusChange

public PortalJobStatusChanged getStatusChange(Sender sender)

If there is a job with an updated status, the returned object contains necessary information to act on the status change. The returned object can be queried using .is(NO_CHANGES) to determine if there has been a status change. When processing of the status change is complete, (e.g. retrieving PAdES and/or XAdES documents for a completed job where all signers have signed their documents), the returned status must be confirmed.

Returns:

the changed status for a job, or an instance indicating no changes, never null.

confirm

public void confirm(PortalJobStatusChanged receivedStatusChanged)

Confirms that the status retrieved from getStatusChange() is received and may be discarded by the Signature service and not retrieved again. Calling this method on a status update with no ConfirmationReference has no effect.

Parameters:

receivedStatusChanged - the updated status retrieved from getStatusChange().

cancel

public void cancel(Cancellable cancellable)

getXAdES

public ResponseInputStream getXAdES(XAdESReference xAdESReference)

getPAdES

public ResponseInputStream getPAdES(PAdESReference pAdESReference)

deleteDocuments

public void deleteDocuments(DeleteDocumentsUrl deleteDocumentsUrl)