001    /*
002     * Copyright © 2008, 2009 Pedro Agulló Soliveres.
003     * 
004     * This file is part of DirectJNgine.
005     *
006     * DirectJNgine is free software: you can redistribute it and/or modify
007     * it under the terms of the GNU Lesser General Public License as published by
008     * the Free Software Foundation, either version 3 of the License.
009     *
010     * Commercial use is permitted to the extent that the code/component(s)
011     * do NOT become part of another Open Source or Commercially developed
012     * licensed development library or toolkit without explicit permission.
013     *
014     * DirectJNgine is distributed in the hope that it will be useful,
015     * but WITHOUT ANY WARRANTY; without even the implied warranty of
016     * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
017     * GNU Lesser General Public License for more details.
018     *
019     * You should have received a copy of the GNU Lesser General Public License
020     * along with DirectJNgine.  If not, see <http://www.gnu.org/licenses/>.
021     * 
022     * This software uses the ExtJs library (http://extjs.com), which is 
023     * distributed under the GPL v3 license (see http://extjs.com/license).
024     */
025    
026    package com.softwarementors.extjs.djn.servlet;
027    
028    import java.util.List;
029    
030    import com.softwarementors.extjs.djn.DirectJNgineException;
031    import com.softwarementors.extjs.djn.StringUtils;
032    import com.softwarementors.extjs.djn.gson.GsonBuilderConfigurator;
033    import com.softwarementors.extjs.djn.router.dispatcher.Dispatcher;
034    import com.softwarementors.extjs.djn.router.processor.standard.json.JsonRequestProcessorThread;
035    
036    public class ServletConfigurationException extends DirectJNgineException {
037      private static final long serialVersionUID = -3328869605189206809L;
038    
039      private ServletConfigurationException( String message ) {
040        super(message);
041        
042        assert !StringUtils.isEmpty(message);
043      }
044    
045      private ServletConfigurationException( String message, Throwable cause ) {
046        super(message, cause);
047        
048        assert !StringUtils.isEmpty(message);
049        assert cause != null;
050      }
051    
052      public static ServletConfigurationException forMissingRequiredConfigurationParameter(List<String> missingParameters) {
053        assert missingParameters != null;    
054        assert !missingParameters.isEmpty();
055        
056        String parameterNames = StringUtils.concatWithSeparator(missingParameters, ", ");
057        return new ServletConfigurationException( "The following servlet configuration parameters are missing: " + parameterNames + ". Please, check your servlet configuration in web.xml." );
058      }
059    
060      public static ServletConfigurationException forClassNotFound(String className, ClassNotFoundException cause) {
061        assert cause != null;
062        
063        return new ServletConfigurationException( "Unable to find class '" + className + "'", cause );
064      }
065    
066      public static ServletConfigurationException forGsonBuilderConfiguratorMustImplementGsonBuilderConfiguratorInterface(
067          String configuratorClassName) {
068        return new ServletConfigurationException( "The specified gson configurator class, '" + configuratorClassName + "', must implement the '" + GsonBuilderConfigurator.class + "' interface");
069      }
070    
071      public static ServletConfigurationException forRegistryConfiguratorMustImplementGsonBuilderConfiguratorInterface(
072          String registryConfiguratorClassName) {
073        return new ServletConfigurationException( "The specified registry configurator class, '" + registryConfiguratorClassName + "', must implement the '" + ServletRegistryConfigurator.class + "' interface");
074      }
075      
076      public static ServletConfigurationException forParameterMustBeAnIntegerGreaterOrEqualToValue(String parameterName,
077          int result, int minValue) {
078        assert !StringUtils.isEmpty(parameterName);
079        
080        return new ServletConfigurationException( "Parameter, '" + parameterName + "' must be greater than or equal to '" + minValue + "'. It was '" + result + "'.");
081      }
082    
083      public static ServletConfigurationException forParameterMustBeAValidInteger(String parameterName, String resultString) {
084        assert !StringUtils.isEmpty(parameterName);
085        assert !StringUtils.isEmpty(resultString);
086        
087        return new ServletConfigurationException( "Parameter, '" + parameterName + "' must be a valid integer. It was '" +resultString + "'.");
088      }
089    
090      public static ServletConfigurationException forMaxThreadPoolSizeMustBeEqualOrGreaterThanMinThreadPoolSize(
091          int batchRequestsMinThreadsPoolSize, int batchRequestsMaxThreadsPoolSize) {
092        return new ServletConfigurationException( "The maximum batch request pool ('" + DirectJNgineServlet.GlobalParameters.BATCH_REQUESTS_MAX_THREADS_POOOL_SIZE +"') size was " + batchRequestsMaxThreadsPoolSize + 
093            ". It must be greater or equal to the minimum request pool size ('" + DirectJNgineServlet.GlobalParameters.BATCH_REQUESTS_MIN_THREADS_POOOL_SIZE +"'), which was " + batchRequestsMinThreadsPoolSize);
094      }
095    
096      public static ServletConfigurationException forDispatcherMustImplementDispatcherInterface(String dispatcherClassName) {
097        return new ServletConfigurationException( "The specified dispatcher class, '" + dispatcherClassName + "', must implement the '" + Dispatcher.class + "' interface");
098      }
099    
100      public static ServletConfigurationException forJsonRequestProcessorThreadMustImplementJsonRequestProcessorThreadInterface(
101          String jsonRequestProcessorThreadClassName) {
102        return new ServletConfigurationException( "The specified json request processor thread class, '" + jsonRequestProcessorThreadClassName + "', must implement the '" + JsonRequestProcessorThread.class + "' interface");
103      }
104    
105    }