io.uhndata.cards.patients.internal.UnsubmittedFormsCleanupScheduler 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.internal;

import org.apache.sling.api.resource.ResourceResolverFactory;
import org.apache.sling.commons.scheduler.ScheduleOptions;
import org.apache.sling.commons.scheduler.Scheduler;
import org.osgi.service.component.ComponentContext;
import org.osgi.service.component.annotations.Activate;
import org.osgi.service.component.annotations.Component;
import org.osgi.service.component.annotations.Reference;
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.patients.api.PatientAccessConfiguration;
import io.uhndata.cards.resolverProvider.ThreadResourceResolverProvider;

/**
 * Schedule the cleanup of unsubmitted past forms every midnight.
 *
 * @version $Id: 11c895167c5ce5d7c7b38eb60eb3290f5e6526e0 $
 * @since 0.9.2
 */
@Component(immediate = true)
@Designate(ocd = UnsubmittedFormsCleanupScheduler.Config.class)
public class UnsubmittedFormsCleanupScheduler
{
    /** Default log. */
    private static final Logger LOGGER = LoggerFactory.getLogger(UnsubmittedFormsCleanupScheduler.class);

    private static final String SCHEDULER_JOB_NAME = "UnsubmittedFormsCleanup";

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

    /** For sharing the resource resolver with other services. */
    @Reference
    private ThreadResourceResolverProvider rrp;

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

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

    @ObjectClassDefinition(name = "Unsubmitted Forms Cleanup",
        description = "Configuration for if/when to delete unsubmitted patient forms.")
    public @interface Config
    {
        @AttributeDefinition(name = "Schedule",
            description = "A schedule expression determining when the cleanup job runs.")
        String schedule() default "0 0 0 * * ? *";

        @AttributeDefinition(name = "Grace period",
            description = "Extra delay after the survey expire in which unsubmitted forms are not yet deleted."
                + " This is a number of days, 0 means that unsumitted forms are deleted as soon as the visit expires.")
        int gracePeriod() default 0;

        @AttributeDefinition(name = "Excluded Questionnaires",
            description = "Do not delete any Forms from any of these types of Questionnaires."
                + " Enter paths to questionnaires, such as '/Questionnaires/OAIP'.")
        String[] excludedQuestionnaires() default {};
    }

    @Activate
    protected void activate(final Config config, final ComponentContext componentContext) throws Exception
    {
        try {
            // Every night at midnight
            final ScheduleOptions options = this.scheduler.EXPR(config.schedule());
            options.name(SCHEDULER_JOB_NAME);
            options.canRunConcurrently(false);

            final Runnable cleanupJob = new UnsubmittedFormsCleanupTask(config.gracePeriod(),
                config.excludedQuestionnaires(), this.resolverFactory, this.rrp,
                this.patientAccessConfiguration);
            this.scheduler.schedule(cleanupJob, options);
        } catch (final Exception e) {
            LOGGER.error("UnsubmittedFormsCleanup failed to schedule: {}", e.getMessage(), e);
        }
    }
}