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.text.MessageFormat;
20 import org.mxchange.addressbook.BaseFrameworkSystem;
21 import org.mxchange.addressbook.UnhandledUserChoiceException;
22 import org.mxchange.addressbook.client.Client;
23 import org.mxchange.addressbook.client.console.ConsoleClient;
24 import org.mxchange.addressbook.client.gui.SwingClient;
25 import org.mxchange.addressbook.manager.application.ApplicationManager;
28 * ============================================
29 * AddressbookApplication management:
30 * ============================================
32 * Inernet("public" service) and Intranet
35 * - Single-user local application
54 * - Categorization of contacts
57 * - Permanent storage in database
60 * - Multi-user web application
61 * - Local user registration / login / resend confirmation link / password
63 * - User groups (aka. teams)
64 * - Administration area (user role)
65 * + Create/edit/delete groups
66 * + Edit/delete/lock/unlock user
67 * + Assign user roles/rights
68 * - Allow other users / groups to view addressbook
70 * + Only some categories
72 * + Allow users/guests (not recommended)
73 * - XML export of addressbook and compressable (ZIP)
74 * - Form to contact other user/group without need of mail program
75 * + User can disabled this
76 * - Directory for ussers/groups (who allowed to be listed)
77 * + Simple click to add user to own addressbook
81 * - Multi-language support
83 * Version 2.2+:("socialized")
84 * - "Social login" (OpenID consumer)
85 * + Connect user account to social account
91 * ============================================
93 * ============================================
99 * + Initial tables: contacts, categories, contact_category
103 * + Additional tables: admins (?), admin_rights, groups,
104 * users, user_contacts, user_user_rights, user_category_rights,
108 * + Additional tables: languages (disable, enable language "pack" ?)
112 * + Additional tables: ???
114 * @author Roland Haeder
118 public class AddressbookApplication extends BaseFrameworkSystem implements Application {
122 public static final String APP_TITLE = "Adressbuch";
125 * Application version
127 public static final String APP_VERSION = "0.0";
130 * Console client is enabled by default
132 private boolean consoleClient = true;
135 * GUI client is disabled by default
137 private boolean guiClient = false;
140 * Getter for printable application name
142 * @return A printable name
144 public static String printableTitle () {
145 return MessageFormat.format("{0} v{1}", APP_TITLE, APP_VERSION);
149 * Bootstraps application
152 public void doBootstrap () {
153 this.getLogger().debug("Initializing application ...");
155 // Init client variable
156 Client client = null;
158 // Is console or Swing choosen?
159 if (this.isConsole()) {
161 this.getLogger().debug("Initializing console client ...");
163 // Init console client instance
164 client = new ConsoleClient(this);
165 } else if (this.isGui()) {
167 this.getLogger().debug("Initializing GUI (Swing) client ...");
169 // Init console instance
170 client = new SwingClient(this);
172 // Not client choosen
173 this.getLogger().error("No client choosen. Cannot launch.");
180 // Set client instance
181 this.setClient(client);
183 // The application is running at this point
184 this.getClient().enableIsRunning();
188 * Main loop of the application
191 public void doMainLoop () {
193 this.getLogger().trace("CALLED!");
195 // @TODO The application should be running now
197 // Output introduction
200 // Set current menu to main
201 this.getClient().setCurrentMenu("main");
203 // --- Main loop starts here ---
204 while (this.getClient().isRunning()) {
205 // The application is still active, show menu selection
206 this.getClient().showCurrentMenu();
209 // Ask for user input and run proper method
210 this.getClient().doUserMenuChoice();
211 } catch (final UnhandledUserChoiceException ex) {
212 this.getLogger().catching(ex);
216 // Sleep a little to reduce system load
218 } catch (final InterruptedException ex) {
222 // --- Main loop ends here ---
225 this.getLogger().debug("Main loop exit - shutting down ...");
229 * Enables console client by setting propper flag
231 private void enableConsoleClient () {
232 this.getLogger().debug("Enabling console client (may become optional client) ...");
233 this.consoleClient = true;
234 this.guiClient = false;
238 * Enables GUI client by setting propper flag
240 private void enableGuiClient () {
241 this.getLogger().debug("Enabling GUI client (may become new default client) ...");
242 this.consoleClient = false;
243 this.guiClient = true;
247 * Checks whether the client shoule be console client should be launched by
248 * checking if -console is set.
250 * @return Whether console client should be taken
252 private boolean isConsole () {
253 return this.consoleClient;
257 * Checks whether the client shoule be GUI client should be launched by
258 * checking if -gui is set.
260 * @return Whether GUI client should be taken
262 private boolean isGui () {
263 return this.guiClient;
267 * Parses all given arguments
269 * @param args Arguments from program launch
271 private void parseArguments (final String[] args) {
273 this.getLogger().debug(MessageFormat.format("Parsing {0} arguments ...", args.length));
275 for (final String arg : args) {
279 enableConsoleClient();
290 * Show introduction which depends on client
292 private void showIntro () {
293 // Let the client show it
294 this.getClient().showWelcome();
298 * Launches the application
300 * @param args Arguments handled to program
302 private void start (final String args[]) {
303 this.getLogger().info("Program is started.");
306 this.parseArguments(args);
308 // Launch application
309 ApplicationManager.getManager(this).start();
311 // Good bye, but this should not be reached ...
312 this.getLogger().warn("Unusual exit reached.");
317 * Main method (entry point)
319 * @param args the command line arguments
321 public static void main (String[] args) {
323 new AddressbookApplication().start(args);
327 * Shuts down the application.
330 public void doShutdown () {
332 this.getClient().doShutdown();
334 this.getLogger().info("End of program (last line)");