Class DirectClient
java.lang.Object
no.digipost.signature.client.direct.DirectClient
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidconfirm(DirectJobStatusResponse receivedStatusResponse) Confirms that the status retrieved fromgetStatus(StatusReference)orgetStatusChange()is received.voiddeleteDocuments(DeleteDocumentsUrl deleteDocumentsUrl) getPAdES(PAdESReference pAdESReference) getStatus(StatusReference statusReference) Get the current status for the givenStatusReference, which references the status for a specific job.If there is a job with an updatedstatus, the returned object contains necessary information to act on the status change.getStatusChange(Sender sender) If there is a job with an updatedstatus, the returned object contains necessary information to act on the status change.getXAdES(XAdESReference xAdESReference) requestNewRedirectUrl(WithSignerUrl request)
-
Constructor Details
-
DirectClient
-
-
Method Details
-
create
-
requestNewRedirectUrl
-
getStatus
Get the current status for the givenStatusReference, which references the status for a specific job. When processing of the status is complete (e.g. retrievingPAdESand/orXAdESdocuments for acompletedjob where all signers havesignedtheir documents), the returned status must beconfirmed.- Parameters:
statusReference- the reference to the status of a specific job.- Returns:
- the
DirectJobStatusResponsefor the job referenced by the givenStatusReference, nevernull.
-
getStatusChange
If there is a job with an updatedstatus, 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. retrievingPAdESand/orXAdESdocuments for acompletedjob where all signers havesignedtheir documents, the returned status must beconfirmed.Only jobs with
status retrieval methodset toPOLLINGwill be returned.- Returns:
- the changed status for a job, or an instance indicating
no changes, nevernull.
-
getStatusChange
If there is a job with an updatedstatus, 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. retrievingPAdESand/orXAdESdocuments for acompletedjob where all signers havesignedtheir documents, the returned status must beconfirmed.Only jobs with
status retrieval methodset toPOLLINGwill be returned.- Returns:
- the changed status for a job, or an instance indicating
no changes, nevernull.
-
confirm
Confirms that the status retrieved fromgetStatus(StatusReference)orgetStatusChange()is received. If the confirmedDirectJobStatusis a terminal status (i.e.completedorfailed), 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 noConfirmationReferencehas 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 fromgetStatus(StatusReference).
-
getXAdES
-
getPAdES
-
deleteDocuments
-