001: /* ====================================================================
002: * The Jcorporate Apache Style Software License, Version 1.2 05-07-2002
003: *
004: * Copyright (c) 1995-2002 Jcorporate Ltd. All rights reserved.
005: *
006: * Redistribution and use in source and binary forms, with or without
007: * modification, are permitted provided that the following conditions
008: * are met:
009: *
010: * 1. Redistributions of source code must retain the above copyright
011: * notice, this list of conditions and the following disclaimer.
012: *
013: * 2. Redistributions in binary form must reproduce the above copyright
014: * notice, this list of conditions and the following disclaimer in
015: * the documentation and/or other materials provided with the
016: * distribution.
017: *
018: * 3. The end-user documentation included with the redistribution,
019: * if any, must include the following acknowledgment:
020: * "This product includes software developed by Jcorporate Ltd.
021: * (http://www.jcorporate.com/)."
022: * Alternately, this acknowledgment may appear in the software itself,
023: * if and wherever such third-party acknowledgments normally appear.
024: *
025: * 4. "Jcorporate" and product names such as "Expresso" must
026: * not be used to endorse or promote products derived from this
027: * software without prior written permission. For written permission,
028: * please contact info@jcorporate.com.
029: *
030: * 5. Products derived from this software may not be called "Expresso",
031: * or other Jcorporate product names; nor may "Expresso" or other
032: * Jcorporate product names appear in their name, without prior
033: * written permission of Jcorporate Ltd.
034: *
035: * 6. No product derived from this software may compete in the same
036: * market space, i.e. framework, without prior written permission
037: * of Jcorporate Ltd. For written permission, please contact
038: * partners@jcorporate.com.
039: *
040: * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
041: * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
042: * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
043: * DISCLAIMED. IN NO EVENT SHALL JCORPORATE LTD OR ITS CONTRIBUTORS
044: * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
045: * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
046: * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
047: * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
048: * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
049: * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
050: * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
051: * SUCH DAMAGE.
052: * ====================================================================
053: *
054: * This software consists of voluntary contributions made by many
055: * individuals on behalf of the Jcorporate Ltd. Contributions back
056: * to the project(s) are encouraged when you make modifications.
057: * Please send them to support@jcorporate.com. For more information
058: * on Jcorporate Ltd. and its products, please see
059: * <http://www.jcorporate.com/>.
060: *
061: * Portions of this software are based upon other open source
062: * products and are subject to their respective licenses.
063: */
064: package com.jcorporate.expresso.services.validation;
065:
066: import com.jcorporate.expresso.core.controller.Controller;
067: import com.jcorporate.expresso.core.controller.ControllerException;
068: import com.jcorporate.expresso.core.controller.ControllerRequest;
069: import com.jcorporate.expresso.core.controller.ControllerResponse;
070: import com.jcorporate.expresso.core.controller.NonHandleableException;
071: import com.jcorporate.expresso.core.controller.Transition;
072: import com.jcorporate.expresso.core.db.DBException;
073: import com.jcorporate.expresso.core.i18n.Messages;
074: import com.jcorporate.expresso.core.misc.StringUtil;
075: import com.jcorporate.expresso.core.security.User;
076: import com.jcorporate.expresso.services.dbobj.Setup;
077:
078: import java.util.Hashtable;
079: import java.util.Vector;
080:
081: /**
082: * This class is a helper class that allows the LoginController controller to
083: * validate the email address provided as part of express registration.
084: *
085: * @author Shash Chatterjee
086: * @version $Revision: 1.17 $ $Date: 2004/11/17 20:48:22 $
087: * @see com.jcorporate.expresso.services.controller.LoginController
088: */
089: public class LoginEmailValidator implements ValidationHandler {
090: /**
091: * Default constructor Creation date: (9/23/2001 2:23:06 PM) Author: Shash
092: * Chatterjee
093: */
094: public LoginEmailValidator() {
095: super ();
096: }
097:
098: /**
099: * This method is used to send the user that registered an email so that
100: * when they click on the link it can be verified that the email address
101: * they provided does indeed belong to them and is a working email
102: * address. This method is called by ValidationJob when a new validation
103: * request is submitted. Creation date: (9/23/2001 2:24:30 PM) Author:
104: * Shash Chatterjee
105: *
106: * @param params params All the application-specific parameters from
107: * LoginController
108: * @param URL URL The link that the user will click on to validate the
109: * request
110: * @throws AuthValidationException AuthValidationException
111: * @see com.jcorporate.expresso.services.job.ValidationJob
112: */
113: public void notify(Hashtable params, String URL)
114: throws AuthValidationException {
115: // The db context for the user (Note: this is different from the Validation entry context, which
116: // could very well be in a different DB context)
117: String dbName = (String) params.get("db");
118:
119: // The login name of the user
120: String loginName = (String) params.get("UserName");
121:
122: try {
123: // Check that user with login name actually exists
124: User myUser = new User();
125: myUser.setDataContext(dbName);
126: myUser.setLoginName(loginName);
127:
128: if (!myUser.find()) {
129: throw new AuthValidationException("User with login \""
130: + loginName + "\" not found");
131: }
132:
133: // Create the list of addresses to notify, in this case just the user
134: Vector addresses = new Vector(0);
135: addresses.add(myUser.getEmail());
136:
137: Object[] args = { loginName, URL,
138: Setup.getValue(dbName, "CompanyName"),
139: Setup.getValue(dbName, "HomePageURL") };
140:
141: // Send email notification
142: ValidationEntry.notifyByEmail(dbName, Setup.getValue(
143: dbName, "MAILFrom"), addresses,
144: getString("loginReqSubject"), getString(
145: "loginReqEM1", args));
146: } catch (DBException dbe) {
147: throw new AuthValidationException(
148: "DB error accessing user \"" + loginName + "\"",
149: dbe);
150: }
151: }
152:
153: /**
154: * This method is used to transition back to the "emailValidate" state of
155: * the registration controller which then completes the user's
156: * registration and sends out the email notification of succesful
157: * registration. This method is called by ValidationController after a
158: * validation code matches that stored in the validation entry. Creation
159: * date: (9/23/2001 2:24:30 PM) Author: Shash Chatterjee
160: *
161: * @param params All the application-specific parameters from
162: * LoginController
163: * @param request the ControllerRequest object
164: * @param response The controller response from the runValidationState of
165: * ValidationController
166: * @param ctlr The ValidationController instance
167: * @return ControllerResponse
168: * @throws ControllerException upon error
169: * @throws NonHandleableException upon fatal error
170: * @see com.jcorporate.expresso.services.controller.ValidationController
171: */
172: public ControllerResponse validated(Hashtable params,
173: ControllerRequest request, ControllerResponse response,
174: Controller ctlr) throws ControllerException,
175: NonHandleableException {
176: // The db context for the user (Note: this is different from the Validation entry context, which
177: // could very well be in a different DB context)
178: String dbname = (String) params.get("db");
179:
180: // The login name of the user
181: String loginName = (String) params.get("UserName");
182:
183: String registrationController = (String) params
184: .get("RegistrationController");
185: String loginController = (String) params.get("LoginController");
186:
187: StringUtil
188: .assertNotBlank(registrationController,
189: "Error - Email Validator needed registration controller parameter");
190:
191: StringUtil
192: .assertNotBlank(loginController,
193: "Error - Email Validator needed login controller parameter");
194:
195: Transition t = new Transition();
196: t.setControllerObject(registrationController);
197: t.setState("emailValidate");
198: t.setName("emailValidate");
199: t.addParam("db", dbname);
200: t.addParam("UserName", loginName);
201: t.addParam("LoginController", loginController);
202: t.addParam("RegistrationController", registrationController);
203:
204: //We redirect transition so that the user's URL changes
205: t.redirectTransition(request, response);
206:
207: return response;
208: }
209:
210: /**
211: * Convenience version of the above with no arguments.
212: *
213: * @param stringCode the string to localize
214: * @return The local-language string corresponding to the given code to
215: * return the local language by considering the user as well.
216: */
217: protected String getString(String stringCode) {
218: Object[] args = {};
219:
220: return Messages.getString(
221: "com.jcorporate.expresso.core.ExpressoSchema",
222: stringCode, args);
223: }
224:
225: /* getString(String) */
226:
227: /**
228: * Pass on a call to retrieve an appropriate localized string from the
229: * correct Schema object. This version of the call is overridden with more
230: * sophisticated versions in DBController (which knows the username)
231: *
232: * @param stringCode the string to localize
233: * @param args formatting arguments
234: * @return java.lang.String to return the local language by considering the
235: * user as well.
236: */
237: protected String getString(String stringCode, Object[] args) {
238: return Messages.getString(
239: "com.jcorporate.expresso.core.ExpressoSchema",
240: stringCode, args);
241: }
242: /* getString(String, Object[]) */
243: }
|