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: /*
067: * ValidationHandler.java
068: *
069: * Copyright 2001 Jcorporate Ltd.
070: */
071:
072: import com.jcorporate.expresso.core.controller.Controller;
073: import com.jcorporate.expresso.core.controller.ControllerException;
074: import com.jcorporate.expresso.core.controller.ControllerRequest;
075: import com.jcorporate.expresso.core.controller.ControllerResponse;
076: import com.jcorporate.expresso.core.controller.NonHandleableException;
077:
078: import java.util.Hashtable;
079:
080: /**
081: * Applications that need to use the validation framework must implement this
082: * interface. This interface could either be implemented as a standalone
083: * class, or a controller could implement this interface directly as well.
084: * Creation date: (9/23/2001 9:32:19 PM) Author: Shash Chatterjee
085: */
086: public interface ValidationHandler {
087: /**
088: * This method is used to allow the application-specific handler to notify
089: * the "validator(s)" of an action they need to take. This method is
090: * called by ValidationJob when a new validation request is submitted.
091: * Creation date: (9/23/2001 2:24:30 PM) Author: Shash Chatterjee
092: *
093: * @param params All the application-specific parameters from the
094: * validation request
095: * @param URL The link that the user will click on to validate the
096: * request
097: * @see com.jcorporate.expresso.services.job.ValidationJob
098: */
099: public void notify(Hashtable params, String URL)
100: throws AuthValidationException;
101:
102: /**
103: * This method is used to complete the application-specific action after
104: * the validation is successful. This method is called by
105: * ValidationController after a validation code matches that stored in the
106: * validation entry. Creation date: (9/23/2001 2:24:30 PM) Author: Shash
107: * Chatterjee
108: *
109: * @param params All the application-specific parameters from the
110: * validation request
111: * @param request the ControllerRequest object
112: * @param response The controller response from the runValidationState of
113: * ValidationController
114: * @param ctlr The ValidationController instance
115: * @return ControllerResponse object
116: * @throws ControllerException upon error
117: * @throws NonHandleableException upon fatal error
118: * @see com.jcorporate.expresso.services.controller.ValidationController
119: */
120: public ControllerResponse validated(Hashtable params,
121: ControllerRequest request, ControllerResponse response,
122: Controller ctlr) throws ControllerException,
123: NonHandleableException;
124: }
|