com.wcs.vaadin.userinactivity.demo.DemoUI.java Source code

Introduction

Here is the source code for com.wcs.vaadin.userinactivity.demo.DemoUI.java

Source

/*
 * Copyright 2014 kumm.
 *
 * Licensed 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 com.wcs.vaadin.userinactivity.demo;

import javax.servlet.annotation.WebServlet;

import com.vaadin.annotations.Title;
import com.vaadin.annotations.VaadinServletConfiguration;
import com.vaadin.server.VaadinRequest;
import com.vaadin.server.VaadinServlet;
import com.vaadin.ui.Button;
import com.vaadin.ui.Label;
import com.vaadin.ui.Notification;
import com.vaadin.ui.TextField;
import com.vaadin.ui.UI;
import com.vaadin.ui.VerticalLayout;
import com.vaadin.ui.Window;
import com.wcs.vaadin.userinactivity.UserInactivityExtension;
import com.wcs.vaadin.userinactivity.SessionTimeoutHandler;
import java.util.Calendar;
import org.vaadin.kim.countdownclock.CountdownClock;
import org.vaadin.kim.countdownclock.CountdownClock.EndEventListener;

@Title("ClientInactivity Add-on Demo")
@SuppressWarnings("serial")
public class DemoUI extends UI {

    private SessionTimeoutHandler sessionTimeoutHandler;
    private static final int SESSION_TIMEOUT = 10;
    private static final int COUNT_DOWN_TIMEOUT = 10;

    @WebServlet(value = "/*", asyncSupported = true)
    @VaadinServletConfiguration(productionMode = false, ui = DemoUI.class, widgetset = "com.wcs.vaadin.userinactivity.demo.DemoWidgetSet")
    public static class Servlet extends VaadinServlet {
    }

    @Override
    protected void init(VaadinRequest request) {
        VerticalLayout layout = new VerticalLayout();
        layout.setMargin(true);
        Label label = new Label("A window will pop up, when no action in " + SESSION_TIMEOUT + " second.");
        label.setStyleName("h1");
        layout.addComponent(label);
        layout.addComponent(new Button("Button"));
        setContent(layout);
        UserInactivityExtension userInactivityExtension = UserInactivityExtension.init(this);
        sessionTimeoutHandler = userInactivityExtension.initSessionTimeoutHandler();
        sessionTimeoutHandler.addTimeoutListener(new SessionTimeoutHandler.SessionTimeoutListener() {

            @Override
            public void timeout() {
                sessionTimeoutHandler.stop();
                openCountDownWindow();
            }
        });
        sessionTimeoutHandler.start(SESSION_TIMEOUT);
        userInactivityExtension.addActionListener(new UserInactivityExtension.ActionListener() {

            @Override
            public void action() {
                if (sessionTimeoutHandler.isRunning()) {
                    Notification.show("OK, " + SESSION_TIMEOUT + " seconds from now");
                }
            }
        });
    }

    private void openCountDownWindow() {
        addWindow(new CountDownWindow());
    }

    private class CountDownWindow extends Window {

        private final VerticalLayout layout;

        public CountDownWindow() {
            setCaption("You were inactive");
            setResizable(false);
            setClosable(false);
            setModal(true);
            center();
            layout = new VerticalLayout();
            setContent(layout);
            buildLayout();
        }

        private void buildLayout() {
            layout.setMargin(true);
            layout.setSpacing(true);
            CountdownClock clock = new CountdownClock();
            Calendar c = Calendar.getInstance();
            c.add(Calendar.SECOND, COUNT_DOWN_TIMEOUT + sessionTimeoutHandler.getRemainingSeconds());
            clock.setDate(c.getTime());
            clock.setFormat("<span style='font: bold 25px Arial; margin: 10px'>"
                    + "You will be logged out in %s seconds.</span>");
            clock.addEndEventListener(new EndEventListener() {
                @Override
                public void countDownEnded(CountdownClock clock) {
                    close();
                    /**
                     * Since other UIs might exist, we have to check again the situation.
                     * You can use push to broadcast a session extend event to get rid of this.
                     */
                    if (sessionTimeoutHandler.getRemainingSeconds() < COUNT_DOWN_TIMEOUT) {
                        Notification.show("Imagine you are logged out!", Notification.Type.ERROR_MESSAGE);
                        sessionTimeoutHandler.stop();
                    } else if (sessionTimeoutHandler.getRemainingSeconds() < 1) {
                        openCountDownWindow();
                    } else {
                        Notification.show("User action initiated on an other browser tab.");
                        sessionTimeoutHandler.reschedule();
                    }
                }
            });
            layout.addComponent(clock);
            layout.addComponent(new Button("Extend session", new Button.ClickListener() {

                @Override
                public void buttonClick(Button.ClickEvent event) {
                    close();
                    sessionTimeoutHandler.start(SESSION_TIMEOUT);
                }
            }));
        }

    }

}