001: /*
002: * Copyright (c) 2001 - 2005 ivata limited.
003: * All rights reserved.
004: * -----------------------------------------------------------------------------
005: * ivata masks may be redistributed under the GNU General Public
006: * License as published by the Free Software Foundation;
007: * version 2 of the License.
008: *
009: * These programs are free software; you can redistribute them and/or
010: * modify them under the terms of the GNU General Public License
011: * as published by the Free Software Foundation; version 2 of the License.
012: *
013: * These programs are distributed in the hope that they will be useful,
014: * but WITHOUT ANY WARRANTY; without even the implied warranty of
015: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
016: *
017: * See the GNU General Public License in the file LICENSE.txt for more
018: * details.
019: *
020: * If you would like a copy of the GNU General Public License write to
021: *
022: * Free Software Foundation, Inc.
023: * 59 Temple Place - Suite 330
024: * Boston, MA 02111-1307, USA.
025: *
026: *
027: * To arrange commercial support and licensing, contact ivata at
028: * http://www.ivata.com/contact.jsp
029: * -----------------------------------------------------------------------------
030: * $Log: SuccessAction.java,v $
031: * Revision 1.3 2005/10/11 18:54:06 colinmacleod
032: * Fixed some checkstyle and javadoc issues.
033: *
034: * Revision 1.2 2005/10/02 14:06:34 colinmacleod
035: * Added/improved log4j logging.
036: *
037: * Revision 1.1 2005/04/11 12:22:40 colinmacleod
038: * Moved success action from demo subproject
039: * to web subproject.
040: *
041: * Revision 1.3 2005/01/07 09:13:04 colinmacleod
042: * Added newline to end of file.
043: *
044: * Revision 1.2 2005/01/07 08:08:19 colinmacleod
045: * Moved up a version number.
046: * Changed copyright notices to 2005.
047: * Updated the documentation:
048: * - started working on multiproject:site docu.
049: * - changed the logo.
050: * Added checkstyle and fixed LOADS of style issues.
051: * Added separate thirdparty subproject.
052: * Added struts (in web), util and webgui (in webtheme) from ivata op.
053: *
054: * Revision 1.1.1.1 2004/05/16 20:40:07 colinmacleod
055: * Ready for 0.1 release
056: *
057: * Revision 1.1.1.1 2004/05/09 14:42:04 colin
058: * First version in CVS
059: * -----------------------------------------------------------------------------
060: */
061: package com.ivata.mask.web.struts;
062:
063: import org.apache.log4j.Logger;
064:
065: import javax.servlet.http.HttpServletRequest;
066: import javax.servlet.http.HttpServletResponse;
067: import org.apache.struts.action.Action;
068: import org.apache.struts.action.ActionForm;
069: import org.apache.struts.action.ActionForward;
070: import org.apache.struts.action.ActionMapping;
071:
072: /**
073: * <p>
074: * Simple action to always return successfully.
075: * </p>
076: *
077: * @since ivata masks 0.4 (2004-04-30)
078: * @author Colin MacLeod
079: * <a href='mailto:colin.macleod@ivata.com'>colin.macleod@ivata.com</a>
080: * @version $Revision: 1.3 $
081: */
082: public final class SuccessAction extends Action {
083: /**
084: * Logger for this class.
085: */
086: private static final Logger logger = Logger
087: .getLogger(SuccessAction.class);
088:
089: /**
090: * <p>
091: * Generic method called by the <strong>Struts </strong> interface. Always
092: * returns success. .
093: * </p>
094: *
095: * @param mapping The ActionMapping used to select this instance
096: * @param form The ActionForm bean for this request (if any)
097: * @param request The non-HTTP request we are processing
098: * @param response The non-HTTP response we are creating
099: * @return this method returns a <code>"success"</code>
100: * <code>ActionForward</code>
101: * every time.
102: * @throws Exception if the application business logic throws an exception
103: */
104: public ActionForward execute(final ActionMapping mapping,
105: final ActionForm form, final HttpServletRequest request,
106: final HttpServletResponse response) throws Exception {
107: if (logger.isDebugEnabled()) {
108: logger.debug("execute(ActionMapping mapping = " + mapping
109: + ", ActionForm form = " + form
110: + ", HttpServletRequest request = " + request
111: + ", HttpServletResponse response = " + response
112: + ") - start");
113: }
114:
115: ActionForward returnActionForward = mapping
116: .findForward("success");
117: if (logger.isDebugEnabled()) {
118: logger.debug("execute - end - return value = "
119: + returnActionForward);
120: }
121: return returnActionForward;
122: }
123: }
|