Package no.digipost.signature.client.direct

Class DirectClient

java.lang.Object

no.digipost.signature.client.direct.DirectClient

public class DirectClient
extends Object

Constructor Summary

Constructors

Constructor	Description
DirectClient(ClientConfiguration config)

Method Summary

Modifier and Type	Method	Description
void	confirm(DirectJobStatusResponse receivedStatusResponse)	Confirms that the status retrieved from getStatus(StatusReference) or getStatusChange() is received.
DirectJobResponse	create(DirectJob job)
void	deleteDocuments(DeleteDocumentsUrl deleteDocumentsUrl)
ResponseInputStream	getPAdES(PAdESReference pAdESReference)
DirectJobStatusResponse	getStatus(StatusReference statusReference)	Get the current status for the given StatusReference, which references the status for a specific job.
DirectJobStatusResponse	getStatusChange()	If there is a job with an updated status, the returned object contains necessary information to act on the status change.
DirectJobStatusResponse	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)
DirectSignerResponse	requestNewRedirectUrl(WithSignerUrl request)

Methods inherited from class java.lang.Object

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

Constructor Details

DirectClient

public DirectClient(ClientConfiguration config)

Method Details

create

public DirectJobResponse create(DirectJob job)

requestNewRedirectUrl

public DirectSignerResponse requestNewRedirectUrl(WithSignerUrl request)

getStatus

public DirectJobStatusResponse getStatus(StatusReference statusReference)

Get the current status for the given StatusReference, which references the status for a specific job. When processing of the status 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.

Parameters:

statusReference - the reference to the status of a specific job.

Returns:

the DirectJobStatusResponse for the job referenced by the given StatusReference, never null.

getStatusChange

public DirectJobStatusResponse 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.

Only jobs with status retrieval method set to POLLING will be returned.

Returns:

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

getStatusChange

public DirectJobStatusResponse 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.

Only jobs with status retrieval method set to POLLING will be returned.

Returns:

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

confirm

public void confirm(DirectJobStatusResponse receivedStatusResponse)

Confirms that the status retrieved from getStatus(StatusReference) or getStatusChange() is received. If the confirmed DirectJobStatus is a terminal status (i.e. completed or failed), the Signature service may make the job's associated resources unavailable through the API when receiving the confirmation. Calling this method for a response with no ConfirmationReference has no effect.

If the status is retrieved using the polling method, failing to confirm the received response may cause subsequent statuses for the same job to be reported as "changed", even though the status has not changed.

Parameters:

receivedStatusResponse - the updated status retrieved from getStatus(StatusReference).

getXAdES

public ResponseInputStream getXAdES(XAdESReference xAdESReference)

getPAdES

public ResponseInputStream getPAdES(PAdESReference pAdESReference)

deleteDocuments

public void deleteDocuments(DeleteDocumentsUrl deleteDocumentsUrl)