01: /*
02: * Copyright 2000,2005 wingS development team.
03: *
04: * This file is part of wingS (http://wingsframework.org).
05: *
06: * wingS is free software; you can redistribute it and/or modify
07: * it under the terms of the GNU Lesser General Public License
08: * as published by the Free Software Foundation; either version 2.1
09: * of the License, or (at your option) any later version.
10: *
11: * Please see COPYING for the complete licence.
12: */
13: package org.wings.event;
14:
15: import java.util.EventListener;
16:
17: /**
18: * Exit listeners can be attached to the current session and will get notified when the session is closed.
19: * They may throw an {@link ExitVetoException} to indicate that they do not want to allow the session
20: * destroying. This veto exception has only effect if the session end was triggered by
21: * {@link org.wings.session.Session#exit(String)}.
22: *
23: * @author <a href="mailto:armin.haaf@mercatis.de">Armin Haaf</a>
24: */
25:
26: public interface SExitListener extends EventListener {
27: /**
28: * The current user session is about to be closed.
29: * @throws ExitVetoException Thrown if client wants to abort an existing
30: * {@link org.wings.session.Session#exit(String)} session exit trigger.
31: */
32: void prepareExit(SExitEvent e) throws ExitVetoException;
33:
34: }
|