org.dellroad.stuff.vaadin7.VaadinDelayedAction Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of dellroad-stuff-vaadin7 Show documentation

DellRoad Stuff classes related to the Vaadin GUI framework.

The newest version!


/*
 * Copyright (C) 2022 Archie L. Cobbs. All rights reserved.
 */

package org.dellroad.stuff.vaadin7;

import com.vaadin.server.VaadinSession;

import org.dellroad.stuff.spring.DelayedAction;
import org.springframework.scheduling.TaskScheduler;

/**
 * {@link DelayedAction} for actions that are associated with a Vaadin appliction.
 */
public abstract class VaadinDelayedAction extends DelayedAction {

    private final VaadinSession session;

    /**
     * Convenience constructor. Equivalent to:
     *  
     *  VaadinDelayedAction(taskScheduler, VaadinUtil.getCurrentSession())
     *  
     *
     *  @param taskScheduler scheduler object
     */
    public VaadinDelayedAction(TaskScheduler taskScheduler) {
        this(taskScheduler, VaadinUtil.getCurrentSession());
    }

    /**
     * Primary constructor.
     *
     * @param taskScheduler scheduler object
     * @param session the {@link VaadinSession} with which the action is associated
     * @throws NullPointerException if {@code session} is null
     */
    public VaadinDelayedAction(TaskScheduler taskScheduler, VaadinSession session) {
        super(session.getLockInstance(), taskScheduler);
        this.session = session;
    }

    /**
     * Invokes {@link #runInVaadin} in the context of the configured {@link VaadinSession}.
     */
    @Override
    public final void run() {
        VaadinUtil.invoke(this.session, new Runnable() {
            @Override
            public void run() {
                VaadinDelayedAction.this.runInVaadin();
            }
        });
    }

    /**
     * Perform the action. This method will be invoked in the context of the configured {@link VaadinSession}.
     */
    protected abstract void runInVaadin();
}