Source code: com/lilacsoftware/orca/LogonForm.java
1 /*
2 * $Header: /cvsroot/orca-system/orca-system/src/com/lilacsoftware/orca/LogonForm.java,v 1.1.1.1 2001/11/05 17:41:47 tomwadzinski Exp $
3 * $Revision: 1.1.1.1 $
4 * $Date: 2001/11/05 17:41:47 $
5 *
6 * ====================================================================
7 *
8 * The Apache Software License, Version 1.1
9 *
10 * Copyright (c) 1999-2001 The Apache Software Foundation. All rights
11 * reserved.
12 *
13 * Redistribution and use in source and binary forms, with or without
14 * modification, are permitted provided that the following conditions
15 * are met:
16 *
17 * 1. Redistributions of source code must retain the above copyright
18 * notice, this list of conditions and the following disclaimer.
19 *
20 * 2. Redistributions in binary form must reproduce the above copyright
21 * notice, this list of conditions and the following disclaimer in
22 * the documentation and/or other materials provided with the
23 * distribution.
24 *
25 * 3. The end-user documentation included with the redistribution, if
26 * any, must include the following acknowlegement:
27 * "This product includes software developed by the
28 * Apache Software Foundation (http://www.apache.org/)."
29 * Alternately, this acknowlegement may appear in the software itself,
30 * if and wherever such third-party acknowlegements normally appear.
31 *
32 * 4. The names "The Jakarta Project", "Struts", and "Apache Software
33 * Foundation" must not be used to endorse or promote products derived
34 * from this software without prior written permission. For written
35 * permission, please contact apache@apache.org.
36 *
37 * 5. Products derived from this software may not be called "Apache"
38 * nor may "Apache" appear in their names without prior written
39 * permission of the Apache Group.
40 *
41 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
42 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
43 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
44 * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
45 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
46 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
47 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
48 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
49 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
50 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
51 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
52 * SUCH DAMAGE.
53 * ====================================================================
54 *
55 * This software consists of voluntary contributions made by many
56 * individuals on behalf of the Apache Software Foundation. For more
57 * information on the Apache Software Foundation, please see
58 * <http://www.apache.org/>.
59 *
60 */
61
62
63
64 package com.lilacsoftware.orca;
65
66 import javax.servlet.http.HttpServletRequest;
67 import org.apache.struts.action.ActionError;
68 import org.apache.struts.action.ActionErrors;
69 import org.apache.struts.action.ActionForm;
70 import org.apache.struts.action.ActionMapping;
71
72
73 /**
74 * Form bean for the user profile page. This form has the following fields,
75 * with default values in square brackets:
76 * <ul>
77 * <li><b>password</b> - Entered password value
78 * <li><b>username</b> - Entered username value
79 * </ul>
80 *
81 * @author Craig R. McClanahan
82 * @version $Revision: 1.1.1.1 $ $Date: 2001/11/05 17:41:47 $
83 */
84
85 public final class LogonForm extends ActionForm {
86
87
88 // --------------------------------------------------- Instance Variables
89
90
91 /**
92 * The password.
93 */
94 private String password = null;
95
96
97 /**
98 * The username.
99 */
100 private String username = null;
101
102
103 // ----------------------------------------------------------- Properties
104
105
106 /**
107 * Return the password.
108 */
109 public String getPassword() {
110
111 return (this.password);
112
113 }
114
115
116 /**
117 * Set the password.
118 *
119 * @param password The new password
120 */
121 public void setPassword(String password) {
122
123 this.password = password;
124
125 }
126
127
128 /**
129 * Return the username.
130 */
131 public String getUsername() {
132
133 return (this.username);
134
135 }
136
137
138 /**
139 * Set the username.
140 *
141 * @param username The new username
142 */
143 public void setUsername(String username) {
144
145 this.username = username;
146
147 }
148
149
150 // --------------------------------------------------------- Public Methods
151
152
153 /**
154 * Reset all properties to their default values.
155 *
156 * @param mapping The mapping used to select this instance
157 * @param request The servlet request we are processing
158 */
159 public void reset(ActionMapping mapping, HttpServletRequest request) {
160
161 this.password = null;
162 this.username = null;
163
164 }
165
166
167 /**
168 * Validate the properties that have been set from this HTTP request,
169 * and return an <code>ActionErrors</code> object that encapsulates any
170 * validation errors that have been found. If no errors are found, return
171 * <code>null</code> or an <code>ActionErrors</code> object with no
172 * recorded error messages.
173 *
174 * @param mapping The mapping used to select this instance
175 * @param request The servlet request we are processing
176 */
177 public ActionErrors validate(ActionMapping mapping,
178 HttpServletRequest request) {
179
180 ActionErrors errors = new ActionErrors();
181 if ((username == null) || (username.length() < 1))
182 errors.add("username", new ActionError("error.username.required"));
183 if ((password == null) || (password.length() < 1))
184 errors.add("password", new ActionError("error.password.required"));
185
186 return errors;
187
188 }
189
190
191 }