KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > catalina > Context


1 /*
2  * Licensed to the Apache Software Foundation (ASF) under one or more
3  * contributor license agreements. See the NOTICE file distributed with
4  * this work for additional information regarding copyright ownership.
5  * The ASF licenses this file to You under the Apache License, Version 2.0
6  * (the "License"); you may not use this file except in compliance with
7  * the License. You may obtain a copy of the License at
8  *
9  * http://www.apache.org/licenses/LICENSE-2.0
10  *
11  * Unless required by applicable law or agreed to in writing, software
12  * distributed under the License is distributed on an "AS IS" BASIS,
13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14  * See the License for the specific language governing permissions and
15  * limitations under the License.
16  */

17
18
19 package org.apache.catalina;
20
21
22 import javax.servlet.ServletContext JavaDoc;
23
24 import org.apache.tomcat.util.http.mapper.Mapper;
25
26 import org.apache.catalina.deploy.ApplicationParameter;
27 import org.apache.catalina.deploy.ErrorPage;
28 import org.apache.catalina.deploy.FilterDef;
29 import org.apache.catalina.deploy.FilterMap;
30 import org.apache.catalina.deploy.LoginConfig;
31 import org.apache.catalina.deploy.NamingResources;
32 import org.apache.catalina.deploy.SecurityConstraint;
33 import org.apache.catalina.util.CharsetMapper;
34
35
36 /**
37  * A <b>Context</b> is a Container that represents a servlet context, and
38  * therefore an individual web application, in the Catalina servlet engine.
39  * It is therefore useful in almost every deployment of Catalina (even if a
40  * Connector attached to a web server (such as Apache) uses the web server's
41  * facilities to identify the appropriate Wrapper to handle this request.
42  * It also provides a convenient mechanism to use Interceptors that see
43  * every request processed by this particular web application.
44  * <p>
45  * The parent Container attached to a Context is generally a Host, but may
46  * be some other implementation, or may be omitted if it is not necessary.
47  * <p>
48  * The child containers attached to a Context are generally implementations
49  * of Wrapper (representing individual servlet definitions).
50  * <p>
51  *
52  * @author Craig R. McClanahan
53  * @version $Revision: 467222 $ $Date: 2006-10-24 05:17:11 +0200 (mar., 24 oct. 2006) $
54  */

