com.flowcentraltech.flowcentral.notification.data.NotifChannelDef Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of flowcentral-notification Show documentation
Flowcentral Notification Module
There is a newer version: 3.0.2
Show newest version
/*
 * Copyright 2021-2024 FlowCentral Technologies Limited.
 * 
 * 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 com.flowcentraltech.flowcentral.notification.data;

import java.util.Collections;
import java.util.Date;
import java.util.HashMap;
import java.util.Map;

import com.flowcentraltech.flowcentral.common.data.BaseNamedDef;
import com.flowcentraltech.flowcentral.configuration.constants.NotifType;
import com.tcdng.unify.convert.util.ConverterUtils;
import com.tcdng.unify.core.UnifyException;

/**
 * Notification channel definition.
 * 
 * @author FlowCentral Technologies Limited
 * @since 1.0
 */
public class NotifChannelDef extends BaseNamedDef {

    private NotifType notifType;

    private String senderName;

    private String senderContact;

    private Map propDefMap;

    private Date nextTransmissionOn;

    private int messagesPerMinute;

    private boolean channelConfigured;

    private NotifChannelDef(NotifType notifType, String senderName, String senderContact,
            Map propDefMap, Date nextTransmissionOn, int messagesPerMinute, String name,
            String description, Long id, long version) {
        super(name, description, id, version);
        this.notifType = notifType;
        this.senderName = senderName;
        this.senderContact = senderContact;
        this.propDefMap = propDefMap;
        this.nextTransmissionOn = nextTransmissionOn;
        this.messagesPerMinute = messagesPerMinute;

    }

    public NotifType getNotificationType() {
        return notifType;
    }

    public String getSenderName() {
        return senderName;
    }

    public String getSenderContact() {
        return senderContact;
    }

    public Date getNextTransmissionOn() {
        return nextTransmissionOn;
    }

    public int getMessagesPerMinute() {
        return messagesPerMinute;
    }

    public boolean isThrottled() {
        return messagesPerMinute > 0 && nextTransmissionOn != null;
    }

    public boolean isThrottledAndIsNotDue(Date now) {
        return isThrottled() && nextTransmissionOn.compareTo(now) > 0;
    }

    public boolean isChannelConfigured() {
        return channelConfigured;
    }

    public void setChannelConfigured() {
        this.channelConfigured = true;
    }

    @SuppressWarnings("unchecked")
    public  T getPropValue(Class dataClazz, String name) throws UnifyException {
        NotifChannelPropDef notifChannelPropDef = propDefMap.get(name);
        if (notifChannelPropDef != null) {
            return notifChannelPropDef.getValue(dataClazz);
        }

        return (T) ConverterUtils.getNullValue(dataClazz);
    }

    public  T getPropValue(Class dataClazz, String name, T defVal) throws UnifyException {
        NotifChannelPropDef notifChannelPropDef = propDefMap.get(name);
        if (notifChannelPropDef != null) {
            return notifChannelPropDef.getValue(dataClazz);
        }

        return defVal;
    }

    public boolean isProp(String name) {
        return propDefMap.containsKey(name);
    }

    public NotifChannelPropDef getPropDef(String name) {
        NotifChannelPropDef notifChannelPropDef = propDefMap.get(name);
        if (notifChannelPropDef == null) {
            throw new RuntimeException(
                    "Property with name [" + name + "] is unknown for applet definition [" + getName() + "].");
        }

        return notifChannelPropDef;
    }

    public static Builder newBuilder(NotifType type, String senderName, String senderContact, Date nextTransmissionOn,
            int messagesPerMinute, String name, String description, Long id, long version) {
        return new Builder(type, senderName, senderContact, nextTransmissionOn, messagesPerMinute, name, description,
                id, version);
    }

    public static class Builder {

        private Map propDefMap;

        private NotifType type;

        private String senderName;

        private String senderContact;

        private String name;

        private String description;

        private Date nextTransmissionOn;

        private int messagesPerMinute;

        private Long id;

        private long version;

        public Builder(NotifType type, String senderName, String senderContact, Date nextTransmissionOn,
                int messagesPerMinute, String name, String description, Long id, long version) {
            this.type = type;
            this.senderName = senderName;
            this.senderContact = senderContact;
            this.propDefMap = new HashMap();
            this.nextTransmissionOn = nextTransmissionOn;
            this.messagesPerMinute = messagesPerMinute;
            this.name = name;
            this.description = description;
            this.id = id;
            this.version = version;
        }

        public Builder addPropDef(String name, String value) {
            if (propDefMap.containsKey(name)) {
                throw new RuntimeException("Property with name [" + name + "] already exists in this definition.");
            }

            propDefMap.put(name, new NotifChannelPropDef(name, value));
            return this;
        }

        public NotifChannelDef build() {
            return new NotifChannelDef(type, senderName, senderContact, Collections.unmodifiableMap(propDefMap),
                    nextTransmissionOn, messagesPerMinute, name, description, id, version);
        }
    }
}