001: /*
002: License $Id: I_JoServletRequest.java,v 1.7 2004/04/16 01:30:03 hendriks73 Exp $
003:
004: Copyright (c) 2001-2005 tagtraum industries.
005:
006: LGPL
007: ====
008:
009: jo! is free software; you can redistribute it and/or
010: modify it under the terms of the GNU Lesser General Public
011: License as published by the Free Software Foundation; either
012: version 2.1 of the License, or (at your option) any later version.
013:
014: jo! is distributed in the hope that it will be useful,
015: but WITHOUT ANY WARRANTY; without even the implied warranty of
016: MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
017: Lesser General Public License for more details.
018:
019: You should have received a copy of the GNU Lesser General Public
020: License along with this library; if not, write to the Free Software
021: Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
022:
023: For LGPL see <http://www.fsf.org/copyleft/lesser.txt>
024:
025:
026: Sun license
027: ===========
028:
029: This release contains software by Sun Microsystems. Therefore
030: the following conditions have to be met, too. They apply to the
031: files
032:
033: - lib/mail.jar
034: - lib/activation.jar
035: - lib/jsse.jar
036: - lib/jcert.jar
037: - lib/jaxp.jar
038: - lib/crimson.jar
039: - lib/servlet.jar
040: - lib/jnet.jar
041: - lib/jaas.jar
042: - lib/jaasmod.jar
043:
044: contained in this release.
045:
046: a. Licensee may not modify the Java Platform
047: Interface (JPI, identified as classes contained within the javax
048: package or any subpackages of the javax package), by creating additional
049: classes within the JPI or otherwise causing the addition to or modification
050: of the classes in the JPI. In the event that Licensee creates any
051: Java-related API and distribute such API to others for applet or
052: application development, you must promptly publish broadly, an accurate
053: specification for such API for free use by all developers of Java-based
054: software.
055:
056: b. Software is confidential copyrighted information of Sun and
057: title to all copies is retained by Sun and/or its licensors. Licensee
058: shall not modify, decompile, disassemble, decrypt, extract, or otherwise
059: reverse engineer Software. Software may not be leased, assigned, or
060: sublicensed, in whole or in part. Software is not designed or intended
061: for use in on-line control of aircraft, air traffic, aircraft navigation
062: or aircraft communications; or in the design, construction, operation or
063: maintenance of any nuclear facility. Licensee warrants that it will not
064: use or redistribute the Software for such purposes.
065:
066: c. Software is provided "AS IS," without a warranty
067: of any kind. ALL EXPRESS OR IMPLIED REPRESENTATIONS AND WARRANTIES,
068: INCLUDING ANY IMPLIED WARRANTY OF MERCHANTABILITY, FITNESS FOR A
069: PARTICULAR PURPOSE OR NON-INFRINGEMENT, ARE HEREBY EXCLUDED.
070:
071: d. This License is effective until terminated. Licensee may
072: terminate this License at any time by destroying all copies of Software.
073: This License will terminate immediately without notice from Sun if Licensee
074: fails to comply with any provision of this License. Upon such termination,
075: Licensee must destroy all copies of Software.
076:
077: e. Software, including technical data, is subject to U.S.
078: export control laws, including the U.S. Export Administration Act and its
079: associated regulations, and may be subject to export or import regulations
080: in other countries. Licensee agrees to comply strictly with all such
081: regulations and acknowledges that it has the responsibility to obtain
082: licenses to export, re-export, or import Software. Software may not be
083: downloaded, or otherwise exported or re-exported (i) into, or to a national
084: or resident of, Cuba, Iraq, Iran, North Korea, Libya, Sudan, Syria or any
085: country to which the U.S. has embargoed goods; or (ii) to anyone on the
086: U.S. Treasury Department's list of Specially Designated Nations or the U.S.
087: Commerce Department's Table of Denial Orders.
088:
089:
090: Feedback
091: ========
092:
093: We encourage your feedback and suggestions and want to use your feedback to
094: improve the Software. Send all such feedback to:
095: <feedback@tagtraum.com>
096:
097: For more information on tagtraum industries and jo!
098: please see <http://www.tagtraum.com/>.
099:
100:
101: */
102: package com.tagtraum.jo;
103:
104: import com.tagtraum.framework.http.RequestLine;
105: import com.tagtraum.framework.http.HttpHeader;
106:
107: import javax.servlet.http.HttpServletRequest;
108: import java.io.IOException;
109: import java.net.Socket;
110:
111: /**
112: * Makes the actually immutable request object mutable. This
113: * eases the implementation of nested/dispatched requests a lot.
114: * In order to implement sessions and other things, requests always know
115: * their response objects.
116: *
117: * @author <a href="mailto:hs@tagtraum.com">Hendrik Schreiber</a>
118: * @version 1.1beta1 $Id: I_JoServletRequest.java,v 1.7 2004/04/16 01:30:03 hendriks73 Exp $
119: * @see I_JoServletResponse
120: * @see JoServletHandler
121: */
122: public interface I_JoServletRequest extends HttpServletRequest {
123:
124: /**
125: * Source-Version
126: */
127: public static String vcid = "$Id: I_JoServletRequest.java,v 1.7 2004/04/16 01:30:03 hendriks73 Exp $";
128:
129: /**
130: * Initializes this request.
131: */
132: public void init();
133:
134: /**
135: * Sets the socket of this request.
136: *
137: * @param aSocket this request's socket
138: */
139: public void setSocket(Socket aSocket) throws IOException;
140:
141: /**
142: * Returns the socket of this request.
143: *
144: * @return this request's socket
145: */
146: public Socket getSocket();
147:
148: /**
149: * Sets the response for this request. Request and response always
150: * know each other.
151: *
152: * @param aResponse Response of this request.
153: */
154: public void setResponse(I_JoServletResponse aResponse);
155:
156: /**
157: * Closes the underlying stream.
158: *
159: * @exception IOException
160: */
161: public void close() throws IOException;
162:
163: /**
164: * Sets the {@link I_JoServletContext} for this request.
165: *
166: * @param aContext corresponding contect
167: */
168: public void setServletContext(I_JoServletContext aContext);
169:
170: /**
171: * Sets the peer associated with this object.
172: *
173: * @param aPeer I_JoServletContextPeer
174: */
175: public void setServletContextPeer(I_JoServletContextPeer aPeer);
176:
177: /**
178: * Sets the path of the servlet that is executing this request.
179: * See spec.
180: *
181: * @param aServletPath Path of the servlet
182: */
183: public void setServletPath(String aServletPath);
184:
185: /**
186: * Overwrites the URI of this request.
187: *
188: * @param aURI this request's URI
189: */
190: public void setRequestURI(String aURI);
191:
192: /**
193: * Sets the request method.
194: */
195: public void setMethod(String method);
196:
197: /**
198: * Returns the requestline.
199: *
200: * @return the requestline
201: */
202: public RequestLine getRequestLine();
203:
204: /**
205: * Sets the requestline.
206: *
207: * @param aRequestLine the requestline
208: */
209: public void setRequestLine(RequestLine aRequestLine);
210:
211: /**
212: * Reads the request.
213: */
214: public void readRequest() throws IOException;
215:
216: /**
217: * Returns the context path
218: *
219: * @return context path
220: */
221: public String getContextPath();
222:
223: /**
224: * Sets the name of the remote user.
225: *
226: * @param aName name of the remote user
227: */
228: public void setRemoteUser(String aName);
229:
230: /**
231: * Sets the auth type.
232: *
233: * @param aType
234: */
235: public void setAuthType(String aType);
236:
237: /**
238: * Sets the auth role-names.
239: *
240: * @param anAuthRoles an array of role-names that are authorized
241: * to acces the current resource
242: */
243: public void setAuthRoles(String[] anAuthRoles);
244:
245: /**
246: * Sets a header field.
247: *
248: * @param aKey the Headerkey
249: * @param aValue the Headervalue
250: */
251: public void setHeader(String aKey, String aValue);
252:
253: public HttpHeader getHttpHeader();
254:
255: void setModel(I_JoServletModel model);
256: }
|