fish.payara.internal.notification.PayaraNotificationBuilder Maven / Gradle / Ivy

Go to download
/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright (c) [2020] Payara Foundation and/or its affiliates. All rights reserved.
 *
 * The contents of this file are subject to the terms of either the GNU
 * General Public License Version 2 only ("GPL") or the Common Development
 * and Distribution License("CDDL") (collectively, the "License").  You
 * may not use this file except in compliance with the License.  You can
 * obtain a copy of the License at
 * https://github.com/payara/Payara/blob/master/LICENSE.txt
 * See the License for the specific
 * language governing permissions and limitations under the License.
 *
 * When distributing the software, include this License Header Notice in each
 * file and include the License file at glassfish/legal/LICENSE.txt.
 *
 * GPL Classpath Exception:
 * The Payara Foundation designates this particular file as subject to the "Classpath"
 * exception as provided by the Payara Foundation in the GPL Version 2 section of the License
 * file that accompanied this code.
 *
 * Modifications:
 * If applicable, add the following below the License Header, with the fields
 * enclosed by brackets [] replaced by your own identifying information:
 * "Portions Copyright [year] [name of copyright owner]"
 *
 * Contributor(s):
 * If you wish your version of this file to be governed by only the CDDL or
 * only the GPL Version 2, indicate your decision by adding "[Contributor]
 * elects to include this software in this distribution under the [CDDL or GPL
 * Version 2] license."  If you don't indicate a single choice of license, a
 * recipient has the option to distribute your version of this file under
 * either the CDDL, the GPL Version 2 or to extend the choice of license to
 * its licensees as provided above.  However, if you add GPL Version 2 code
 * and therefore, elected the GPL Version 2 license, then the option applies
 * only if the new code is made subject to such option by the copyright
 * holder.
 */
package fish.payara.internal.notification;

import java.io.Serializable;
import java.util.ArrayList;
import java.util.List;

/**
 * A builder object created by a {@link PayaraNotificationFactory} used to
 * configure Notifications for sending.
 * 
 * @author Matthew Gill
 */
public class PayaraNotificationBuilder {

    private final String hostName;
    private final String domainName;
    private final String instanceName;
    private final String serverName;

    private String subject;
    private String eventType;

    private List notifierWhitelist;
    private List notifierBlacklist;

    private String message;
    private Serializable data;

    protected PayaraNotificationBuilder(String hostName, String domainName, String instanceName, String serverName) {
        this.hostName = hostName;
        this.domainName = domainName;
        this.instanceName = instanceName;
        this.serverName = serverName;
    }

    public PayaraNotificationBuilder subject(String subject) {
        this.subject = subject;
        return this;
    }

    public PayaraNotificationBuilder message(String message) {
        this.message = message;
        if (this.data == null) {
            this.data = message;
        }
        return this;
    }

    public PayaraNotificationBuilder data(Serializable data) {
        this.data = data;
        if (this.message == null) {
            this.message = data.toString();
        }
        return this;
    }

    public PayaraNotificationBuilder eventType(String eventType) {
        this.eventType = eventType;
        return this;
    }

    /**
     * Add a list of notifiers to the receiver list for this notification. Calling
     * this method with an empty list will mean that no notifier receives the
     * message.
     * 
     * @param notifierNames a list of notifiers to receive this notification
     * @return the builder object
     */
    public PayaraNotificationBuilder whitelist(String... notifierNames) {
        for (int i = 0; i < notifierNames.length; i++) {
            if (notifierWhitelist == null) {
                notifierWhitelist = new ArrayList<>();
            }
            notifierWhitelist.add(notifierNames[i]);
        }
        if (notifierNames.length == 0) {
            notifierWhitelist = new ArrayList<>();
        }
        return this;
    }

    /**
     * Add a list of notifiers to the non-receiver list for this notification. Calling
     * this method with an empty list will have no effect.
     * 
     * @param notifierNames a list of notifiers to receive this notification
     * @return the builder object
     */
    public PayaraNotificationBuilder blacklist(String... notifierNames) {
        for (int i = 0; i < notifierNames.length; i++) {
            if (notifierBlacklist == null) {
                notifierBlacklist = new ArrayList<>();
            }
            notifierBlacklist.add(notifierNames[i]);
        }
        return this;
    }

    public PayaraNotification build() {
        return new PayaraNotification(eventType, serverName, hostName, domainName, instanceName, subject, message, data,
                notifierWhitelist, notifierBlacklist);
    }
}