no.digipost.api.client.representations.MessageDelivery 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
${project.artifactId}
There is a newer version: 6.16.1
Show newest version
/**
 * 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.representations;

import no.digipost.api.client.representations.xml.DateTimeXmlAdapter;
import org.joda.time.DateTime;

import javax.xml.bind.annotation.*;
import javax.xml.bind.annotation.adapters.XmlJavaTypeAdapter;

import java.util.Collections;
import java.util.List;

import static java.util.Collections.unmodifiableList;
import static no.motif.Base.is;
import static no.motif.Base.where;
import static no.motif.Iterate.on;
import static no.motif.Singular.the;

@XmlAccessorType(XmlAccessType.FIELD)
@XmlType(name = "message-delivery", propOrder = {
	    "messageId",
	    "deliveryMethod",
	    "senderId",
	    "status",
	    "deliveryTime",
	    "primaryDocument",
	    "attachments",
	    "links"
	})
@XmlRootElement(name = "message-delivery")
public class MessageDelivery extends Representation implements MayHaveSender {

	@XmlElement(name = "message-id")
	protected String messageId;
	@XmlElement(name = "delivery-method", required = true)
	protected Channel deliveryMethod;
	@XmlElement(name = "sender-id", nillable = false)
    protected long senderId;
	@XmlElement(required = true)
	protected MessageStatus status;
	@XmlElement(name = "delivery-time", type = String.class, nillable = false)
	@XmlJavaTypeAdapter(DateTimeXmlAdapter.class)
	@XmlSchemaType(name = "dateTime")
	protected DateTime deliveryTime;
	@XmlElement(name = "primary-document", required = true)
	protected Document primaryDocument;
	@XmlElement(name = "attachment")
	protected List attachments;

	public MessageDelivery() {
	}

	public MessageDelivery(String messageId, Channel channel, MessageStatus status, DateTime deliveryTime) {
		this.messageId = messageId;
		this.deliveryMethod = channel;
		this.status = status;
		this.deliveryTime = deliveryTime;
	}

	@XmlElement(name = "link")
	protected List getLinks() {
		return links;
	}

	protected void setLinks(final List links) {
		this.links = links;
	}

	public String getMessageId() {
		return messageId;
	}

	public List getAttachments() {
		return attachments != null ? unmodifiableList(attachments) : Collections.emptyList();
	}

	public boolean isSameMessageAs(final Message message) {
		return messageId.equals(message.messageId);
	}

	public MessageStatus getStatus() {
		return status;
	}

	public Link getEncryptionKeyLink() {
		return getLinkByRelationName(Relation.GET_ENCRYPTION_KEY);
	}

	public Link getSendLink() {
		return getLinkByRelationName(Relation.SEND);
	}

	public boolean willBeDeliveredInDigipost() {
		return Channel.DIGIPOST.equals(deliveryMethod);
	}

	public boolean isAlreadyDeliveredToDigipost() {
		return Channel.DIGIPOST.equals(deliveryMethod) && deliveryTime != null;
	}

	public Link getSelfLink() {
		return getLinkByRelationName(Relation.SELF);
	}

	public Channel getChannel() {
		return deliveryMethod;
	}

	public DateTime getDeliveryTime() {
		return deliveryTime;
	}

	public Document getPrimaryDocument() {
		return primaryDocument;
	}

	/**
	 * @return a list containing every {@link Document} in this delivery.
	 *         The primary document will be the first element of the list,
	 *         with the attachments following. The list is immutable and
	 *         can not be used to change which documents are in this
	 *         MessageDelivery.
	 */
	public List getAllDocuments() {
		return the(primaryDocument).append(getAttachments()).collect();
	}

	public Document getDocumentByUuid(String uuid) {
		for (Document document : on(getAllDocuments()).filter(where(Document.getUuid, is(uuid)))) {
			return document;
		}
		throw new IllegalArgumentException("Document with UUID '" + uuid + "' was not found in this " + getClass().getSimpleName() + ".");
    }

	/**
	 * Always returns the resolved sender-id of the message, i.e. what the receiver
	 * of the message sees as the sender of the message. If the originating {@link Message} has specified
	 * no {@link Message#senderId sender-id} nor {@link Message#senderOrganization sender-organization},
	 * it will be set to the broker-id which was specified in the X-Digipost-UserId header of the initiating request.
	 *
	 * @return always the sender-id, never {@code null}.
	 */
	@Override
	public Long getSenderId() {
		return senderId;
	}

	/**
	 * @return always {@code null}.
	 * @see MessageDelivery#getSenderId()
	 */
	@Override
	public SenderOrganization getSenderOrganization() {
		return null;
	}
}