001 /*
002 * Copyright 2008-2016 the original author or authors.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 * http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016 package griffon.javafx;
017
018 import griffon.core.ApplicationClassLoader;
019 import griffon.core.ApplicationConfigurer;
020 import griffon.core.ApplicationEvent;
021 import griffon.core.Configuration;
022 import griffon.core.Context;
023 import griffon.core.ExecutorServiceManager;
024 import griffon.core.GriffonApplication;
025 import griffon.core.ShutdownHandler;
026 import griffon.core.addon.AddonManager;
027 import griffon.core.addon.GriffonAddon;
028 import griffon.core.artifact.ArtifactManager;
029 import griffon.core.controller.ActionManager;
030 import griffon.core.env.ApplicationPhase;
031 import griffon.core.env.Lifecycle;
032 import griffon.core.event.EventRouter;
033 import griffon.core.i18n.MessageSource;
034 import griffon.core.injection.Injector;
035 import griffon.core.mvc.MVCGroupManager;
036 import griffon.core.resources.ResourceHandler;
037 import griffon.core.resources.ResourceInjector;
038 import griffon.core.resources.ResourceResolver;
039 import griffon.core.threading.UIThreadManager;
040 import griffon.core.view.WindowManager;
041 import javafx.application.Application;
042 import javafx.stage.Stage;
043 import org.codehaus.griffon.runtime.core.MVCGroupExceptionHandler;
044 import org.slf4j.Logger;
045 import org.slf4j.LoggerFactory;
046
047 import javax.annotation.Nonnull;
048 import javax.annotation.Nullable;
049 import java.beans.PropertyChangeEvent;
050 import java.beans.PropertyChangeListener;
051 import java.beans.PropertyChangeSupport;
052 import java.util.ArrayList;
053 import java.util.Arrays;
054 import java.util.List;
055 import java.util.Locale;
056 import java.util.Map;
057 import java.util.concurrent.CountDownLatch;
058
059 import static griffon.util.AnnotationUtils.named;
060 import static griffon.util.GriffonApplicationUtils.parseLocale;
061 import static griffon.util.GriffonNameUtils.requireNonBlank;
062 import static java.util.Arrays.asList;
063 import static java.util.Objects.requireNonNull;
064
065 /**
066 * Base implementation of {@code GriffonApplication} that runs in applet mode.
067 *
068 * @author Andres Almiray
069 * @since 2.0.0
070 */
071 public abstract class AbstractJavaFXGriffonApplication extends Application implements GriffonApplication {
072 public static final String[] EMPTY_ARGS = new String[0];
073 private static final String ERROR_SHUTDOWN_HANDLER_NULL = "Argument 'shutdownHandler' must not be null";
074 protected final Object[] lock = new Object[0];
075 protected final PropertyChangeSupport pcs;
076 private final List<ShutdownHandler> shutdownHandlers = new ArrayList<>();
077 private final Object shutdownLock = new Object();
078 private final Logger log;
079 private Locale locale = Locale.getDefault();
080 private ApplicationPhase phase = ApplicationPhase.INITIALIZE;
081 private String[] startupArgs;
082 private Injector<?> injector;
083
084 public AbstractJavaFXGriffonApplication() {
085 this(EMPTY_ARGS);
086 }
087
088 public AbstractJavaFXGriffonApplication(@Nonnull String[] args) {
089 requireNonNull(args, "Argument 'args' must not be null");
090 pcs = new PropertyChangeSupport(this);
091 startupArgs = Arrays.copyOf(args, args.length);
092 log = LoggerFactory.getLogger(getClass());
093 }
094
095 // ------------------------------------------------------
096
097 @Override
098 public void start(Stage stage) throws Exception {
099 stage.setOnHidden(t -> shutdown());
100 }
101
102 @Override
103 public void stop() throws Exception {
104 shutdown();
105 }
106
107 public void addPropertyChangeListener(@Nullable PropertyChangeListener listener) {
108 pcs.addPropertyChangeListener(listener);
109 }
110
111 public void addPropertyChangeListener(@Nullable String propertyName, @Nullable PropertyChangeListener listener) {
112 pcs.addPropertyChangeListener(propertyName, listener);
113 }
114
115 public void removePropertyChangeListener(@Nullable PropertyChangeListener listener) {
116 pcs.removePropertyChangeListener(listener);
117 }
118
119 public void removePropertyChangeListener(@Nullable String propertyName, @Nullable PropertyChangeListener listener) {
120 pcs.removePropertyChangeListener(propertyName, listener);
121 }
122
123 @Nonnull
124 public PropertyChangeListener[] getPropertyChangeListeners() {
125 return pcs.getPropertyChangeListeners();
126 }
127
128 @Nonnull
129 public PropertyChangeListener[] getPropertyChangeListeners(@Nullable String propertyName) {
130 return pcs.getPropertyChangeListeners(propertyName);
131 }
132
133 protected void firePropertyChange(@Nonnull PropertyChangeEvent event) {
134 pcs.firePropertyChange(requireNonNull(event, "Argument 'event' must not be null"));
135 }
136
137 protected void firePropertyChange(@Nonnull String propertyName, @Nullable Object oldValue, @Nullable Object newValue) {
138 pcs.firePropertyChange(requireNonBlank(propertyName, "Argument 'propertyName' must not be blank"), oldValue, newValue);
139 }
140
141 // ------------------------------------------------------
142
143 @Nonnull
144 public Locale getLocale() {
145 return locale;
146 }
147
148 public void setLocale(@Nonnull Locale locale) {
149 Locale oldValue = this.locale;
150 this.locale = locale;
151 Locale.setDefault(locale);
152 firePropertyChange(PROPERTY_LOCALE, oldValue, locale);
153 }
154
155 @Nonnull
156 public String[] getStartupArgs() {
157 return startupArgs;
158 }
159
160 @Nonnull
161 public Logger getLog() {
162 return log;
163 }
164
165 public void setLocaleAsString(@Nullable String locale) {
166 setLocale(parseLocale(locale));
167 }
168
169 public void addShutdownHandler(@Nonnull ShutdownHandler handler) {
170 requireNonNull(handler, ERROR_SHUTDOWN_HANDLER_NULL);
171 if (!shutdownHandlers.contains(handler)) shutdownHandlers.add(handler);
172 }
173
174 public void removeShutdownHandler(@Nonnull ShutdownHandler handler) {
175 requireNonNull(handler, ERROR_SHUTDOWN_HANDLER_NULL);
176 shutdownHandlers.remove(handler);
177 }
178
179 @Nonnull
180 public ApplicationPhase getPhase() {
181 synchronized (lock) {
182 return this.phase;
183 }
184 }
185
186 protected void setPhase(@Nonnull ApplicationPhase phase) {
187 requireNonNull(phase, "Argument 'phase' must not be null");
188 synchronized (lock) {
189 firePropertyChange(PROPERTY_PHASE, this.phase, this.phase = phase);
190 }
191 }
192
193 @Nonnull
194 @Override
195 public ApplicationClassLoader getApplicationClassLoader() {
196 return injector.getInstance(ApplicationClassLoader.class);
197 }
198
199 @Nonnull
200 @Override
201 public Context getContext() {
202 return injector.getInstance(Context.class, named("applicationContext"));
203 }
204
205 @Nonnull
206 @Override
207 public Configuration getConfiguration() {
208 return injector.getInstance(Configuration.class);
209 }
210
211 @Nonnull
212 @Override
213 public UIThreadManager getUIThreadManager() {
214 return injector.getInstance(UIThreadManager.class);
215 }
216
217 @Nonnull
218 @Override
219 public EventRouter getEventRouter() {
220 return injector.getInstance(EventRouter.class, named("applicationEventRouter"));
221 }
222
223 @Nonnull
224 @Override
225 public ArtifactManager getArtifactManager() {
226 return injector.getInstance(ArtifactManager.class);
227 }
228
229 @Nonnull
230 @Override
231 public ActionManager getActionManager() {
232 return injector.getInstance(ActionManager.class);
233 }
234
235 @Nonnull
236 @Override
237 public AddonManager getAddonManager() {
238 return injector.getInstance(AddonManager.class);
239 }
240
241 @Nonnull
242 @Override
243 public MVCGroupManager getMvcGroupManager() {
244 return injector.getInstance(MVCGroupManager.class);
245 }
246
247 @Nonnull
248 @Override
249 public MessageSource getMessageSource() {
250 return injector.getInstance(MessageSource.class, named("applicationMessageSource"));
251 }
252
253 @Nonnull
254 @Override
255 public ResourceResolver getResourceResolver() {
256 return injector.getInstance(ResourceResolver.class, named("applicationResourceResolver"));
257 }
258
259 @Nonnull
260 @Override
261 public ResourceHandler getResourceHandler() {
262 return injector.getInstance(ResourceHandler.class);
263 }
264
265 @Nonnull
266 @Override
267 public ResourceInjector getResourceInjector() {
268 return injector.getInstance(ResourceInjector.class, named("applicationResourceInjector"));
269 }
270
271 @Nonnull
272 @Override
273 public Injector<?> getInjector() {
274 return injector;
275 }
276
277 public void setInjector(@Nonnull Injector<?> injector) {
278 this.injector = requireNonNull(injector, "Argument 'injector' cannot be null");
279 this.injector.injectMembers(this);
280 addShutdownHandler(getWindowManager());
281 MVCGroupExceptionHandler.registerWith(this);
282 }
283
284 @Nonnull
285 @Override
286 @SuppressWarnings("unchecked")
287 public <W> WindowManager<W> getWindowManager() {
288 return injector.getInstance(WindowManager.class);
289 }
290
291 protected ApplicationConfigurer getApplicationConfigurer() {
292 return injector.getInstance(ApplicationConfigurer.class);
293 }
294
295 public void initialize() {
296 if (getPhase() == ApplicationPhase.INITIALIZE) {
297 Parameters parameters = getParameters();
298 if (parameters != null && parameters.getRaw().size() > 0) {
299 int length = parameters.getRaw().size();
300 startupArgs = new String[length];
301 System.arraycopy(parameters.getRaw().toArray(), 0, startupArgs, 0, length);
302 }
303
304 getApplicationConfigurer().init();
305 }
306 }
307
308 public void ready() {
309 if (getPhase() != ApplicationPhase.STARTUP) return;
310
311 showStartingWindow();
312
313 setPhase(ApplicationPhase.READY);
314 event(ApplicationEvent.READY_START, asList(this));
315
316 getApplicationConfigurer().runLifecycleHandler(Lifecycle.READY);
317 event(ApplicationEvent.READY_END, asList(this));
318
319 setPhase(ApplicationPhase.MAIN);
320 }
321
322 protected void showStartingWindow() {
323 Object startingWindow = getWindowManager().getStartingWindow();
324 if (startingWindow != null) {
325 getWindowManager().show(startingWindow);
326 }
327 }
328
329 public boolean canShutdown() {
330 event(ApplicationEvent.SHUTDOWN_REQUESTED, asList(this));
331 synchronized (shutdownLock) {
332 for (ShutdownHandler handler : shutdownHandlers) {
333 if (!handler.canShutdown(this)) {
334 event(ApplicationEvent.SHUTDOWN_ABORTED, asList(this));
335 if (log.isDebugEnabled()) {
336 try {
337 log.debug("Shutdown aborted by " + handler);
338 } catch (UnsupportedOperationException uoe) {
339 log.debug("Shutdown aborted by a handler");
340 }
341 }
342 return false;
343 }
344 }
345 }
346 return true;
347 }
348
349 public boolean shutdown() {
350 // avoids reentrant calls to shutdown()
351 // once permission to quit has been granted
352 if (getPhase() == ApplicationPhase.SHUTDOWN) return false;
353
354 if (!canShutdown()) return false;
355 log.info("Shutdown is in process");
356
357 // signal that shutdown is in process
358 setPhase(ApplicationPhase.SHUTDOWN);
359
360 // stage 1 - alert all app event handlers
361 // wait for all handlers to complete before proceeding
362 // with stage #2 if and only if the current thread is
363 // the ui thread
364 log.debug("Shutdown stage 1: notify all event listeners");
365 if (getEventRouter().isEventPublishingEnabled()) {
366 final CountDownLatch latch = new CountDownLatch(getUIThreadManager().isUIThread() ? 1 : 0);
367 getEventRouter().addEventListener(ApplicationEvent.SHUTDOWN_START.getName(), (Object... args) -> latch.countDown());
368 event(ApplicationEvent.SHUTDOWN_START, asList(this));
369 try {
370 latch.await();
371 } catch (InterruptedException e) {
372 // ignore
373 }
374 }
375
376 // stage 2 - alert all shutdown handlers
377 log.debug("Shutdown stage 2: notify all shutdown handlers");
378 synchronized (shutdownLock) {
379 for (ShutdownHandler handler : shutdownHandlers) {
380 handler.onShutdown(this);
381 }
382 }
383
384 // stage 3 - destroy all mvc groups
385 log.debug("Shutdown stage 3: destroy all MVC groups");
386 List<String> mvcIds = new ArrayList<>();
387 mvcIds.addAll(getMvcGroupManager().getGroups().keySet());
388 for (String id : mvcIds) {
389 getMvcGroupManager().destroyMVCGroup(id);
390 }
391
392 // stage 4 - call shutdown script
393 log.debug("Shutdown stage 4: execute Shutdown script");
394 getApplicationConfigurer().runLifecycleHandler(Lifecycle.SHUTDOWN);
395
396 injector.getInstance(ExecutorServiceManager.class).shutdownAll();
397 injector.close();
398
399 return true;
400 }
401
402 @SuppressWarnings("unchecked")
403 public void startup() {
404 if (getPhase() != ApplicationPhase.INITIALIZE) return;
405
406 setPhase(ApplicationPhase.STARTUP);
407 event(ApplicationEvent.STARTUP_START, asList(this));
408
409 Object startupGroups = getConfiguration().get("application.startupGroups", null);
410 if (startupGroups instanceof List) {
411 log.info("Initializing all startup groups: {}", startupGroups);
412
413 for (String groupName : (List<String>) startupGroups) {
414 getMvcGroupManager().createMVC(groupName.trim());
415 }
416 } else if (startupGroups != null && startupGroups.getClass().isArray()) {
417 Object[] groups = (Object[]) startupGroups;
418 log.info("Initializing all startup groups: {}", Arrays.toString(groups));
419
420 for (Object groupName : groups) {
421 getMvcGroupManager().createMVC(String.valueOf(groupName).trim());
422 }
423 } else if (startupGroups != null && startupGroups instanceof String) {
424 String[] groups = ((String) startupGroups).split(",");
425 log.info("Initializing all startup groups: {}", Arrays.toString(groups));
426
427 for (String groupName : groups) {
428 getMvcGroupManager().createMVC(groupName.trim());
429 }
430 }
431
432 for (Map.Entry<String, GriffonAddon> e : getAddonManager().getAddons().entrySet()) {
433 List<String> groups = e.getValue().getStartupGroups();
434 if (groups.isEmpty()) {
435 continue;
436 }
437 log.info("Initializing all {} startup groups: {}", e.getKey(), groups);
438 Map<String, Map<String, Object>> mvcGroups = e.getValue().getMvcGroups();
439 for (String groupName : groups) {
440 if (mvcGroups.containsKey(groupName)) {
441 getMvcGroupManager().createMVC(groupName.trim());
442 }
443 }
444 }
445
446 getApplicationConfigurer().runLifecycleHandler(Lifecycle.STARTUP);
447
448 event(ApplicationEvent.STARTUP_END, asList(this));
449 }
450
451 protected void event(@Nonnull ApplicationEvent event, @Nullable List<?> args) {
452 getEventRouter().publishEvent(event.getName(), args);
453 }
454 }
|