Home » freemarker-2.3.13 » freemarker.debug.impl » [javadoc | source]

    1   /*
    2    * Copyright (c) 2003 The Visigoth Software Society. All rights
    3    * reserved.
    4    *
    5    * Redistribution and use in source and binary forms, with or without
    6    * modification, are permitted provided that the following conditions
    7    * are met:
    8    *
    9    * 1. Redistributions of source code must retain the above copyright
   10    *    notice, this list of conditions and the following disclaimer.
   11    *
   12    * 2. Redistributions in binary form must reproduce the above copyright
   13    *    notice, this list of conditions and the following disclaimer in
   14    *    the documentation and/or other materials provided with the
   15    *    distribution.
   16    *
   17    * 3. The end-user documentation included with the redistribution, if
   18    *    any, must include the following acknowledgement:
   19    *       "This product includes software developed by the
   20    *        Visigoth Software Society (http://www.visigoths.org/)."
   21    *    Alternately, this acknowledgement may appear in the software itself,
   22    *    if and wherever such third-party acknowledgements normally appear.
   23    *
   24    * 4. Neither the name "FreeMarker", "Visigoth", nor any of the names of the 
   25    *    project contributors may be used to endorse or promote products derived
   26    *    from this software without prior written permission. For written
   27    *    permission, please contact visigoths@visigoths.org.
   28    *
   29    * 5. Products derived from this software may not be called "FreeMarker" or "Visigoth"
   30    *    nor may "FreeMarker" or "Visigoth" appear in their names
   31    *    without prior written permission of the Visigoth Software Society.
   32    *
   33    * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
   34    * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
   35    * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
   36    * DISCLAIMED.  IN NO EVENT SHALL THE VISIGOTH SOFTWARE SOCIETY OR
   37    * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
   38    * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
   39    * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
   40    * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
   41    * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
   42    * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
   43    * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
   44    * SUCH DAMAGE.
   45    * ====================================================================
   46    *
   47    * This software consists of voluntary contributions made by many
   48    * individuals on behalf of the Visigoth Software Society. For more
   49    * information on the Visigoth Software Society, please see
   50    * http://www.visigoths.org/
   51    */
   52   
   53   package freemarker.debug.impl;
   54   
   55   import java.rmi.RemoteException;
   56   import java.util.Collections;
   57   import java.util.List;
   58   
   59   import freemarker.core.Environment;
   60   import freemarker.template.Template;
   61   import freemarker.template.utility.SecurityUtilities;
   62   
   63   /**
   64    * This class provides debugging hooks for the core FreeMarker engine. It is
   65    * not usable for anyone outside the FreeMarker core classes. It is public only
   66    * as an implementation detail.
   67    * @author Attila Szegedi
   68    * @version $Id: DebuggerService.java,v 1.2 2003/05/30 16:51:53 szegedia Exp $
   69    */
   70   public abstract class DebuggerService
   71   {
   72       private static final DebuggerService instance = createInstance();
   73       
   74       private static DebuggerService createInstance()
   75       {
   76           // Creates the appropriate service class. If the debugging is turned
   77           // off, this is a fast no-op service, otherwise it is the real-thing
   78           // RMI service.
   79           return 
   80               SecurityUtilities.getSystemProperty("freemarker.debug.password") == null
   81               ? (DebuggerService)new NoOpDebuggerService()
   82               : (DebuggerService)new RmiDebuggerService();
   83       }
   84   
   85       public static List getBreakpoints(String templateName)
   86       {
   87           return instance.getBreakpointsSpi(templateName);
   88       }
   89       
   90       abstract List getBreakpointsSpi(String templateName);
   91   
   92       public static void registerTemplate(Template template)
   93       {
   94           instance.registerTemplateSpi(template);
   95       }
   96       
   97       abstract void registerTemplateSpi(Template template);
   98       
   99       public static boolean suspendEnvironment(Environment env, int line)
  100       throws
  101           RemoteException
  102       {
  103           return instance.suspendEnvironmentSpi(env, line);
  104       }
  105       
  106       abstract boolean suspendEnvironmentSpi(Environment env, int line)
  107       throws
  108           RemoteException;
  109   
  110       private static class NoOpDebuggerService extends DebuggerService
  111       {
  112           List getBreakpointsSpi(String templateName)
  113           {
  114               return Collections.EMPTY_LIST;
  115           }
  116           
  117           boolean suspendEnvironmentSpi(Environment env, int line)
  118           {
  119               throw new UnsupportedOperationException();
  120           }
  121           
  122           void registerTemplateSpi(Template template)
  123           {
  124           }
  125       }
  126   }

Home » freemarker-2.3.13 » freemarker.debug.impl » [javadoc | source]