- * NOTE:This supports the pre-MVC style of template + *
+ * NOTE:This supports the pre-MVC style of template * based portlet development and is supplied for backward compatibility. - * The prefered method is to define template-based portlets is to use + * The prefered method is to define template-based portlets is to use * @see org.apache.jetspeed.portal.portlets.GenericMVCPortlet * or a sub-class there of. The GenericMVCPortlet javadoc provides * instructions for using using the MVC portlet model. @@ -77,17 +77,16 @@ public class VelocityPortlet extends GenericMVCPortlet { - /** - * STW: Backward compatibility: set the viewType to "Velocity". - */ + /** + * STW: Backward compatibility: set the viewType to "Velocity". + */ public void init() throws PortletException { - setCacheable(true); setViewType("Velocity"); - super.init(); + super.init(); } - - - + + + } Index: org/apache/jetspeed/portal/portlets/XSLPortlet.java =================================================================== RCS file: /home/cvs/jakarta-jetspeed/src/java/org/apache/jetspeed/portal/portlets/XSLPortlet.java,v retrieving revision 1.10 diff -u -r1.10 XSLPortlet.java --- org/apache/jetspeed/portal/portlets/XSLPortlet.java 2 May 2003 22:38:13 -0000 1.10 +++ org/apache/jetspeed/portal/portlets/XSLPortlet.java 25 Jul 2003 16:08:45 -0000 @@ -60,22 +60,20 @@ /** * Simple portlet which does a basic XSLT transform with the stylesheet parameter * and the given portlet URL. - * + * * @author Raphaël Luta * @version $Id: XSLPortlet.java,v 1.10 2003/05/02 22:38:13 morciuch Exp $ */ -public class XSLPortlet extends GenericMVCPortlet +public class XSLPortlet extends GenericMVCPortlet { - /** - * + * * @exception PortletException */ public void init() throws PortletException { - setCacheable(true); setViewType("XSL"); - super.init(); + super.init(); } - + } Index: org/apache/jetspeed/portal/portlets/viewprocessor/JSPViewProcessor.java =================================================================== RCS file: /home/cvs/jakarta-jetspeed/src/java/org/apache/jetspeed/portal/portlets/viewprocessor/JSPViewProcessor.java,v retrieving revision 1.4 diff -u -r1.4 JSPViewProcessor.java --- org/apache/jetspeed/portal/portlets/viewprocessor/JSPViewProcessor.java 23 Jul 2003 19:50:18 -0000 1.4 +++ org/apache/jetspeed/portal/portlets/viewprocessor/JSPViewProcessor.java 25 Jul 2003 16:08:45 -0000 @@ -1,7 +1,7 @@ /* ==================================================================== * The Apache Software License, Version 1.1 * - * Copyright (c) 2000-2001 The Apache Software Foundation. All rights + * Copyright (c) 2000-2003 The Apache Software Foundation. All rights * reserved. * * Redistribution and use in source and binary forms, with or without @@ -62,14 +62,14 @@ import org.apache.jetspeed.portal.portlets.GenericMVCContext; import org.apache.jetspeed.services.TemplateLocator; import org.apache.jetspeed.services.Registry; -import org.apache.jetspeed.services.logging.JetspeedLogFactoryService; -import org.apache.jetspeed.services.logging.JetspeedLogger; import org.apache.jetspeed.om.registry.PortletEntry; import org.apache.jetspeed.util.servlet.EcsServletElement; import org.apache.jetspeed.util.ServiceUtil; // Turbine stuff import org.apache.turbine.services.jsp.JspService; +import org.apache.jetspeed.services.logging.JetspeedLogFactoryService; +import org.apache.jetspeed.services.logging.JetspeedLogger; // Turbine util import org.apache.turbine.util.RunData; @@ -83,14 +83,14 @@ * JspViewProcessor - MVC processor for serving jsp files. *
* The .jsp file location may be specified in two different ways: - *
- * + * * @author Tod Kuebler * @author Scott Weaver * @author Mark Orciuch @@ -99,63 +99,58 @@ public class JSPViewProcessor implements ViewProcessor { - + /** * Static initialization of the logger for this class */ - private static final JetspeedLogger logger = JetspeedLogFactoryService.getLogger(JSPViewProcessor.class.getName()); - - /** Creates a new instance of JSPViewProcessor */ - public JSPViewProcessor() - { - } + private static final JetspeedLogger logger = JetspeedLogFactoryService.getLogger(JSPViewProcessor.class.getName()); + Portlet portlet = null; + public Object processView(GenericMVCContext context) { - - Portlet portlet = (Portlet) context.get("portlet"); + + portlet = (Portlet) context.get("portlet"); // already have portlet if init called, maybe remove? RunData data = (RunData) context.get("data"); HttpServletRequest request = data.getRequest(); String template = (String) context.get("template"); - logger.info("JSPViewProcessor - processing template " + template); - + logger.debug("JSPViewProcessor - processing template " + template); + try { - // Allow access to portlet from .jsp template request.setAttribute("portlet", portlet); - + // put context in attribute so you can get to it from .jsp template request.setAttribute("context", context); - + // Add js_peid out of convenience request.setAttribute("js_peid", portlet.getID()); - + // Add rundata out of convenience (JspService.RUNDATA differs from GenericMVCPortlet.RUNDATA) request.setAttribute(JspService.RUNDATA, data); - - // Retrieve the URL. For backward compatibility, use the URL first + + // Retrieve the URL. For backward compatibility, use the URL first // and then fallback to "template" parameter PortletEntry pe = (PortletEntry) Registry.getEntry(Registry.PORTLET, portlet.getName()); - + // Files referenced from default templates folder will be processed // using JspService. Otherwise, they will be loaded using EcsServletElement // from where ever they came from. if (pe.getURL() == null || pe.getURL().trim().length() == 0) { - if (template != null && -1 == template.indexOf(".jsp")) { template = template + ".jsp"; } - - logger.info("JSPViewProcessor - locating template - " + data.toString() - + " - " + template); - + + logger.debug("JSPViewProcessor - locating template - " + data.toString() + + " - " + template); + //we use the template locator to translate the template String locatedTemplate = TemplateLocator.locatePortletTemplate(data, template); - logger.info("JSPViewProcessor - located template: " + locatedTemplate); - + logger.debug("JSPViewProcessor - located template: " + locatedTemplate); + /*if (locatedTemplate == null) { locatedTemplate = TemplateLocator.locateScreenTemplate(data, template); @@ -165,55 +160,55 @@ } logger.debug("JSPViewProcessor - located screen template: " + locatedTemplate); } */ - + JspService service = (JspService) ServiceUtil.getServiceByName(JspService.SERVICE_NAME); - + // this is only necessary if we don't run in a JSP page environment // but better be safe than sorry... service.addDefaultObjects(data); - + // handle request service.handleRequest(data, locatedTemplate); - + } else { // Build parameter list to be passed with the jsp Iterator names = portlet.getPortletConfig().getInitParameterNames(); - while (names.hasNext()) + while (names.hasNext()) { String name = (String) names.next(); String value = (String) portlet.getPortletConfig().getInitParameter(name); data.getParameters().setString(name, value); } - + template = pe.getURL(); - + if (logger.isDebugEnabled()) { logger.debug("JSPViewProcessor - serving jsp directly using: " + template); } - + // get the RequestDispatcher for the JSP RequestDispatcher dispatcher = data.getServletContext().getRequestDispatcher(template); data.getOut().flush(); dispatcher.include(data.getRequest(), data.getResponse()); } - + } catch (Exception e) { - - String message = "JSPViewProcessor: Could not include the following JSP Page: [" + template + "] :\n\t" - + e.getMessage(); + + String message = "JSPViewProcessor: Could not include the following JSP Page: [" + template + "] :\n\t" + + e.getMessage(); logger.error(message, e); - + return new StringElement(message); } - + return new ElementContainer(); } - + /** Process the template passed in the context * (context.get("template")). Invoked by the GenericMVCPortlet * after action handling to process the template type @@ -222,5 +217,6 @@ */ public void init(Portlet portlet) { + this.portlet = portlet; } } Index: org/apache/jetspeed/portal/portlets/viewprocessor/VelocityViewProcessor.java =================================================================== RCS file: /home/cvs/jakarta-jetspeed/src/java/org/apache/jetspeed/portal/portlets/viewprocessor/VelocityViewProcessor.java,v retrieving revision 1.3 diff -u -r1.3 VelocityViewProcessor.java --- org/apache/jetspeed/portal/portlets/viewprocessor/VelocityViewProcessor.java 23 Jul 2003 19:50:18 -0000 1.3 +++ org/apache/jetspeed/portal/portlets/viewprocessor/VelocityViewProcessor.java 25 Jul 2003 16:08:45 -0000 @@ -1,7 +1,7 @@ /* ==================================================================== * The Apache Software License, Version 1.1 * - * Copyright (c) 2000-2001 The Apache Software Foundation. All rights + * Copyright (c) 2000-2003 The Apache Software Foundation. All rights * reserved. * * Redistribution and use in source and binary forms, with or without @@ -65,11 +65,11 @@ import org.apache.jetspeed.portal.portlets.GenericMVCContext; import org.apache.jetspeed.portal.portlets.viewprocessor.*; import org.apache.jetspeed.services.TemplateLocator; -import org.apache.jetspeed.services.logging.JetspeedLogFactoryService; -import org.apache.jetspeed.services.logging.JetspeedLogger; import org.apache.jetspeed.util.JetspeedClearElement; import org.apache.turbine.services.velocity.TurbineVelocity; +import org.apache.jetspeed.services.logging.JetspeedLogFactoryService; +import org.apache.jetspeed.services.logging.JetspeedLogger; import org.apache.turbine.util.RunData; @@ -77,24 +77,23 @@ * * @author tkuebler */ -public class VelocityViewProcessor implements ViewProcessor +public class VelocityViewProcessor +implements ViewProcessor { - + /** * Static initialization of the logger for this class */ - private static final JetspeedLogger logger = JetspeedLogFactoryService.getLogger(VelocityViewProcessor.class.getName()); - - /** Creates a new instance of VelocityViewProcessor */ - public VelocityViewProcessor() - { - } + private static final JetspeedLogger logger = JetspeedLogFactoryService.getLogger(VelocityViewProcessor.class.getName()); + Portlet portlet = null; + public void init(Portlet portlet) - throws PortletException - { - } - + throws PortletException + { + this.portlet = portlet; + } + /** Process the template passed in the context * (context.get("template")). Invoked by the GenericMVCPortlet * after action handling to process the template type @@ -102,73 +101,50 @@ * */ public Object processView(GenericMVCContext context) - { - + { + // generate the content JetspeedClearElement element = null; String template = (String) context.get("template"); - logger.info("VelocityViewProcessor - processing " + template); - + + logger.debug("VelocityViewProcessor - processing " + template); + try - { - + { + if (-1 == template.indexOf(".vm")) - { + { template = template + ".vm"; - } - - logger.info("VelocityViewProcessor - locating template - " + - ((RunData) context.get("data")).toString() + template); - + } + + logger.debug("VelocityViewProcessor - locating template - " + + ((RunData) context.get("data")).toString() + template); + String templatePath = TemplateLocator.locatePortletTemplate( - (RunData) context.get("data"), - template); - - // need to add cache support + (RunData) context.get("data"), + template); + Portlet portlet = (Portlet) context.get("portlet"); RunData rundata = (RunData) context.get("data"); - long cachePeriod = -1; - AbstractPortlet abstractPortlet = null; - // STW: Safety net ;) - if(portlet instanceof AbstractPortlet) - { - abstractPortlet =(AbstractPortlet) portlet; - if(abstractPortlet.getExpirationMillis() != null) - { - cachePeriod = abstractPortlet.getExpirationMillis().longValue(); - } - } - - if (cachePeriod > 0 && abstractPortlet != null) - { - String s = TurbineVelocity.handleRequest(context, templatePath); - abstractPortlet.setExpirationMillis( - cachePeriod + System.currentTimeMillis()); - element = new JetspeedClearElement(s); - - } - else - { - TurbineVelocity.handleRequest( - context, templatePath, rundata.getOut()); - } + element = new JetspeedClearElement(TurbineVelocity.handleRequest(context, templatePath)); - } + } catch (Exception e) - { + { element = new JetspeedClearElement(e.toString()); logger.error("VelocityViewProcessor - had problems handling request - " + e); e.printStackTrace(); - } - + } + TurbineVelocity.requestFinished(context); - + + // catch the null pointer case and return something kosher if (element == null) - { - element = new JetspeedClearElement(""); - } - + { + element = new JetspeedClearElement("portlet content n/a - check log for errors"); + } + return element; - } - } + } +} Index: org/apache/jetspeed/portal/portlets/viewprocessor/XSLViewProcessor.java =================================================================== RCS file: /home/cvs/jakarta-jetspeed/src/java/org/apache/jetspeed/portal/portlets/viewprocessor/XSLViewProcessor.java,v retrieving revision 1.3 diff -u -r1.3 XSLViewProcessor.java --- org/apache/jetspeed/portal/portlets/viewprocessor/XSLViewProcessor.java 23 Jul 2003 19:50:18 -0000 1.3 +++ org/apache/jetspeed/portal/portlets/viewprocessor/XSLViewProcessor.java 25 Jul 2003 16:08:45 -0000 @@ -72,8 +72,6 @@ import org.apache.jetspeed.portal.Portlet; import org.apache.jetspeed.portal.PortletException; import org.apache.jetspeed.portal.portlets.GenericMVCContext; -import org.apache.jetspeed.services.logging.JetspeedLogFactoryService; -import org.apache.jetspeed.services.logging.JetspeedLogger; import org.apache.jetspeed.services.rundata.JetspeedRunData; import org.apache.jetspeed.util.JetspeedClearElement; import org.apache.jetspeed.util.MimeType; @@ -84,6 +82,8 @@ import org.apache.ecs.ConcreteElement; // Turbine api +import org.apache.jetspeed.services.logging.JetspeedLogFactoryService; +import org.apache.jetspeed.services.logging.JetspeedLogger; import org.apache.turbine.util.RunData; // XML stuff @@ -96,7 +96,7 @@ /** * Simple ViewProcessor which does a basic XSLT transform with the stylesheet parameter * and the given URL. - * + * * @author tkuebler@cisco.com * @version $Id: $ * @since 1.4b4 @@ -108,51 +108,48 @@ /** * Static initialization of the logger for this class */ - private static final JetspeedLogger logger = JetspeedLogFactoryService.getLogger(XSLViewProcessor.class.getName()); - + private static final JetspeedLogger logger = JetspeedLogFactoryService.getLogger(XSLViewProcessor.class.getName()); + private static final String XMLDECL = " -1) { base = name.substring(idx + 1, name.length()); } - + stylesheets.put(base, portlet.getPortletConfig().getInitParameter(name)); } else @@ -160,23 +157,21 @@ params.put(name.toLowerCase(), portlet.getPortletConfig().getInitParameter(name)); } } - + // read content, clean it, parse it and cache the DOM try { - final DocumentBuilderFactory docfactory = DocumentBuilderFactory.newInstance(); - + //Have it non-validating docfactory.setValidating(false); parser = docfactory.newDocumentBuilder(); parser.setEntityResolver(new JetspeedXMLEntityResolver()); url = portlet.getPortletConfig().getURL(); - + String content = JetspeedDiskCache.getInstance().getEntry(url).getData(); CapabilityMap xmap = CapabilityMapFactory.getCapabilityMap(CapabilityMapFactory.AGENT_XML); - - // no cache yet // portlet.setContent( new JetspeedClearElement(content), xmap ); + InputSource isrc = new InputSource(this.cleanse(content)); isrc.setSystemId(url); isrc.setEncoding("UTF-8"); @@ -184,51 +179,48 @@ } catch (Throwable t) { - String message = "XSLViewProcessor: Couldn't parse out XML document -> " + url; logger.error(message, t); throw new PortletException(t.getMessage()); } - + } - + /** * This methods outputs the content of the portlet for a given * request. - * + * * @param context * @return the content to be displayed to the user-agent */ public Object processView(GenericMVCContext context) { - + try { init((Portlet) context.get("portlet")); } catch (PortletException pe) { - logger.error("XSLViewProcessor - error: " + pe.getMessage(), pe); + pe.printStackTrace(); + logger.error("XSLViewProcessor - error: " + pe); } - + RunData data = (RunData) context.get("data"); CapabilityMap map = ((JetspeedRunData) data).getCapability(); String type = map.getPreferredType().toString(); ConcreteElement content = new JetspeedClearElement(INVALID_TYPE); String stylesheet = (String) stylesheets.get(type); - + if (stylesheet != null) { - try { content = new JetspeedClearElement(SimpleTransform.transform(this.document, stylesheet, this.params)); - - // no caching yet // setContent( content, map ); } catch (SAXException e) { - logger.error("SAXException", e); + logger.error(e); content = new JetspeedClearElement(e.getMessage()); } } @@ -236,14 +228,13 @@ { content = new JetspeedClearElement("stylesheet not defined"); } - return content; } - + /** * This portlet supports has many types as those * it has stylesheets defined for in its parameters - * + * * @param mimeType the MIME type queried * @return true if the portlet knows how to display * content for mimeType @@ -251,28 +242,25 @@ */ public boolean supportsType(MimeType mimeType) { - Enumeration en = stylesheets.keys(); - + while (en.hasMoreElements()) { - String type = (String) en.nextElement(); - + if (type.equals(mimeType.toString())) { - return true; } } - + return false; } - + /** * Utility method for traversing the document parsed * DOM tree and retrieving a Node by tagname - * + * * @param start the parent node for the search * @param name the tag name to be searched for * @return the first child node of start whose tagname @@ -280,24 +268,21 @@ */ protected Node getNode(Node start, String name) { - NodeList list = start.getChildNodes(); - + for (int i = 0; i < list.getLength(); ++i) { - Node node = list.item(i); - + if (node.getNodeName().equals(name)) { - return node; } } - + return null; } - + /** * Given a URL to some content, clean the content to Xerces can handle it * better. Right now this involves: @@ -306,20 +291,20 @@ * If the document doesn't begin with "<?xml version=" truncate the * content until this is the first line *