2 * Copyright (C) 2015 Roland Haeder
4 * This program is free software: you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License as published by
6 * the Free Software Foundation, either version 3 of the License, or
7 * (at your option) any later version.
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
14 * You should have received a copy of the GNU General Public License
15 * along with this program. If not, see <http://www.gnu.org/licenses/>.
17 package org.mxchange.addressbook.application;
19 import java.io.IOException;
20 import java.sql.SQLException;
21 import java.text.MessageFormat;
22 import org.mxchange.addressbook.client.AddressbookClient;
23 import org.mxchange.addressbook.client.console.ConsoleClient;
24 import org.mxchange.addressbook.client.gui.SwingClient;
25 import org.mxchange.jcore.BaseFrameworkSystem;
26 import org.mxchange.jcore.application.Application;
27 import org.mxchange.jcore.application.BaseApplication;
28 import org.mxchange.jcore.client.Client;
29 import org.mxchange.jcore.exceptions.UnhandledUserChoiceException;
30 import org.mxchange.jcore.manager.application.ApplicationManager;
33 * ============================================
34 * AddressbookApplication management:
35 * ============================================
37 * Inernet("public" service) and Intranet
40 * - Single-user local application
59 * - Categorization of contacts
62 * - Permanent storage in database
65 * - Multi-user web application
66 * - Local user registration / login / resend confirmation link / password
68 * - User groups (aka. teams)
69 * - Administration area (user role)
70 * + Create/edit/delete groups
71 * + Edit/delete/lock/unlock user
72 * + Assign user roles/rights
73 * - Allow other users / groups to view addressbook
75 * + Only some categories
77 * + Allow users/guests (not recommended)
78 * - XML export of addressbook and compressable (ZIP)
79 * - Form to contact other user/group without need of mail program
80 * + User can disabled this
81 * - Directory for ussers/groups (who allowed to be listed)
82 * + Simple click to add user to own addressbook
86 * - Multi-language support
88 * Version 2.2+:("socialized")
89 * - "Social login" (OpenID consumer)
90 * + Connect user account to social account
96 * ============================================
98 * ============================================
104 * + Initial tables: contacts, categories, contact_category
108 * + Additional tables: admins (?), admin_rights, groups,
109 * users, user_contacts, user_user_rights, user_category_rights,
113 * + Additional tables: languages (disable, enable language "pack" ?)
117 * + Additional tables: ???
119 * @author Roland Haeder
122 public class AddressbookApplication extends BaseApplication implements Application {
127 public static final String APP_TITLE = "Adressbuch"; //NOI18N
130 * Application version
132 public static final String APP_VERSION = "0.0"; //NOI18N
135 * Console client is enabled by default
137 private boolean consoleClient = true;
140 * GUI client is disabled by default
142 private boolean guiClient = false;
145 * Protected constructor
146 * @throws java.io.IOException If any IO error occurs
148 protected AddressbookApplication () throws IOException {
149 // Init properties file
150 this.initProperties();
152 // Is the bundle initialized?
153 if (!isBundledInitialized()) {
154 // Temporary initialize default bundle
155 // TODO The enum Gender uses this
161 * Bootstraps application
164 public void doBootstrap () {
165 this.getLogger().debug("Initializing application ..."); //NOI18N
167 // Init client variable
168 Client client = null;
170 // Is console or Swing choosen?
171 if (this.isConsole()) {
173 this.getLogger().debug("Initializing console client ..."); //NOI18N
175 // Init console client instance
176 client = new ConsoleClient(this);
177 } else if (this.isGui()) {
179 this.getLogger().debug("Initializing GUI (Swing) client ..."); //NOI18N
181 // Init console instance
182 client = new SwingClient(this);
184 // Not client choosen
185 this.getLogger().error("No client choosen. Cannot launch."); //NOI18N
189 } catch (final SQLException | IOException ex) {
191 this.abortProgramWithException(ex);
201 // Set client instance
202 this.setClient(client);
204 // The application is running at this point
205 this.getClient().enableIsRunning();
208 this.getLogger().trace("EXIT!"); //NOI18N
212 * Main loop of the application
215 public void doMainLoop () {
216 // Get client and cast it
217 AddressbookClient client = (AddressbookClient) this.getClient();
220 this.getLogger().trace("CALLED!"); //NOI18N
222 // TODO The application should be running now
223 // Output introduction
226 // Set current menu to main
227 client.setCurrentMenu("main"); //NOI18N
229 // --- Main loop starts here ---
230 while (this.getClient().isRunning()) {
231 // The application is still active, show menu selection
232 client.showCurrentMenu();
235 // Ask for user input and run proper method
236 client.doUserMenuChoice();
237 } catch (final UnhandledUserChoiceException ex) {
238 this.getLogger().catching(ex);
242 // Sleep a little to reduce system load
244 } catch (final InterruptedException ex) {
248 // --- Main loop ends here ---
251 this.getLogger().debug("Main loop exit - shutting down ..."); //NOI18N
255 * Shuts down the application.
258 public void doShutdown () throws SQLException, IOException {
260 this.getLogger().trace("CALLED!"); //NOI18N
263 this.getClient().doShutdown();
265 this.getLogger().info("End of program (last line)"); //NOI18N
270 * Enables console client by setting propper flag
272 private void enableConsoleClient () {
273 this.getLogger().debug("Enabling console client (may become optional client) ..."); //NOI18N
274 this.consoleClient = true;
275 this.guiClient = false;
279 * Enables GUI client by setting propper flag
281 private void enableGuiClient () {
282 this.getLogger().debug("Enabling GUI client (may become new default client) ..."); //NOI18N
283 this.consoleClient = false;
284 this.guiClient = true;
288 * Checks whether the client shoule be console client should be launched by
289 * checking if -console is set.
291 * @return Whether console client should be taken
293 private boolean isConsole () {
294 return this.consoleClient;
298 * Checks whether the client shoule be GUI client should be launched by
299 * checking if -gui is set.
301 * @return Whether GUI client should be taken
303 private boolean isGui () {
304 return this.guiClient;
308 * Parses all given arguments
310 * @param args Arguments from program launch
312 private void parseArguments (final String[] args) {
314 this.getLogger().trace(MessageFormat.format("args()={0} - CALLED!", args.length)); //NOI18N
317 this.getLogger().debug(MessageFormat.format("Parsing {0} arguments ...", args.length)); //NOI18N
319 for (final String arg : args) {
322 case "-console": //NOI18N
323 enableConsoleClient();
326 case "-gui": //NOI18N
334 * Show introduction which depends on client
336 private void showIntro () {
338 this.getLogger().trace("CALLED!"); //NOI18N
340 // Let the client show it
341 this.getClient().showWelcome();
344 this.getLogger().trace("EXIT!"); //NOI18N
348 * Launches the application
350 * @param args Arguments handled to program
352 private void start (final String args[]) {
353 this.getLogger().info("Program is started."); //NOI18N
355 // Init properties file
356 this.initProperties();
357 } catch (final IOException ex) {
358 // Something bad happened
359 this.abortProgramWithException(ex);
363 this.parseArguments(args);
365 // Launch application
366 ApplicationManager.getSingeltonManager(this).start();
368 // Good bye, but this should not be reached ...
369 this.getLogger().warn("Unusual exit reached."); //NOI18N
372 } catch (final SQLException | IOException ex) {
373 this.abortProgramWithException(ex);
378 * Main method (entry point)
380 * @param args the command line arguments
382 public static void main (String[] args) {
385 new AddressbookApplication().start(args);
386 } catch (final IOException ex) {
388 BaseFrameworkSystem.getInstance().getLogger().catching(ex);
394 * Getter for printable application name
396 * @return A printable name
398 public static String printableTitle () {
399 return MessageFormat.format("{0} v{1}", APP_TITLE, APP_VERSION); //NOI18N