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
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
|
/*
@VaadinApache2LicenseForJavaFiles@
*/
package com.vaadin.terminal.gwt.server;
import java.lang.reflect.Method;
import java.util.ArrayList;
import java.util.Iterator;
import java.util.List;
import java.util.ServiceLoader;
import com.vaadin.Application;
import com.vaadin.event.EventRouter;
import com.vaadin.terminal.DeploymentConfiguration;
import com.vaadin.tools.ReflectTools;
/**
* Point of entry for add-ons for integrating into various aspects of the
* framework. One add-on context is initialized for each Vaadin Servlet or
* Portlet instance and upon initialization, every {@link AddonContextListener}
* that can be found is notified to let it add listeners to the context.
* <p>
* By default, AddonContextListeners are loaded using {@link ServiceLoader},
* which means that the file
* META-INF/services/com.vaadin.terminal.gwt.server.AddonContextListener will be
* checked for lines containing fully qualified names of classes to use. This
* behavior can however be overridden for custom deployment situations (e.g. to
* use CDI or OSGi) by overriding
* {@link DeploymentConfiguration#getAddonContextListeners()}.
*
* @author Vaadin Ltd
* @since 7.0.0
*/
public class AddonContext {
private static final Method APPLICATION_STARTED_METHOD = ReflectTools
.findMethod(ApplicationStartedListener.class, "applicationStarted",
ApplicationStartedEvent.class);
private final DeploymentConfiguration deploymentConfiguration;
private final EventRouter eventRouter = new EventRouter();
private List<BootstrapListener> bootstrapListeners = new ArrayList<BootstrapListener>();
private List<AddonContextListener> initedListeners = new ArrayList<AddonContextListener>();
/**
* Creates a new context using a given deployment configuration. Only the
* framework itself should typically create AddonContext methods.
*
* @param deploymentConfiguration
* the deployment configuration for the associated servlet or
* portlet.
*/
public AddonContext(DeploymentConfiguration deploymentConfiguration) {
this.deploymentConfiguration = deploymentConfiguration;
deploymentConfiguration.setAddonContext(this);
}
/**
* Gets the deployment configuration for this context.
*
* @return the deployment configuration
*/
public DeploymentConfiguration getDeploymentConfiguration() {
return deploymentConfiguration;
}
/**
* Initializes this context, causing all found listeners to be notified.
* Listeners are by default found using {@link ServiceLoader}, but the
* {@link DeploymentConfiguration} can provide an alternative
* implementation.
* <p>
* This method is not intended to be used by add-ons, but instead by the
* part of the framework that created this context object.
*/
public void init() {
AddonContextEvent event = new AddonContextEvent(this);
Iterator<AddonContextListener> listeners = deploymentConfiguration
.getAddonContextListeners();
while (listeners.hasNext()) {
AddonContextListener listener = listeners.next();
listener.contextCreated(event);
initedListeners.add(listener);
}
}
/**
* Destroys this context, causing all initialized listeners to be invoked.
* <p>
* This method is not intended to be used by add-ons, but instead by the
* part of the framework that created this context object.
*/
public void destroy() {
AddonContextEvent event = new AddonContextEvent(this);
for (AddonContextListener listener : initedListeners) {
listener.contextDestoryed(event);
}
}
/**
* Shorthand for adding a bootstrap listener that will be added to every new
* application.
*
* @see #addApplicationStartedListener(ApplicationStartedListener)
* @see Application#addBootstrapListener(BootstrapListener)
*
* @param listener
* the bootstrap listener that should be added to all new
* applications.
*/
public void addBootstrapListener(BootstrapListener listener) {
bootstrapListeners.add(listener);
}
/**
* Fires an {@link ApplicationStartedEvent} to all registered listeners.
* This method is not intended to be used by add-ons, but instead by the
* part of the framework that creates new Application instances.
*
* @see #addApplicationStartedListener(ApplicationStartedListener)
*
* @param application
* the newly started application
*/
public void fireApplicationStarted(Application application) {
eventRouter.fireEvent(new ApplicationStartedEvent(this, application));
for (BootstrapListener l : bootstrapListeners) {
application.addBootstrapListener(l);
}
}
/**
* Adds a listener that will be notified any time a new {@link Application}
* instance is started or more precisely directly after
* {@link Application#init()} has been invoked.
*
* @param applicationStartListener
* the application start listener that should be added
*/
public void addApplicationStartedListener(
ApplicationStartedListener applicationStartListener) {
eventRouter.addListener(ApplicationStartedEvent.class,
applicationStartListener, APPLICATION_STARTED_METHOD);
}
/**
* Removes an application start listener.
*
* @see #addApplicationStartedListener(ApplicationStartedListener)
*
* @param applicationStartListener
* the application start listener to remove
*/
public void removeApplicationStartedListener(
ApplicationStartedListener applicationStartListener) {
eventRouter.removeListener(ApplicationStartedEvent.class,
applicationStartListener, APPLICATION_STARTED_METHOD);
}
}
|
