Package no.digipost.api.client.delivery
Interface MessageDeliveryApi
-
- All Known Implementing Classes:
ApiServiceImpl
public interface MessageDeliveryApi
Klasser som implementerer dette interfacet tar seg av de enkelte meldingsrelaterte HTTP-forespørslene man kan gjøre mot Digipost sitt API:- Sende meldinger til mottakere i Digipost og/eller print
- Hente søkeforslag (autocomplete)
- Søke etter mottakere
- Sende innholdet for en allerede opprettet forsendelsesressurs til serveren, og dermed sende brevet til mottakeren
- Hente dokument-events, dvs. hendelser knyttet til brev man tidligere har sendt
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description org.apache.http.client.methods.CloseableHttpResponse
addData(AddDataLink document, AdditionalData data)
Legger til ytterligere data til et dokument.UserAccount
createOrActivateUserAccount(SenderId senderId, UserInformation user)
org.apache.http.client.methods.CloseableHttpResponse
getEncryptionCertificateForPrint()
Henter public krypteringsnøkkel i x509 format for forsendelser som skal sendes til print.org.apache.http.client.methods.CloseableHttpResponse
getEncryptionKey(URI location)
SenderInformation
getSenderInformation(String orgnr, String avsenderenhet)
Henter informasjon om en avsender.SenderInformation
getSenderInformation(MayHaveSender message)
Henter informasjon om en faktisk avsender av en melding, altså det mottaker ser som avsender.SenderInformation
getSenderInformation(SenderId senderId)
Henter informasjon om en avsender.org.apache.http.client.methods.CloseableHttpResponse
identifyAndGetEncryptionKey(Identification identification)
Sjekker hvis spesifisert mottaker er Digipost-bruker.org.apache.http.client.methods.CloseableHttpResponse
identifyRecipient(Identification identification)
Recipients
search(String searchString)
Autocomplete
searchSuggest(String searchString)
org.apache.http.client.methods.CloseableHttpResponse
sendMultipartMessage(org.apache.http.HttpEntity multipart)
Oppretter og sender en multipartforsendelse
-
-
-
Method Detail
-
sendMultipartMessage
org.apache.http.client.methods.CloseableHttpResponse sendMultipartMessage(org.apache.http.HttpEntity multipart)
Oppretter og sender en multipartforsendelse
-
addData
org.apache.http.client.methods.CloseableHttpResponse addData(AddDataLink document, AdditionalData data)
Legger til ytterligere data til et dokument. Det er en forutsetning at dokumentet har datatype fra tidligere.
-
search
Recipients search(String searchString)
-
searchSuggest
Autocomplete searchSuggest(String searchString)
-
identifyRecipient
org.apache.http.client.methods.CloseableHttpResponse identifyRecipient(Identification identification)
-
identifyAndGetEncryptionKey
org.apache.http.client.methods.CloseableHttpResponse identifyAndGetEncryptionKey(Identification identification)
Sjekker hvis spesifisert mottaker er Digipost-bruker. Returnerer då også publik del av krypteringsnøkkel for Digipost-bruker. Nøkkelen brukes for å kryptere dokument-innhold for dokumenter som skal prekrypteres.
-
getEncryptionKey
org.apache.http.client.methods.CloseableHttpResponse getEncryptionKey(URI location)
-
getEncryptionCertificateForPrint
org.apache.http.client.methods.CloseableHttpResponse getEncryptionCertificateForPrint()
Henter public krypteringsnøkkel i x509 format for forsendelser som skal sendes til print.
-
getSenderInformation
SenderInformation getSenderInformation(MayHaveSender message)
Henter informasjon om en faktisk avsender av en melding, altså det mottaker ser som avsender.- Parameters:
message
- melding som skal sendes.
-
getSenderInformation
SenderInformation getSenderInformation(SenderId senderId)
Henter informasjon om en avsender.- Parameters:
senderId
- id-en til avsenderen.
-
getSenderInformation
SenderInformation getSenderInformation(String orgnr, String avsenderenhet)
Henter informasjon om en avsender. Avsender må ha godtatt å identifiseres med organisasjonsnummer og ev. underenhet.- Parameters:
orgnr
- organisasjonsnummeret til avsenderen.avsenderenhet
- underenhet for et organisasjonsnummer.
-
createOrActivateUserAccount
UserAccount createOrActivateUserAccount(SenderId senderId, UserInformation user)
-
-