001: /*
002: * Copyright (c) 2003 The Visigoth Software Society. All rights
003: * reserved.
004: *
005: * Redistribution and use in source and binary forms, with or without
006: * modification, are permitted provided that the following conditions
007: * are met:
008: *
009: * 1. Redistributions of source code must retain the above copyright
010: * notice, this list of conditions and the following disclaimer.
011: *
012: * 2. Redistributions in binary form must reproduce the above copyright
013: * notice, this list of conditions and the following disclaimer in
014: * the documentation and/or other materials provided with the
015: * distribution.
016: *
017: * 3. The end-user documentation included with the redistribution, if
018: * any, must include the following acknowledgement:
019: * "This product includes software developed by the
020: * Visigoth Software Society (http://www.visigoths.org/)."
021: * Alternately, this acknowledgement may appear in the software itself,
022: * if and wherever such third-party acknowledgements normally appear.
023: *
024: * 4. Neither the name "FreeMarker", "Visigoth", nor any of the names of the
025: * project contributors may be used to endorse or promote products derived
026: * from this software without prior written permission. For written
027: * permission, please contact visigoths@visigoths.org.
028: *
029: * 5. Products derived from this software may not be called "FreeMarker" or "Visigoth"
030: * nor may "FreeMarker" or "Visigoth" appear in their names
031: * without prior written permission of the Visigoth Software Society.
032: *
033: * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
034: * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
035: * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
036: * DISCLAIMED. IN NO EVENT SHALL THE VISIGOTH SOFTWARE SOCIETY OR
037: * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
038: * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
039: * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
040: * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
041: * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
042: * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
043: * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
044: * SUCH DAMAGE.
045: * ====================================================================
046: *
047: * This software consists of voluntary contributions made by many
048: * individuals on behalf of the Visigoth Software Society. For more
049: * information on the Visigoth Software Society, please see
050: * http://www.visigoths.org/
051: */
052:
053: package freemarker.debug.impl;
054:
055: import java.rmi.RemoteException;
056: import java.util.Collections;
057: import java.util.List;
058:
059: import freemarker.core.Environment;
060: import freemarker.template.Template;
061: import freemarker.template.utility.SecurityUtilities;
062:
063: /**
064: * This class provides debugging hooks for the core FreeMarker engine. It is
065: * not usable for anyone outside the FreeMarker core classes. It is public only
066: * as an implementation detail.
067: * @author Attila Szegedi
068: * @version $Id: DebuggerService.java,v 1.2 2003/05/30 16:51:53 szegedia Exp $
069: */
070: public abstract class DebuggerService {
071: private static final DebuggerService instance = createInstance();
072:
073: private static DebuggerService createInstance() {
074: // Creates the appropriate service class. If the debugging is turned
075: // off, this is a fast no-op service, otherwise it is the real-thing
076: // RMI service.
077: return SecurityUtilities
078: .getSystemProperty("freemarker.debug.password") == null ? (DebuggerService) new NoOpDebuggerService()
079: : (DebuggerService) new RmiDebuggerService();
080: }
081:
082: public static List getBreakpoints(String templateName) {
083: return instance.getBreakpointsSpi(templateName);
084: }
085:
086: abstract List getBreakpointsSpi(String templateName);
087:
088: public static void registerTemplate(Template template) {
089: instance.registerTemplateSpi(template);
090: }
091:
092: abstract void registerTemplateSpi(Template template);
093:
094: public static boolean suspendEnvironment(Environment env, int line)
095: throws RemoteException {
096: return instance.suspendEnvironmentSpi(env, line);
097: }
098:
099: abstract boolean suspendEnvironmentSpi(Environment env, int line)
100: throws RemoteException;
101:
102: private static class NoOpDebuggerService extends DebuggerService {
103: List getBreakpointsSpi(String templateName) {
104: return Collections.EMPTY_LIST;
105: }
106:
107: boolean suspendEnvironmentSpi(Environment env, int line) {
108: throw new UnsupportedOperationException();
109: }
110:
111: void registerTemplateSpi(Template template) {
112: }
113: }
114: }
|