io.uhndata.cards.patients.emailnotifications.AppointmentEmailNotificationsFactory Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of cards-patient-portal Show documentation
Support for patients to fill in their forms
The newest version!
/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You 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 io.uhndata.cards.patients.emailnotifications;

import org.apache.commons.lang3.StringUtils;
import org.apache.sling.api.resource.ResourceResolverFactory;
import org.apache.sling.commons.messaging.mail.MailService;
import org.apache.sling.commons.scheduler.ScheduleOptions;
import org.apache.sling.commons.scheduler.Scheduler;
import org.osgi.service.component.annotations.Activate;
import org.osgi.service.component.annotations.Component;
import org.osgi.service.component.annotations.ConfigurationPolicy;
import org.osgi.service.component.annotations.Deactivate;
import org.osgi.service.component.annotations.Reference;
import org.osgi.service.event.EventAdmin;
import org.osgi.service.metatype.annotations.AttributeDefinition;
import org.osgi.service.metatype.annotations.Designate;
import org.osgi.service.metatype.annotations.ObjectClassDefinition;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import io.uhndata.cards.auth.token.TokenManager;
import io.uhndata.cards.forms.api.FormUtils;
import io.uhndata.cards.metrics.Metrics;
import io.uhndata.cards.patients.api.PatientAccessConfiguration;
import io.uhndata.cards.resolverProvider.ThreadResourceResolverProvider;

@Designate(ocd = AppointmentEmailNotificationsFactory.Config.class, factory = true)
@Component(configurationPolicy = ConfigurationPolicy.REQUIRE)
public final class AppointmentEmailNotificationsFactory
{
    /** Default log. */
    private static final Logger LOGGER = LoggerFactory.getLogger(AppointmentEmailNotificationsFactory.class);

    /** Provides access to resources. */
    @Reference
    private ResourceResolverFactory resolverFactory;

    /** Shares the resolver in use with other components. */
    @Reference
    private ThreadResourceResolverProvider resolverProvider;

    @Reference
    private EventAdmin eventAdmin;

    /** The scheduler for rescheduling jobs. */
    @Reference
    private Scheduler scheduler;

    /** The MailService for sending notification emails to patients. */
    @Reference
    private MailService mailService;

    @Reference
    private FormUtils formUtils;

    /** The TokenManager for generating patient-access tokens. */
    @Reference
    private TokenManager tokenManager;

    /** Grab details on patient authentication for token lifetime purposes. */
    @Reference
    private PatientAccessConfiguration patientAccessConfiguration;

    @ObjectClassDefinition(name = "Appointment email notification",
        description = "Send emails for past and future appointments")
    public @interface Config
    {
        @AttributeDefinition(name = "Name", description = "Name")
        String name();

        @AttributeDefinition(name = "Notification Type",
            description = "What type of email notification, e.g. Invitation")
        String notificationType();

        @AttributeDefinition(name = "Metric Name", description = "Metric name description (eg. Reminder emails sent)")
        String metricName();

        @AttributeDefinition(name = "Clinic Mapping Path",
            description = "Clinic mapping path for this clinic (eg. /Survey/ClinicMapping/123456789)")
        String clinicId();

        @AttributeDefinition(name = "Email configuration node",
            description = "JCR Node of type cards:emailTemplate where details about the email will be stored")
        String emailConfiguration();

        @AttributeDefinition(
            name = "Days to the visit",
            description = "Days to the visit - positive if the visit is in the future, "
                + "negative if the visit is in the past")
        int daysToVisit();

        @AttributeDefinition(name = "Schedule",
            description = "Quartz-readable schedule for sending the emails, for example '0 0 6 * * ? *'. "
                + "If empty, the environment variable NIGHTLY_NOTIFICATIONS_SCHEDULE is used. "
                + "If that one isn't set either, a default schedule of 6 AM daily is used.")
        String schedule();
    }

    @Activate
    private void activate(final Config config)
    {
        LOGGER.info("Activating appointment email notifications: {}", config.name());
        final String nightlyNotificationsSchedule = StringUtils.defaultIfEmpty(config.schedule(),
            StringUtils.defaultIfEmpty(System.getenv("NIGHTLY_NOTIFICATIONS_SCHEDULE"), "0 0 6 * * ? *"));

        // Create the performance metrics measurement node
        Metrics.createStatistic(this.resolverFactory, config.name(), config.metricName());

        ScheduleOptions notificationsOptions = this.scheduler.EXPR(nightlyNotificationsSchedule);
        notificationsOptions.name("NightlyNotifications-" + config.name());
        notificationsOptions.canRunConcurrently(true);

        // Instantiate the Runnable
        final Runnable notificationsJob = new GeneralNotificationsTask(this.resolverFactory, this.resolverProvider,
            this.eventAdmin, this.tokenManager, this.mailService, this.formUtils, this.patientAccessConfiguration,
            config.name(), config.notificationType(), config.clinicId(), config.emailConfiguration(),
            config.daysToVisit());

        try {
            this.scheduler.schedule(notificationsJob, notificationsOptions);
            LOGGER.info("Scheduled Appointment Email Notifications Task: {}", config.name());
        } catch (Exception e) {
            LOGGER.error(
                "Failed to schedule Appointment Email Notifications Task: {}. {}",
                config.name(),
                e.getMessage(),
                e);
        }
    }

    @Deactivate
    private void deactivate(final Config config)
    {
        LOGGER.info("Deactivating appointment email notifications: {}", config.name());
        String jobName = "NightlyNotifications-" + config.name();
        if (this.scheduler.unschedule(jobName)) {
            LOGGER.info("Sucessfully unscheduled {}", jobName);
        } else {
            LOGGER.error("Failed to unschedule {}", jobName);
        }
    }
}