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
|
/*
* Copyright 2011 Vaadin Ltd.
*
* 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.vaadin.server;
import java.io.Serializable;
import java.util.ArrayList;
import java.util.Iterator;
import java.util.List;
import java.util.ServiceLoader;
/**
* 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.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 VaadinService#getAddonContextListeners()}.
*
* @author Vaadin Ltd
* @since 7.0.0
*/
public class AddonContext implements Serializable {
private final VaadinService vaadinService;
private List<BootstrapListener> bootstrapListeners = new ArrayList<BootstrapListener>();
private List<AddonContextListener> initedListeners = new ArrayList<AddonContextListener>();
/**
* Creates a new context using a given vaadin service. Only the framework
* itself should typically create AddonContext instances.
*
* @param vaadinService
* the vaadin service for the associated servlet or portlet.
*/
public AddonContext(VaadinService vaadinService) {
this.vaadinService = vaadinService;
vaadinService.addSessionInitListener(new SessionInitListener() {
@Override
public void sessionInit(SessionInitEvent event)
throws ServiceException {
for (BootstrapListener l : bootstrapListeners) {
event.getSession().addBootstrapListener(l);
}
}
});
vaadinService.setAddonContext(this);
}
/**
* Gets the vaadin service for this context.
*
* @return the vaadin service
*/
public VaadinService getService() {
return vaadinService;
}
/**
* Initializes this context, causing all found listeners to be notified.
* Listeners are by default found using {@link ServiceLoader}, but the
* {@link VaadinService} 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 = vaadinService
.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.contextDestroyed(event);
}
}
/**
* Shorthand for adding a bootstrap listener that will be added to every new
* service session.
*
* @see VaadinSession#addBootstrapListener(BootstrapListener)
*
* @param listener
* the bootstrap listener that should be added to all new
* applications.
*/
public void addBootstrapListener(BootstrapListener listener) {
bootstrapListeners.add(listener);
}
}
|
