no.digipost.api.client.DigipostClient Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of digipost-api-client-java Show documentation
Show all versions of digipost-api-client-java Show documentation
Java library for interacting with the Digipost REST API
/*
* Copyright (C) Posten Norge AS
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package no.digipost.api.client;
import no.digipost.api.client.archive.ArchiveApi;
import no.digipost.api.client.batch.BatchApi;
import no.digipost.api.client.delivery.MessageDeliveryApi;
import no.digipost.api.client.delivery.OngoingDelivery;
import no.digipost.api.client.document.DocumentApi;
import no.digipost.api.client.errorhandling.DigipostClientException;
import no.digipost.api.client.errorhandling.ErrorCode;
import no.digipost.api.client.inbox.InboxApi;
import no.digipost.api.client.internal.ApiServiceImpl;
import no.digipost.api.client.internal.delivery.ArchiveDeliverer;
import no.digipost.api.client.internal.delivery.MessageDeliverer;
import no.digipost.api.client.representations.AddDataLink;
import no.digipost.api.client.representations.AdditionalData;
import no.digipost.api.client.representations.Autocomplete;
import no.digipost.api.client.representations.DocumentEvents;
import no.digipost.api.client.representations.DocumentStatus;
import no.digipost.api.client.representations.Identification;
import no.digipost.api.client.representations.IdentificationResult;
import no.digipost.api.client.representations.Link;
import no.digipost.api.client.representations.Message;
import no.digipost.api.client.representations.PersonalIdentificationNumber;
import no.digipost.api.client.representations.Recipients;
import no.digipost.api.client.representations.accounts.Tag;
import no.digipost.api.client.representations.accounts.Tags;
import no.digipost.api.client.representations.accounts.UserAccount;
import no.digipost.api.client.representations.accounts.UserInformation;
import no.digipost.api.client.representations.archive.Archive;
import no.digipost.api.client.representations.archive.ArchiveDocument;
import no.digipost.api.client.representations.archive.ArchiveDocumentContent;
import no.digipost.api.client.representations.archive.Archives;
import no.digipost.api.client.representations.batch.Batch;
import no.digipost.api.client.representations.inbox.Inbox;
import no.digipost.api.client.representations.inbox.InboxDocument;
import no.digipost.api.client.representations.sender.SenderInformation;
import no.digipost.api.client.security.CryptoUtil;
import no.digipost.api.client.security.Signer;
import no.digipost.api.client.tag.TagApi;
import no.digipost.api.client.util.JAXBContextUtils;
import no.digipost.http.client3.DigipostHttpClientFactory;
import org.apache.http.client.methods.CloseableHttpResponse;
import org.apache.http.impl.client.HttpClientBuilder;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import java.io.IOException;
import java.io.InputStream;
import java.net.URI;
import java.time.ZonedDateTime;
import java.util.UUID;
import static no.digipost.api.client.internal.http.response.HttpResponseUtils.checkResponse;
import static no.digipost.api.client.util.JAXBContextUtils.jaxbContext;
/**
* En klient for å sende brev gjennom Digipost. Hvis et objekt av denne klassen
* er opprettet med et fungerende sertifikat og tilhørende passord, kan man
* gjøre søk og sende brev gjennom Digipost.
*/
public class DigipostClient {
static {
CryptoUtil.addBouncyCastleProviderAndVerify_AES256_CBC_Support();
}
private static final Logger LOG = LoggerFactory.getLogger(DigipostClient.class);
private final EventLogger eventLogger;
private final MessageDeliveryApi messageApi;
private final MessageDeliverer messageSender;
private final ArchiveDeliverer archiveSender;
private final InboxApi inboxApiService;
private final DocumentApi documentApi;
private final ArchiveApi archiveApi;
private final BatchApi batchApi;
private final TagApi tagApi;
public DigipostClient(DigipostClientConfig config, BrokerId brokerId, Signer signer) {
this(config, brokerId, signer, DigipostHttpClientFactory.createDefaultBuilder());
}
public DigipostClient(DigipostClientConfig config, BrokerId brokerId, Signer signer, HttpClientBuilder clientBuilder) {
this(config, new ApiServiceImpl(config, clientBuilder, brokerId, signer));
}
private DigipostClient(DigipostClientConfig config, ApiServiceImpl apiService) {
this(config, apiService, apiService, apiService, apiService, apiService, apiService);
}
public DigipostClient(DigipostClientConfig config, MessageDeliveryApi apiService, InboxApi inboxApiService, DocumentApi documentApi, ArchiveApi archiveApi, BatchApi batchApi, TagApi tagApi) {
this.messageApi = apiService;
this.inboxApiService = inboxApiService;
this.documentApi = documentApi;
this.archiveApi = archiveApi;
this.batchApi = batchApi;
this.tagApi = tagApi;
this.messageSender = new MessageDeliverer(config, apiService);
this.archiveSender = new ArchiveDeliverer(config, archiveApi);
this.eventLogger = config.eventLogger.withDebugLogTo(LOG);
}
/**
* Oppretter en forsendelse for sending gjennom Digipost. Dersom mottaker ikke er
* digipostbruker og det ligger printdetaljer på forsendelsen bestiller vi
* print av brevet til vanlig postgang. (Krever at avsender har fått tilgang
* til print.)
*/
public OngoingDelivery.WithPrintFallback createMessage(final Message message) {
return messageSender.createMessage(message);
}
/**
* Opprette forsendelse som skal gå direkte til print og videre til utsending
* gjennom vanlig postgang. Krever at avsender har tilgang til å sende direkte
* til print.
*/
public OngoingDelivery.ForPrintOnly createPrintOnlyMessage(final Message printMessage) {
return messageSender.createPrintOnlyMessage(printMessage);
}
public IdentificationResult identifyRecipient(final Identification identification) {
try (CloseableHttpResponse response = messageApi.identifyRecipient(identification)) {
checkResponse(response, eventLogger);
return JAXBContextUtils.unmarshal(jaxbContext, response.getEntity().getContent(), IdentificationResult.class);
} catch (IOException e) {
throw new DigipostClientException(ErrorCode.GENERAL_ERROR, e);
}
}
public void addData(AddDataLink addDataLink, AdditionalData data) {
messageSender.addData(addDataLink, data);
}
public Recipients search(final String searchString) {
return messageApi.search(searchString);
}
public Autocomplete getAutocompleteSuggestions(final String searchString) {
return messageApi.searchSuggest(searchString);
}
public DocumentEvents getDocumentEvents(ZonedDateTime from, ZonedDateTime to, int offset, int maxResults) {
return getDocumentEvents(null, from, to, offset, maxResults);
}
public DocumentEvents getDocumentEvents(SenderId senderId, ZonedDateTime from, ZonedDateTime to, int offset, int maxResults) {
return documentApi.getDocumentEvents(null, null, senderId, from, to, offset, maxResults);
}
public DocumentEvents getDocumentEvents(String organisation, String partId, ZonedDateTime from, ZonedDateTime to, int offset, int maxResults) {
return documentApi.getDocumentEvents(organisation, partId, null, from, to, offset, maxResults);
}
/**
* Hent informasjon om en gitt avsender. Kan enten be om informasjon om
* "deg selv", eller en avsender du har fullmakt til å sende post for.
*
* @param senderId avsender-IDen til avsenderen du vil ha informasjon om.
*
* @return informasjon om avsenderen, dersom den finnes, og du har tilgang
* til å informasjon om avsenderen. Det er ikke mulig å skille på
* om avsenderen ikke finnes, eller man ikke har tilgang til
* informasjonen.
*
* @see SenderInformation
*/
public SenderInformation getSenderInformation(SenderId senderId) {
return messageApi.getSenderInformation(senderId);
}
/**
* Hent informasjon om en gitt avsender. Kan enten be om informasjon om
* "deg selv", eller en avsender du har fullmakt til å sende post for.
*
* @param orgnr organisasjonsnummeret til avsenderen (påkrevet).
* @param avsenderenhet underenhet for gitt orgnr, dersom
* aktuelt, eller null.
*
*
* @return informasjon om avsenderen, dersom den finnes, og du har tilgang
* til å informasjon om avsenderen. Det er ikke mulig å skille på
* om avsenderen ikke finnes, eller man ikke har tilgang til
* informasjonen.
*
* @see SenderInformation
*/
public SenderInformation getSenderInformation(String orgnr, String avsenderenhet) {
return messageApi.getSenderInformation(orgnr, avsenderenhet);
}
public DocumentStatus getDocumentStatus(Link linkToDocumentStatus) {
return documentApi.getDocumentStatus(linkToDocumentStatus);
}
public DocumentStatus getDocumentStatus(SenderId senderId, UUID uuid) {
return documentApi.getDocumentStatus(senderId, uuid);
}
public InputStream getContent(String path) {
return documentApi.getDocumentContent(path);
}
/**
* Get a list of all the archives
* @return An Archives contains a list of archives
*/
public Archives getArchives() {
return archiveApi.getArchives(null);
}
/**
* Get a list of all the archives for the organisation represented by senderId.
*
* @param senderId Either an organisation that you operate on behalf of or your brokerId
* @return An Archives contains a list of archives
*/
public Archives getArchives(SenderId senderId) {
return archiveApi.getArchives(senderId);
}
/**
* An Archive has an optional URL to fetch documents paged 100 at a time.
* Eg.: `archive.getNextDocuments()`
*
* It can also be used by the url supplied by
* `archive.getNextDocumentsWithAttributes(Map.of("MyKey", "MyVal")`
* This will return paged results that matches the attributes supplied.
* More attributes narrows the search (S1 AND S2).
*
* @param uri URI supplied by the api with Relation NEXT_DOCUMENTS
* @return An archive with documents.
*/
public Archive getArchiveDocuments(URI uri) {
return archiveApi.getArchiveDocuments(uri);
}
/**
* Get the first 100 documents in the inbox for the organisation represented by senderId.
*
* @param senderId Either an organisation that you operate on behalf of or your brokerId
* @return Inbox element with the 100 first documents
*/
public Inbox getInbox(SenderId senderId) {
return getInbox(senderId, 0, 100);
}
/**
* Get documents from the inbox for the organisation represented by senderId.
*
* @param senderId Either an organisation that you operate on behalf of or your brokerId
* @param offset Number of documents to skip. For pagination
* @param limit Maximum number of documents to retrieve (max 1000)
* @return Inbox element with the n=limit first documents
*/
public Inbox getInbox(SenderId senderId, int offset, int limit) {
return inboxApiService.getInbox(senderId, offset, limit);
}
/**
* Get the content of a document as a stream. The content is streamed from the server so remember to
* close the stream to prevent connection leaks.
*
* @param inboxDocument The document to get content for
* @return Entire content of the document as a stream
*/
public InputStream getInboxDocumentContent(InboxDocument inboxDocument) {
return inboxApiService.getInboxDocumentContentStream(inboxDocument);
}
/**
* Delets the given document from the server
*
* @param inboxDocument The document to delete
*/
public void deleteInboxDocument(InboxDocument inboxDocument) {
inboxApiService.deleteInboxDocument(inboxDocument);
}
public UserAccount createOrActivateUserAccount(SenderId senderId, UserInformation user) {
return messageApi.createOrActivateUserAccount(senderId, user);
}
public void addTag(Tag tag) {
tagApi.addTag(tag);
}
public void removeTag(Tag tag) {
tagApi.removeTag(tag);
}
public Tags getTags(PersonalIdentificationNumber personalIdentificationNumber) {
return tagApi.getTags(personalIdentificationNumber);
}
public ArchiveApi.ArchivingDocuments archiveDocuments(final Archive archive) {
return archiveSender.createArchive(archive);
}
public Archive getArchiveDocumentByUuid(UUID uri) {
return archiveApi.getArchiveDocumentByUUID(null, uri);
}
public Archive getArchiveDocumentByUuid(SenderId senderId, UUID uuid) {
return archiveApi.getArchiveDocumentByUUID(senderId, uuid);
}
public Archive addUniqueUUIDToArchiveDocument(UUID uuid, UUID newuuid) {
return archiveApi.addUniqueUUIDToArchiveDocument(null, uuid, newuuid);
}
public Archive addUniqueUUIDToArchiveDocument(SenderId senderId, UUID uuid, UUID newuuid) {
return archiveApi.addUniqueUUIDToArchiveDocument(senderId, uuid, newuuid);
}
public Archives getArchiveDocumentsByReferenceId(SenderId senderId, String referenceId) {
return archiveApi.getArchiveDocumentsByReferenceId(senderId, referenceId);
}
public ArchiveDocumentContent getArchiveDocumentContent(URI uri) {
return archiveApi.getArchiveDocumentContent(uri);
}
public InputStream getArchiveDocumentContentStream(URI uri) {
return archiveApi.getArchiveDocumentContentStream(uri);
}
public void deleteArchiveDocument(URI archiveDocument) {
archiveApi.deleteArchiveDocumentByUUID(archiveDocument);
}
public ArchiveDocument updateArchiveDocument(ArchiveDocument archiveDocument, URI uri) {
return archiveApi.saveArchiveDocument(archiveDocument, uri);
}
public Batch createBatch(UUID batchUUID) {
return batchApi.createBatch(batchUUID);
}
public Batch getBatchInformation(UUID batchUUID) {
return batchApi.getBatchInformation(batchUUID);
}
public Batch completeBatch(Batch batch) {
return batchApi.completeBatch(batch);
}
public void cancelBatch(Batch batch) {
batchApi.cancelBatch(batch);
}
}