fish.payara.nucleus.notification.service.BaseNotifierService Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of payara-micro Show documentation
Micro Distribution of the Payara Project
There is a newer version: 7.2024.1.Alpha1
/*
 *
 * Copyright (c) 2016 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.nucleus.notification.service;


import fish.payara.nucleus.notification.NotificationEventBus;
import fish.payara.nucleus.notification.NotificationService;
import fish.payara.nucleus.notification.configuration.Notifier;
import fish.payara.nucleus.notification.configuration.NotifierConfiguration;
import fish.payara.nucleus.notification.configuration.NotifierType;
import fish.payara.nucleus.notification.domain.NotificationEvent;
import fish.payara.nucleus.notification.domain.NotificationExecutionOptions;
import fish.payara.nucleus.notification.domain.NotifierConfigurationExecutionOptions;
import org.glassfish.api.event.EventListener;
import org.glassfish.api.event.EventTypes;
import org.glassfish.api.event.Events;
import org.jvnet.hk2.annotations.Contract;

import javax.annotation.PostConstruct;
import javax.inject.Inject;

/**
 * Base contract for all notifier services.
 *
 * @author mertcaliskan
 */
@Contract
public abstract class BaseNotifierService implements EventListener {

    @Inject
    protected Events events;

    @Inject
    private NotificationEventBus eventBus;

    @Inject
    private NotificationService notificationService;

    private NotifierType type;
    private Class notifierType;
    private Class notifierConfigType;

    public abstract void bootstrap();
    public abstract void shutdown();

    public void event(Event event) {
        if (event.is(EventTypes.SERVER_READY)) {
            bootstrap();
        }
        if (event.is(EventTypes.SERVER_SHUTDOWN)) {
            shutdown();
        }
    }

    @PostConstruct
    void postConstruct() {
        events.register(this);
    }

    protected void register(NotifierType type, Class notifierType, Class notifierConfigType, BaseNotifierService service) {
        this.type = type;
        this.notifierType = notifierType;
        this.notifierConfigType = notifierConfigType;
        eventBus.register(service);
    }

    public abstract void handleNotification(E event);

    public Class getNotifierType() {
        return notifierType;
    }

    public Class getNotifierConfigType() {
        return notifierConfigType;
    }

    public NotifierType getType() {
        return type;
    }

    public NotifierConfigurationExecutionOptions getNotifierConfigurationExecutionOptions() {
        NotificationExecutionOptions executionOptions = notificationService.getExecutionOptions();
        if (executionOptions != null) {
            return executionOptions.getNotifierConfigurationExecutionOptionsList().get(type);
        }
        return null;
    }

    /**
     * Unregisters a service and cleans up any information stored in it
     * This function does NOT restart the service.
     * @param service 
     */
    protected void reset(BaseNotifierService service) {
        eventBus.unregister(service);
    }
}