blob: c5bafa8a6d05fad259698ed792030fc1ace352e9 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
|
/*
@ITMillApache2LicenseForJavaFiles@
*/
package com.vaadin.service;
import java.io.File;
import java.io.Serializable;
import java.util.Collection;
import com.vaadin.Application;
/**
* <code>ApplicationContext</code> provides information about the running
* context of the application. Each context is shared by all applications that
* are open for one user. In web-environment this corresponds to HttpSession.
*
* @author IT Mill Ltd.
* @version
* @VERSION@
* @since 3.1
*/
public interface ApplicationContext extends Serializable {
/**
* Returns application context base directory.
*
* Typically an application is deployed in a such way that is has
* application directory. For web applications this directory is the root
* directory of the web applications. In some cases application might not
* have application directory (for example web applications running inside
* of war).
*
* @return The application base directory
*/
public File getBaseDirectory();
/**
* Gets the applications in this context.
*
* Gets all applications in this context. Each application context contains
* all applications that are open for one user.
*
* @return Collection containing all applications in this context
*/
public Collection getApplications();
/**
* Adds transaction listener to this context.
*
* @param listener
* the listener to be added.
* @see TransactionListener
*/
public void addTransactionListener(TransactionListener listener);
/**
* Removes transaction listener from this context.
*
* @param listener
* the listener to be removed.
* @see TransactionListener
*/
public void removeTransactionListener(TransactionListener listener);
/**
* Interface for listening the application transaction events.
* Implementations of this interface can be used to listen all transactions
* between the client and the application.
*
*/
public interface TransactionListener extends Serializable {
/**
* Invoked at the beginning of every transaction.
*
* @param application
* the Application object.
* @param transactionData
* the Data identifying the transaction.
*/
public void transactionStart(Application application,
Object transactionData);
/**
* Invoked at the end of every transaction.
*
* @param applcation
* the Application object.
* @param transactionData
* the Data identifying the transaction.
*/
public void transactionEnd(Application application,
Object transactionData);
}
}
|