src/java/org/mxchange/addressbook/beans/BaseAddressbookController.java

   1 /*
   2  * Copyright (C) 2016 Roland Haeder
   3  *
   4  * This program is free software: you can redistribute it and/or modify
   5  * it under the terms of the GNU Affero General Public License as
   6  * published by the Free Software Foundation, either version 3 of the
   7  * License, or (at your option) any later version.
   8  *
   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 Affero General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU Affero General Public License
  15  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  16  */
  17 package org.mxchange.addressbook.beans;
  18
  19 import java.io.Serializable;
  20 import javax.faces.context.FacesContext;
  21
  22 /**
  23  * A general controller
  24  * <p>
  25  * @author Roland Haeder<roland@mxchange.org>
  26  */
  27 public abstract class BaseAddressbookController implements Serializable {
  28
  29         /**
  30          * Serial number
  31          */
  32         private static final long serialVersionUID = 50_837_597_127_567_140L;
  33
  34         /**
  35          * Checks whether debug mode is enabled for given controller
  36          * <p>
  37          * @param controllerName Name of controller
  38          * <p>
  39          * @return Whether debug mode is enabled
  40          */
  41         protected boolean isDebugModeEnabled (final String controllerName) {
  42                 // Parameters should be valid
  43                 if (null == controllerName) {
  44                         // Throw NPE
  45                         throw new NullPointerException("controllerName is null"); //NOI18N
  46                 } else if (controllerName.isEmpty()) {
  47                         // Is empty
  48                         throw new IllegalArgumentException("controllerName is empty"); //NOI18N
  49                 }
  50
  51                 // Try to get context parameter
  52                 String contextParameter = FacesContext.getCurrentInstance().getExternalContext().getInitParameter(String.format("is_debug_%s_enabled", controllerName)); //NOI18N
  53
  54                 // Is it set and true?
  55                 boolean isEnabled = ((contextParameter instanceof String) && (contextParameter.equals("true"))); //NOI18N
  56
  57                 // Return it
  58                 return isEnabled;
  59         }
  60
  61 }