55
56 public interface Context extends Container {
57
58
59     // ----------------------------------------------------- Manifest Constants
60

61
62     /**
63      * The LifecycleEvent type sent when a context is reloaded.
64      */

65     public static final String JavaDoc RELOAD_EVENT = "reload";
66
67
68     // ------------------------------------------------------------- Properties
69

70
71     /**
72      * Return the set of initialized application event listener objects,
73      * in the order they were specified in the web application deployment
74      * descriptor, for this application.
75      *
76      * @exception IllegalStateException if this method is called before
77      * this application has started, or after it has been stopped
78      */

79     public Object JavaDoc[] getApplicationEventListeners();
80
81
82     /**
83      * Store the set of initialized application event listener objects,
84      * in the order they were specified in the web application deployment
85      * descriptor, for this application.
86      *
87      * @param listeners The set of instantiated listener objects.
88      */

89     public void setApplicationEventListeners(Object JavaDoc listeners[]);
90
91
92     /**
93      * Return the set of initialized application lifecycle listener objects,
94      * in the order they were specified in the web application deployment
95      * descriptor, for this application.
96      *
97      * @exception IllegalStateException if this method is called before
98      * this application has started, or after it has been stopped
99      */

100     public Object JavaDoc[] getApplicationLifecycleListeners();
101
102
103     /**
104      * Store the set of initialized application lifecycle listener objects,
105      * in the order they were specified in the web application deployment
106      * descriptor, for this application.
107      *
108      * @param listeners The set of instantiated listener objects.
109      */

110     public void setApplicationLifecycleListeners(Object JavaDoc listeners[]);
111
112
113     /**
114      * Return the application available flag for this Context.
115      */

116     public boolean getAvailable();
117
118
119     /**
120      * Set the application available flag for this Context.
121      *
122      * @param available The new application available flag
123      */

124     public void setAvailable(boolean available);
125
126
127     /**
128      * Return the Locale to character set mapper for this Context.
129      */

130     public CharsetMapper getCharsetMapper();
131
132
133     /**
134      * Set the Locale to character set mapper for this Context.
135      *
136      * @param mapper The new mapper
137      */

138     public void setCharsetMapper(CharsetMapper mapper);
139
140
141     /**
142      * Return the path to a file to save this Context information.
143      */

144     public String JavaDoc getConfigFile();
145
146
147     /**
148      * Set the path to a file to save this Context information.
149      *
150      * @param configFile The path to a file to save this Context information.
151      */

152     public void setConfigFile(String JavaDoc configFile);
153
154
155     /**
156      * Return the "correctly configured" flag for this Context.
157      */

158     public boolean getConfigured();
159
160
161     /**
162      * Set the "correctly configured" flag for this Context. This can be
163      * set to false by startup listeners that detect a fatal configuration
164      * error to avoid the application from being made available.
165      *
166      * @param configured The new correctly configured flag
167      */

168     public void setConfigured(boolean configured);
169
170
171     /**
172      * Return the "use cookies for session ids" flag.
173      */

174     public boolean getCookies();
175
176
177     /**
178      * Set the "use cookies for session ids" flag.
179      *
180      * @param cookies The new flag
181      */

182     public void setCookies(boolean cookies);
183
184
185     /**
186      * Return the "allow crossing servlet contexts" flag.
187      */

188     public boolean getCrossContext();
189
190
191     
192     /**
193      * Return the alternate Deployment Descriptor name.
194      */

195     public String JavaDoc getAltDDName();
196     
197     
198     /**
199      * Set an alternate Deployment Descriptor name.
200      */

201     public void setAltDDName(String JavaDoc altDDName) ;
202     
203     
204     /**
205      * Set the "allow crossing servlet contexts" flag.
206      *
207      * @param crossContext The new cross contexts flag
208      */

209     public void setCrossContext(boolean crossContext);
210
211
212     /**
213      * Return the display name of this web application.
214      */

215     public String JavaDoc getDisplayName();
216
217
218     /**
219      * Set the display name of this web application.
220      *
221      * @param displayName The new display name
222      */

223     public void setDisplayName(String JavaDoc displayName);
224
225
226     /**
227      * Return the distributable flag for this web application.
228      */

229     public boolean getDistributable();
230
231
232     /**
233      * Set the distributable flag for this web application.
234      *
235      * @param distributable The new distributable flag
236      */

237     public void setDistributable(boolean distributable);
238
239
240     /**
241      * Return the document root for this Context. This can be an absolute
242      * pathname, a relative pathname, or a URL.
243      */

244     public String JavaDoc getDocBase();
245
246
247     /**
248      * Set the document root for this Context. This can be an absolute
249      * pathname, a relative pathname, or a URL.
250      *
251      * @param docBase The new document root
252      */

253     public void setDocBase(String JavaDoc docBase);
254
255
256     /**
257      * Return the URL encoded context path, using UTF-8.
258      */

259     public String JavaDoc getEncodedPath();
260
261
262     /**
263      * Return the boolean on the annotations parsing.
264      */

265     public boolean getIgnoreAnnotations();
266     
267     
268     /**
269      * Set the boolean on the annotations parsing for this web
270      * application.
271      *
272      * @param ignoreAnnotations The boolean on the annotations parsing
273      */

274     public void setIgnoreAnnotations(boolean ignoreAnnotations);
275     
276     
277     /**
278      * Return the login configuration descriptor for this web application.
279      */

280     public LoginConfig getLoginConfig();
281
282
283     /**
284      * Set the login configuration descriptor for this web application.
285      *
286      * @param config The new login configuration
287      */

288     public void setLoginConfig(LoginConfig config);
289
290
291     /**
292      * Get the request dispatcher mapper.
293      */

294     public Mapper getMapper();
295
296
297     /**
298      * Return the naming resources associated with this web application.
299      */

300     public NamingResources getNamingResources();
301
302
303     /**
304      * Set the naming resources for this web application.
305      *
306      * @param namingResources The new naming resources
307      */

308     public void setNamingResources(NamingResources namingResources);
309
310
311     /**
312      * Return the context path for this web application.
313      */

314     public String JavaDoc getPath();
315
316
317     /**
318      * Set the context path for this web application.
319      *
320      * @param path The new context path
321      */

322     public void setPath(String JavaDoc path);
323
324
325     /**
326      * Return the public identifier of the deployment descriptor DTD that is
327      * currently being parsed.
328      */

329     public String JavaDoc getPublicId();
330
331
332     /**
333      * Set the public identifier of the deployment descriptor DTD that is
334      * currently being parsed.
335      *
336      * @param publicId The public identifier
337      */

338     public void setPublicId(String JavaDoc publicId);
339
340
341     /**
342      * Return the reloadable flag for this web application.
343      */

344     public boolean getReloadable();
345
346
347     /**
348      * Set the reloadable flag for this web application.
349      *
350      * @param reloadable The new reloadable flag
351      */

352     public void setReloadable(boolean reloadable);
353
354
355     /**
356      * Return the override flag for this web application.
357      */

358     public boolean getOverride();
359
360
361     /**
362      * Set the override flag for this web application.
363      *
364      * @param override The new override flag
365      */

366     public void setOverride(boolean override);
367
368
369     /**
370      * Return the privileged flag for this web application.
371      */

372     public boolean getPrivileged();
373
374
375     /**
376      * Set the privileged flag for this web application.
377      *
378      * @param privileged The new privileged flag
379      */

380     public void setPrivileged(boolean privileged);
381
382
383     /**
384      * Return the servlet context for which this Context is a facade.
385      */

386     public ServletContext JavaDoc getServletContext();
387
388
389     /**
390      * Return the default session timeout (in minutes) for this
391      * web application.
392      */

393     public int getSessionTimeout();
394
395
396     /**
397      * Set the default session timeout (in minutes) for this
398      * web application.
399      *
400      * @param timeout The new default session timeout
401      */

402     public void setSessionTimeout(int timeout);
403
404
405     /**
406      * Return the value of the swallowOutput flag.
407      */

408     public boolean getSwallowOutput();
409
410
411     /**
412      * Set the value of the swallowOutput flag. If set to true, the system.out
413      * and system.err will be redirected to the logger during a servlet
414      * execution.
415      *
416      * @param swallowOutput The new value
417      */

418     public void setSwallowOutput(boolean swallowOutput);
419
420
421     /**
422      * Return the Java class name of the Wrapper implementation used
423      * for servlets registered in this Context.
424      */

425     public String JavaDoc getWrapperClass();
426
427
428     /**
429      * Set the Java class name of the Wrapper implementation used
430      * for servlets registered in this Context.
431      *
432      * @param wrapperClass The new wrapper class
433      */

434     public void setWrapperClass(String JavaDoc wrapperClass);
435
436
437     // --------------------------------------------------------- Public Methods
438

439
440     /**
441      * Add a new Listener class name to the set of Listeners
442      * configured for this application.
443      *
444      * @param listener Java class name of a listener class
445      */

446     public void addApplicationListener(String JavaDoc listener);
447
448
449     /**
450      * Add a new application parameter for this application.
451      *
452      * @param parameter The new application parameter
453      */

454     public void addApplicationParameter(ApplicationParameter parameter);
455
456
457     /**
458      * Add a security constraint to the set for this web application.
459      */

460     public void addConstraint(SecurityConstraint constraint);
461
462
463     /**
464      * Add an error page for the specified error or Java exception.
465      *
466      * @param errorPage The error page definition to be added
467      */

468     public void addErrorPage(ErrorPage errorPage);
469
470
471     /**
472      * Add a filter definition to this Context.
473      *
474      * @param filterDef The filter definition to be added
475      */

476     public void addFilterDef(FilterDef filterDef);
477
478
479     /**
480      * Add a filter mapping to this Context.
481      *
482      * @param filterMap The filter mapping to be added
483      */

484     public void addFilterMap(FilterMap filterMap);
485
486
487     /**
488      * Add the classname of an InstanceListener to be added to each
489      * Wrapper appended to this Context.
490      *
491      * @param listener Java class name of an InstanceListener class
492      */

493     public void addInstanceListener(String JavaDoc listener);
494
495
496     /**
497      * Add the given URL pattern as a jsp-property-group. This maps
498      * resources that match the given pattern so they will be passed
499      * to the JSP container. Though there are other elements in the
500      * property group, we only care about the URL pattern here. The
501      * JSP container will parse the rest.
502      *
503      * @param pattern URL pattern to be mapped
504      */

505     public void addJspMapping(String JavaDoc pattern);
506
507
508     /**
509      * Add a Locale Encoding Mapping (see Sec 5.4 of Servlet spec 2.4)
510      *
511      * @param locale locale to map an encoding for
512      * @param encoding encoding to be used for a give locale
513      */

514     public void addLocaleEncodingMappingParameter(String JavaDoc locale, String JavaDoc encoding);
515
516
517     /**
518      * Add a new MIME mapping, replacing any existing mapping for
519      * the specified extension.
520      *
521      * @param extension Filename extension being mapped
522      * @param mimeType Corresponding MIME type
523      */

524     public void addMimeMapping(String JavaDoc extension, String JavaDoc mimeType);
525
526
527     /**
528      * Add a new context initialization parameter, replacing any existing
529      * value for the specified name.
530      *
531      * @param name Name of the new parameter
532      * @param value Value of the new parameter
533      */

534     public void addParameter(String JavaDoc name, String JavaDoc value);
535
536
537     /**
538      * Add a security role reference for this web application.
539      *
540      * @param role Security role used in the application
541      * @param link Actual security role to check for
542      */

543     public void addRoleMapping(String JavaDoc role, String JavaDoc link);
544
545
546     /**
547      * Add a new security role for this web application.
548      *
549      * @param role New security role
550      */

551     public void addSecurityRole(String JavaDoc role);
552
553
554     /**
555      * Add a new servlet mapping, replacing any existing mapping for
556      * the specified pattern.
557      *
558      * @param pattern URL pattern to be mapped
559      * @param name Name of the corresponding servlet to execute
560      */

561     public void addServletMapping(String JavaDoc pattern, String JavaDoc name);
562
563
564     /**
565      * Add a JSP tag library for the specified URI.
566      *
567      * @param uri URI, relative to the web.xml file, of this tag library
568      * @param location Location of the tag library descriptor
569      */

570     public void addTaglib(String JavaDoc uri, String JavaDoc location);
571
572     
573     /**
574      * Add a resource which will be watched for reloading by the host auto
575      * deployer. Note: this will not be used in embedded mode.
576      *
577      * @param name Path to the resource, relative to docBase
578      */

579     public void addWatchedResource(String JavaDoc name);
580     
581
582     /**
583      * Add a new welcome file to the set recognized by this Context.
584      *
585      * @param name New welcome file name
586      */

587     public void addWelcomeFile(String JavaDoc name);
588
589
590     /**
591      * Add the classname of a LifecycleListener to be added to each
592      * Wrapper appended to this Context.
593      *
594      * @param listener Java class name of a LifecycleListener class
595      */

596     public void addWrapperLifecycle(String JavaDoc listener);
597
598
599     /**
600      * Add the classname of a ContainerListener to be added to each
601      * Wrapper appended to this Context.
602      *
603      * @param listener Java class name of a ContainerListener class
604      */

605     public void addWrapperListener(String JavaDoc listener);
606
607
608     /**
609      * Factory method to create and return a new Wrapper instance, of
610      * the Java implementation class appropriate for this Context
611      * implementation. The constructor of the instantiated Wrapper
612      * will have been called, but no properties will have been set.
613      */

614     public Wrapper createWrapper();
615
616
617     /**
618      * Return the set of application listener class names configured
619      * for this application.
620      */

621     public String JavaDoc[] findApplicationListeners();
622
623
624     /**
625      * Return the set of application parameters for this application.
626      */

627     public ApplicationParameter[] findApplicationParameters();
628
629
630     /**
631      * Return the set of security constraints for this web application.
632      * If there are none, a zero-length array is returned.
633      */

634     public SecurityConstraint[] findConstraints();
635
636
637     /**
638      * Return the error page entry for the specified HTTP error code,
639      * if any; otherwise return <code>null</code>.
640      *
641      * @param errorCode Error code to look up
642      */

643     public ErrorPage findErrorPage(int errorCode);
644
645
646     /**
647      * Return the error page entry for the specified Java exception type,
648      * if any; otherwise return <code>null</code>.
649      *
650      * @param exceptionType Exception type to look up
651      */

652     public ErrorPage findErrorPage(String JavaDoc exceptionType);
653
654
655
656     /**
657      * Return the set of defined error pages for all specified error codes
658      * and exception types.
659      */

660     public ErrorPage[] findErrorPages();
661
662
663     /**
664      * Return the filter definition for the specified filter name, if any;
665      * otherwise return <code>null</code>.
666      *
667      * @param filterName Filter name to look up
668      */

669     public FilterDef findFilterDef(String JavaDoc filterName);
670
671
672     /**
673      * Return the set of defined filters for this Context.
674      */

675     public FilterDef[] findFilterDefs();
676
677
678     /**
679      * Return the set of filter mappings for this Context.
680      */

681     public FilterMap[] findFilterMaps();
682
683
684     /**
685      * Return the set of InstanceListener classes that will be added to
686      * newly created Wrappers automatically.
687      */

688     public String JavaDoc[] findInstanceListeners();
689
690
691     /**
692      * Return the MIME type to which the specified extension is mapped,
693      * if any; otherwise return <code>null</code>.
694      *
695      * @param extension Extension to map to a MIME type
696      */

697     public String JavaDoc findMimeMapping(String JavaDoc extension);
698
699
700     /**
701      * Return the extensions for which MIME mappings are defined. If there
702      * are none, a zero-length array is returned.
703      */

704     public String JavaDoc[] findMimeMappings();
705
706
707     /**
708      * Return the value for the specified context initialization
709      * parameter name, if any; otherwise return <code>null</code>.
710      *
711      * @param name Name of the parameter to return
712      */

713     public String JavaDoc findParameter(String JavaDoc name);
714
715
716     /**
717      * Return the names of all defined context initialization parameters
718      * for this Context. If no parameters are defined, a zero-length
719      * array is returned.
720      */

721     public String JavaDoc[] findParameters();
722
723
724     /**
725      * For the given security role (as used by an application), return the
726      * corresponding role name (as defined by the underlying Realm) if there
727      * is one. Otherwise, return the specified role unchanged.
728      *
729      * @param role Security role to map
730      */

731     public String JavaDoc findRoleMapping(String JavaDoc role);
732
733
734     /**
735      * Return <code>true</code> if the specified security role is defined
736      * for this application; otherwise return <code>false</code>.
737      *
738      * @param role Security role to verify
739      */

740     public boolean findSecurityRole(String JavaDoc role);
741
742
743     /**
744      * Return the security roles defined for this application. If none
745      * have been defined, a zero-length array is returned.
746      */

747     public String JavaDoc[] findSecurityRoles();
748
749
750     /**
751      * Return the servlet name mapped by the specified pattern (if any);
752      * otherwise return <code>null</code>.
753      *
754      * @param pattern Pattern for which a mapping is requested
755      */

756     public String JavaDoc findServletMapping(String JavaDoc pattern);
757
758
759     /**
760      * Return the patterns of all defined servlet mappings for this
761      * Context. If no mappings are defined, a zero-length array is returned.
762      */

763     public String JavaDoc[] findServletMappings();
764
765
766     /**
767      * Return the context-relative URI of the error page for the specified
768      * HTTP status code, if any; otherwise return <code>null</code>.
769      *
770      * @param status HTTP status code to look up
771      */

772     public String JavaDoc findStatusPage(int status);
773
774
775     /**
776      * Return the set of HTTP status codes for which error pages have
777      * been specified. If none are specified, a zero-length array
778      * is returned.
779      */

780     public int[] findStatusPages();
781
782
783     /**
784      * Return the tag library descriptor location for the specified taglib
785      * URI, if any; otherwise, return <code>null</code>.
786      *
787      * @param uri URI, relative to the web.xml file
788      */

789     public String JavaDoc findTaglib(String JavaDoc uri);
790
791
792     /**
793      * Return the URIs of all tag libraries for which a tag library
794      * descriptor location has been specified. If none are specified,
795      * a zero-length array is returned.
796      */

797     public String JavaDoc[] findTaglibs();
798
799
800     /**
801      * Return the set of watched resources for this Context. If none are
802      * defined, a zero length array will be returned.
803      */

804     public String JavaDoc[] findWatchedResources();
805     
806
807     /**
808      * Return <code>true</code> if the specified welcome file is defined
809      * for this Context; otherwise return <code>false</code>.
810      *
811      * @param name Welcome file to verify
812      */

813     public boolean findWelcomeFile(String JavaDoc name);
814
815     
816     /**
817      * Return the set of welcome files defined for this Context. If none are
818      * defined, a zero-length array is returned.
819      */

820     public String JavaDoc[] findWelcomeFiles();
821
822
823     /**
824      * Return the set of LifecycleListener classes that will be added to
825      * newly created Wrappers automatically.
826      */

827     public String JavaDoc[] findWrapperLifecycles();
828
829
830     /**
831      * Return the set of ContainerListener classes that will be added to
832      * newly created Wrappers automatically.
833      */

834     public String JavaDoc[] findWrapperListeners();
835
836
837     /**
838      * Reload this web application, if reloading is supported.
839      *
840      * @exception IllegalStateException if the <code>reloadable</code>
841      * property is set to <code>false</code>.
842      */

843     public void reload();
844
845
846     /**
847      * Remove the specified application listener class from the set of
848      * listeners for this application.
849      *
850      * @param listener Java class name of the listener to be removed
851      */

852     public void removeApplicationListener(String JavaDoc listener);
853
854
855     /**
856      * Remove the application parameter with the specified name from
857      * the set for this application.
858      *
859      * @param name Name of the application parameter to remove
860      */

861     public void removeApplicationParameter(String JavaDoc name);
862
863
864     /**
865      * Remove the specified security constraint from this web application.
866      *
867      * @param constraint Constraint to be removed
868      */

869     public void removeConstraint(SecurityConstraint constraint);
870
871
872     /**
873      * Remove the error page for the specified error code or
874      * Java language exception, if it exists; otherwise, no action is taken.
875      *
876      * @param errorPage The error page definition to be removed
877      */

878     public void removeErrorPage(ErrorPage errorPage);
879
880
881     /**
882      * Remove the specified filter definition from this Context, if it exists;
883      * otherwise, no action is taken.
884      *
885      * @param filterDef Filter definition to be removed
886      */

887     public void removeFilterDef(FilterDef filterDef);
888
889
890     /**
891      * Remove a filter mapping from this Context.
892      *
893      * @param filterMap The filter mapping to be removed
894      */

895     public void removeFilterMap(FilterMap filterMap);
896
897
898     /**
899      * Remove a class name from the set of InstanceListener classes that
900      * will be added to newly created Wrappers.
901      *
902      * @param listener Class name of an InstanceListener class to be removed
903      */

904     public void removeInstanceListener(String JavaDoc listener);
905
906
907     /**
908      * Remove the MIME mapping for the specified extension, if it exists;
909      * otherwise, no action is taken.
910      *
911      * @param extension Extension to remove the mapping for
912      */

913     public void removeMimeMapping(String JavaDoc extension);
914
915
916     /**
917      * Remove the context initialization parameter with the specified
918      * name, if it exists; otherwise, no action is taken.
919      *
920      * @param name Name of the parameter to remove
921      */

922     public void removeParameter(String JavaDoc name);
923
924
925     /**
926      * Remove any security role reference for the specified name
927      *
928      * @param role Security role (as used in the application) to remove
929      */

930     public void removeRoleMapping(String JavaDoc role);
931
932
933     /**
934      * Remove any security role with the specified name.
935      *
936      * @param role Security role to remove
937      */

938     public void removeSecurityRole(String JavaDoc role);
939
940
941     /**
942      * Remove any servlet mapping for the specified pattern, if it exists;
943      * otherwise, no action is taken.
944      *
945      * @param pattern URL pattern of the mapping to remove
946      */

947     public void removeServletMapping(String JavaDoc pattern);
948
949
950     /**
951      * Remove the tag library location forthe specified tag library URI.
952      *
953      * @param uri URI, relative to the web.xml file
954      */

955     public void removeTaglib(String JavaDoc uri);
956
957     
958     /**
959      * Remove the specified watched resource name from the list associated
960      * with this Context.
961      *
962      * @param name Name of the watched resource to be removed
963      */

964     public void removeWatchedResource(String JavaDoc name);
965     
966
967     /**
968      * Remove the specified welcome file name from the list recognized
969      * by this Context.
970      *
971      * @param name Name of the welcome file to be removed
972      */

973     public void removeWelcomeFile(String JavaDoc name);
974
975
976     /**
977      * Remove a class name from the set of LifecycleListener classes that
978      * will be added to newly created Wrappers.
979      *
980      * @param listener Class name of a LifecycleListener class to be removed
981      */

982     public void removeWrapperLifecycle(String JavaDoc listener);
983
984
985     /**
986      * Remove a class name from the set of ContainerListener classes that
987      * will be added to newly created Wrappers.
988      *
989      * @param listener Class name of a ContainerListener class to be removed
990      */

991     public void removeWrapperListener(String JavaDoc listener);
992
993
994     /**
995      * Get the server.xml <context> attribute's xmlNamespaceAware.
996      * @return true if namespace awarenes is enabled.
997      *
998      */

999     public boolean getXmlNamespaceAware();
1000
1001
1002    /**
1003     * Get the server.xml <context> attribute's xmlValidation.
1004     * @return true if validation is enabled.
1005     *
1006     */

1007    public boolean getXmlValidation();
1008
1009
1010    /**
1011     * Set the validation feature of the XML parser used when
1012     * parsing xml instances.
1013     * @param xmlValidation true to enable xml instance validation
1014     */

1015    public void setXmlValidation(boolean xmlValidation);
1016
1017
1018   /**
1019     * Set the namespace aware feature of the XML parser used when
1020     * parsing xml instances.
1021     * @param xmlNamespaceAware true to enable namespace awareness
1022     */

1023    public void setXmlNamespaceAware(boolean xmlNamespaceAware);
1024    /**
1025     * Get the server.xml <context> attribute's xmlValidation.
1026     * @return true if validation is enabled.
1027     */

1028     
1029
1030    /**
1031     * Set the validation feature of the XML parser used when
1032     * parsing tlds files.
1033     * @param tldValidation true to enable xml instance validation
1034     */

1035    public void setTldValidation(boolean tldValidation);
1036
1037
1038    /**
1039     * Get the server.xml <context> attribute's webXmlValidation.
1040     * @return true if validation is enabled.
1041     *
1042     */

1043    public boolean getTldValidation();
1044
1045
1046    /**
1047     * Get the server.xml <host> attribute's xmlNamespaceAware.
1048     * @return true if namespace awarenes is enabled.
1049     */

1050    public boolean getTldNamespaceAware();
1051
1052
1053    /**
1054     * Set the namespace aware feature of the XML parser used when
1055     * parsing xml instances.
1056     * @param tldNamespaceAware true to enable namespace awareness
1057     */

1058    public void setTldNamespaceAware(boolean tldNamespaceAware);
1059
1060
1061}
1062
1063
Popular Tags