no.digipost.api.client.representations.sender.AuthorialSender 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
Java library for interacting with the Digipost REST API
There is a newer version: 16.3
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.sender;

import no.digipost.api.client.BrokerId;
import no.digipost.api.client.SenderId;
import no.digipost.api.client.representations.MayHaveSender;
import no.digipost.api.client.representations.SenderOrganization;

import java.util.Objects;

/**
 * The authorial sender of a message, i.e. what the receiver sees
 * as the sender.
 *
 * It is resolved based on the broker ID, and the optional presence of either a
 * {@link MayHaveSender#getSenderId() sender-ID} or
 * {@link MayHaveSender#getSenderOrganization() sender organization}. If neither of
 * those are present, the broker ID is used as the authorial sender.
 *
 *
 */
public final class AuthorialSender {

    public enum Type {
        ACCOUNT_ID, ORGANIZATION;
    }

    public static AuthorialSender resolve(BrokerId brokerId, MayHaveSender mayHaveAuthorialSender) {
        return mayHaveAuthorialSender
                .getSenderId().map(AuthorialSender::new)
                .orElseGet(() -> mayHaveAuthorialSender
                        .getSenderOrganization().map(AuthorialSender::new)
                        .orElseGet(() -> new AuthorialSender(brokerId.asSenderId())));
    }



    private final SenderId id;
    private final SenderOrganization organization;

    private AuthorialSender(SenderId senderId) {
        this.id = senderId;
        this.organization = null;
    }

    private AuthorialSender(SenderOrganization organization) {
        this.id = null;
        this.organization = organization;
    }

    public boolean is(Type type) {
        switch (type) {
            case ACCOUNT_ID: return id != null;
            case ORGANIZATION: return organization != null;
            default: return false;
        }
    }

    public SenderId getAccountId() {
        if (!is(Type.ACCOUNT_ID)) throw new IllegalStateException("account id of " + AuthorialSender.class.getSimpleName() + " is null. Actual: " + this);
        return id;
    }

    public SenderOrganization getOrganization() {
        if (!is(Type.ORGANIZATION)) throw new IllegalStateException("organization of " + AuthorialSender.class.getSimpleName() + " is null. Actual: " + this);
        return organization;
    }

    @Override
    public boolean equals(Object obj) {
        if (obj instanceof AuthorialSender) {
            AuthorialSender that = (AuthorialSender) obj;
            return Objects.equals(this.id, that.id) && Objects.equals(this.organization, that.organization);
        }
        return false;
    }

    @Override
    public int hashCode() {
        return Objects.hash(id, organization);
    }


    @Override
    public String toString() {
        StringBuilder s = new StringBuilder("authorial sender ");
        if (is(Type.ACCOUNT_ID)) {
            s.append(" ID: ").append(id);
        } else if (is(Type.ORGANIZATION)) {
            s.append(" organization: ").append(organization);
        } else {
            s.append(" ");
        }
        return s.toString();
    }

}