001: /*
002: License $Id: I_JoServletModel.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.util.FactoryException;
105: import com.tagtraum.jo.security.I_JoSecurityRoleRef;
106: import com.tagtraum.jo.util.ServletClassLoader;
107:
108: import javax.servlet.ServletContext;
109: import javax.servlet.ServletException;
110: import javax.servlet.ServletResponse;
111: import javax.servlet.ServletRequest;
112: import javax.swing.event.ChangeListener;
113: import java.io.IOException;
114: import java.net.URL;
115: import java.util.Enumeration;
116:
117: /**
118: * Serves as a managing container for servlets.
119: *
120: * @author <a href="mailto:hs@tagtraum.com">Hendrik Schreiber</a>
121: * @version 1.1beta1 $Id: I_JoServletModel.java,v 1.7 2004/04/16 01:30:03 hendriks73 Exp $
122: */
123: public interface I_JoServletModel {
124:
125: /**
126: * Source-Version
127: */
128: public static String vcid = "$Id: I_JoServletModel.java,v 1.7 2004/04/16 01:30:03 hendriks73 Exp $";
129:
130: /**
131: * Initializes this model.
132: */
133: public void init();
134:
135: public void addChangeListener(ChangeListener cl);
136:
137: public boolean removeChangeListener(ChangeListener cl);
138:
139: /**
140: * Indicates whether the corresponding servlet should have
141: * access to the engine.
142: *
143: * @return true or false
144: */
145: public boolean isPrivileged();
146:
147: public void setPrivileged(boolean privileged);
148:
149: /**
150: * Adds a number of URLs to the classloader.
151: *
152: * @param aURL array of URLs
153: */
154: public void addClassLocations(URL[] aURL);
155:
156: /**
157: * Returns the current classloader.
158: *
159: * @return classloader
160: */
161: public ClassLoader getClassLoader();
162:
163: /**
164: * Sets the classloader for this servlet.
165: *
166: * @param classLoader
167: */
168: public void setClassLoader(ServletClassLoader classLoader);
169:
170: /**
171: * Returns the name of the model.
172: *
173: * @return name of the model
174: */
175: public String getName();
176:
177: /**
178: * Sets the name of this servlet/jsp.
179: *
180: * @param name name
181: */
182: public void setName(String name);
183:
184: /**
185: * Sets the number of servlet instances that can be executed at the same time.
186: * This is only relevant for <code>SingleThreadModels</code>.
187: *
188: * @param max max number of instances
189: */
190: public void setMaxActiveInstances(int max);
191:
192: /**
193: * Returns the number of servlet instances that can be executed at the same time.
194: * This is only relevant for <code>SingleThreadModels</code>.
195: *
196: * @return max number of instances
197: */
198: public int getMaxActiveInstances();
199:
200: /**
201: * Sets the time in ms that shall be waited before a servlet is destroyed although
202: * it is still executed.
203: *
204: * @param aTimeout timeout in ms.
205: */
206: public void setDestroyTimeout(int aTimeout);
207:
208: /**
209: * Returns the time in ms that shall be waited before a servlet is destroyed although
210: * it is still executed.
211: *
212: * @return time in ms.
213: */
214: public int getDestroyTimeout();
215:
216: /**
217: * Loads this servlet.
218: */
219: public void preload() throws FactoryException, ServletException,
220: IOException;
221:
222: /**
223: * Executes the service method of the servlet.
224: *
225: * @exception IOException
226: * @exception ServletException
227: */
228: public void service(ServletRequest aRequest,
229: ServletResponse aResponse) throws IOException,
230: ServletException;
231:
232: /**
233: * Destroys all instances of this servlet.
234: */
235: public void unload();
236:
237: /**
238: * Indicates whether this servlet is loaded or not.
239: *
240: * @return true or false.
241: */
242: public boolean isLoaded();
243:
244: /**
245: * Sets whether this servlet should be loaded as startup.
246: */
247: public void setLoadOnStartup(boolean loadOnStartup);
248:
249: /**
250: * Return whether this servlet should be loaded as startup.
251: */
252: public boolean isLoadOnStartup();
253:
254: /**
255: * Sets the load order position.
256: */
257: public void setLoadOrderPosition(int loadOrderPosition);
258:
259: /**
260: * Returns the load order position.
261: */
262: public int getLoadOrderPosition();
263:
264: /**
265: * Returns the classname of the servlet.
266: *
267: * @return classname
268: */
269: public String getServletClassName();
270:
271: /**
272: * Sets the classname of the servlet.
273: *
274: * @param aClassname classname
275: */
276: public void setServletClassName(String aClassname);
277:
278: /**
279: * Sets filename of the jsp.
280: *
281: * @param jspFileName jsp filename
282: */
283: public void setJspFileName(String jspFileName);
284:
285: /**
286: * Returns the filename of the jsp.
287: *
288: * @return jsp filename
289: */
290: public String getJspFileName();
291:
292: /**
293: * Returns a configuration parameter.
294: *
295: * @return a value
296: */
297: public String getInitParameter(String aKey);
298:
299: /**
300: * Returns the names for all init parameters.
301: *
302: * @return an Enumeration of names
303: */
304: public Enumeration getInitParameterNames();
305:
306: /**
307: * Sets an init parameter. If aValue is null the parameter
308: * is deleted.
309: *
310: * @param aKey a key
311: * @param aValue a value
312: */
313: public void setInitParameter(String aKey, String aValue);
314:
315: /**
316: * Returns the <code>ServletContext</code>.
317: *
318: * @return ServletContext
319: */
320: public ServletContext getServletContext();
321:
322: /**
323: * Returns the <code>ServletContextPeer</code>.
324: *
325: * @return ServletContextPeer
326: */
327: public I_JoServletContextPeer getServletContextPeer();
328:
329: /**
330: * Adds a SecurityRoleReference.
331: */
332: public void addSecurityRoleRef(I_JoSecurityRoleRef aSecurityRoleRef);
333:
334: /**
335: * Returns a SecurityRoleReference.
336: */
337: public I_JoSecurityRoleRef getSecurityRoleRef(String aRoleName);
338:
339: void setServletContextPeer(I_JoServletContextPeer servletContextPeer);
340:
341: /**
342: * Returns a SecurityRoleReference.
343: */
344: I_JoSecurityRoleRef getSecurityRoleRefByLink(String aRoleLink);
345: }
|