KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > jcorporate > expresso > services > validation > ValidationHandler


1 /* ====================================================================
2  * The Jcorporate Apache Style Software License, Version 1.2 05-07-2002
3  *
4  * Copyright (c) 1995-2002 Jcorporate Ltd. All rights reserved.
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions
8  * are met:
9  *
10  * 1. Redistributions of source code must retain the above copyright
11  * notice, this list of conditions and the following disclaimer.
12  *
13  * 2. Redistributions in binary form must reproduce the above copyright
14  * notice, this list of conditions and the following disclaimer in
15  * the documentation and/or other materials provided with the
16  * distribution.
17  *
18  * 3. The end-user documentation included with the redistribution,
19  * if any, must include the following acknowledgment:
20  * "This product includes software developed by Jcorporate Ltd.
21  * (http://www.jcorporate.com/)."
22  * Alternately, this acknowledgment may appear in the software itself,
23  * if and wherever such third-party acknowledgments normally appear.
24  *
25  * 4. "Jcorporate" and product names such as "Expresso" must
26  * not be used to endorse or promote products derived from this
27  * software without prior written permission. For written permission,
28  * please contact info@jcorporate.com.
29  *
30  * 5. Products derived from this software may not be called "Expresso",
31  * or other Jcorporate product names; nor may "Expresso" or other
32  * Jcorporate product names appear in their name, without prior
33  * written permission of Jcorporate Ltd.
34  *
35  * 6. No product derived from this software may compete in the same
36  * market space, i.e. framework, without prior written permission
37  * of Jcorporate Ltd. For written permission, please contact
38  * partners@jcorporate.com.
39  *
40  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
41  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
42  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
43  * DISCLAIMED. IN NO EVENT SHALL JCORPORATE LTD OR ITS CONTRIBUTORS
44  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
45  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
46  * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
47  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
48  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
49  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
50  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
51  * SUCH DAMAGE.
52  * ====================================================================
53  *
54  * This software consists of voluntary contributions made by many
55  * individuals on behalf of the Jcorporate Ltd. Contributions back
56  * to the project(s) are encouraged when you make modifications.
57  * Please send them to support@jcorporate.com. For more information
58  * on Jcorporate Ltd. and its products, please see
59  * <http://www.jcorporate.com/>.
60  *
61  * Portions of this software are based upon other open source
62  * products and are subject to their respective licenses.
63  */
64 package com.jcorporate.expresso.services.validation;
65
66
67 /*
68  * ValidationHandler.java
69  *
70  * Copyright 2001 Jcorporate Ltd.
71  */
72
73 import com.jcorporate.expresso.core.controller.Controller;
74 import com.jcorporate.expresso.core.controller.ControllerException;
75 import com.jcorporate.expresso.core.controller.ControllerRequest;
76 import com.jcorporate.expresso.core.controller.ControllerResponse;
77 import com.jcorporate.expresso.core.controller.NonHandleableException;
78
79 import java.util.Hashtable JavaDoc;
80
81
82 /**
83  * Applications that need to use the validation framework must implement this
84  * interface. This interface could either be implemented as a standalone
85  * class, or a controller could implement this interface directly as well.
86  * Creation date: (9/23/2001 9:32:19 PM) Author: Shash Chatterjee
87  */
88 public interface ValidationHandler {
89     /**
90      * This method is used to allow the application-specific handler to notify
91      * the "validator(s)" of an action they need to take. This method is
92      * called by ValidationJob when a new validation request is submitted.
93      * Creation date: (9/23/2001 2:24:30 PM) Author: Shash Chatterjee
94      *
95      * @param params All the application-specific parameters from the
96      * validation request
97      * @param URL The link that the user will click on to validate the
98      * request
99      * @see com.jcorporate.expresso.services.job.ValidationJob
100      */
101     public void notify(Hashtable JavaDoc params, String JavaDoc URL)
102             throws AuthValidationException;
103
104     /**
105      * This method is used to complete the application-specific action after
106      * the validation is successful. This method is called by
107      * ValidationController after a validation code matches that stored in the
108      * validation entry. Creation date: (9/23/2001 2:24:30 PM) Author: Shash
109      * Chatterjee
110      *
111      * @param params All the application-specific parameters from the
112      * validation request
113      * @param request the ControllerRequest object
114      * @param response The controller response from the runValidationState of
115      * ValidationController
116      * @param ctlr The ValidationController instance
117      * @return ControllerResponse object
118      * @throws ControllerException upon error
119      * @throws NonHandleableException upon fatal error
120      * @see com.jcorporate.expresso.services.controller.ValidationController
121      */
122     public ControllerResponse validated(Hashtable JavaDoc params,
123                                         ControllerRequest request, ControllerResponse response, Controller ctlr)
124             throws ControllerException, NonHandleableException;
125 }
126
Popular Tags