001: /*
002: * (C) Copyright 2004 Nabh Information Systems, Inc.
003: *
004: * All copyright notices regarding Nabh's products MUST remain
005: * intact in the scripts and in the outputted HTML.
006: * This program is free software; you can redistribute it and/or
007: * modify it under the terms of the GNU Lesser General Public License
008: * as published by the Free Software Foundation; either version 2.1
009: * of the License, or (at your option) any later version.
010: *
011: * This program is distributed in the hope that it will be useful,
012: * but WITHOUT ANY WARRANTY; without even the implied warranty of
013: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
014: * GNU Lesser General Public License for more details.
015: *
016: * You should have received a copy of the GNU Lesser General Public License
017: * along with this program; if not, write to the Free Software
018: * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
019: *
020: */
021: package com.nabhinc.portlet.mvcportlet.core;
022:
023: import java.io.IOException;
024:
025: import javax.portlet.ActionRequest;
026: import javax.portlet.ActionResponse;
027: import javax.portlet.PortletContext;
028: import javax.portlet.PortletException;
029:
030: import org.apache.commons.logging.Log;
031: import org.apache.commons.logging.LogFactory;
032: import org.w3c.dom.Element;
033:
034: /**
035: * Base class of RequestProcessor classes. It just defines a cancel method
036: * that returns "cancel".
037: *
038: * @author Padmanabh Dabke
039: * (c) 2004 Nabh Information Systems, Inc. All Rights Reserved.
040: */
041: public class BaseRequestProcessor implements RequestProcessor {
042:
043: /**
044: * Logger for this processor
045: */
046: protected Log brpLog = LogFactory
047: .getLog(BaseRequestProcessor.class);
048:
049: /**
050: * Processor name
051: */
052: protected String brpName = null;
053:
054: /**
055: * ControllerPortlet instance
056: */
057: protected ControllerPortletConfig brpConfig = null;
058:
059: /**
060: * Empty method
061: */
062: public void destroy() {
063: // Do nothing
064: }
065:
066: /**
067: * Caches controller portlet config
068: */
069: public void init(Element arg0, ControllerPortletConfig config)
070: throws PortletException {
071: brpConfig = config;
072: }
073:
074: public String getName() {
075: return brpName;
076: }
077:
078: public void setName(String name) {
079: brpName = name;
080: }
081:
082: /**
083: * Returns "cancel".
084: * @param request Action request
085: * @param response Action response
086: * @return "cancel"
087: * @throws PortletException
088: * @throws IOException
089: */
090: public String cancel(ActionRequest request, ActionResponse response)
091: throws PortletException, IOException {
092: return "cancel";
093: }
094:
095: /**
096: * Logs a debug message.
097: * @param msg Message object to be logged
098: */
099: public void debug(Object msg) {
100: brpLog.debug(msg);
101: }
102:
103: /**
104: * Logs an exception.
105: * @param msg Message to be logged
106: * @param ex Exception to be logged
107: */
108: public void debug(Object msg, Throwable ex) {
109: brpLog.debug(msg, ex);
110: }
111:
112: /**
113: * Logs a warning message.
114: * @param msg Message object to be logged
115: */
116: public void warn(Object msg) {
117: brpLog.warn(msg);
118: }
119:
120: /**
121: * Logs a warning.
122: * @param msg Message to be logged
123: * @param ex Exception to be logged
124: */
125: public void warn(Object msg, Throwable ex) {
126: brpLog.warn(msg, ex);
127: }
128:
129: /**
130: * Logs an info message.
131: * @param msg Message object to be logged
132: */
133: public void info(Object msg) {
134: brpLog.info(msg);
135: }
136:
137: protected String getRealPath(PortletContext pContext, String relPath) {
138: return brpConfig.getRealPath(pContext, relPath);
139: }
140:
141: }
|