Java Doc for Context.java in  » Sevlet-Container » tomcat-catalina » org » apache » catalina » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation
1. 6.0 JDK Core
2. 6.0 JDK Modules
3. 6.0 JDK Modules com.sun
4. 6.0 JDK Modules com.sun.java
5. 6.0 JDK Modules sun
6. 6.0 JDK Platform
7. Ajax
8. Apache Harmony Java SE
9. Aspect oriented
10. Authentication Authorization
11. Blogger System
12. Build
13. Byte Code
14. Cache
15. Chart
16. Chat
17. Code Analyzer
18. Collaboration
19. Content Management System
20. Database Client
21. Database DBMS
22. Database JDBC Connection Pool
23. Database ORM
24. Development
25. EJB Server geronimo
26. EJB Server GlassFish
27. EJB Server JBoss 4.2.1
28. EJB Server resin 3.1.5
29. ERP CRM Financial
30. ESB
31. Forum
32. GIS
33. Graphic Library
34. Groupware
35. HTML Parser
36. IDE
37. IDE Eclipse
38. IDE Netbeans
39. Installer
40. Internationalization Localization
41. Inversion of Control
42. Issue Tracking
43. J2EE
44. JBoss
45. JMS
46. JMX
47. Library
48. Mail Clients
49. Net
50. Parser
51. PDF
52. Portal
53. Profiler
54. Project Management
55. Report
56. RSS RDF
57. Rule Engine
58. Science
59. Scripting
60. Search Engine
61. Security
62. Sevlet Container
63. Source Control
64. Swing Library
65. Template Engine
66. Test Coverage
67. Testing
68. UML
69. Web Crawler
70. Web Framework
71. Web Mail
72. Web Server
73. Web Services
74. Web Services apache cxf 2.0.1
75. Web Services AXIS2
76. Wiki Engine
77. Workflow Engines
78. XML
79. XML UI
Java
Java Tutorial
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net Tutorial
Flash / Flex / ActionScript
VBA / Excel / Access / Word
XML
XML Tutorial
Microsoft Office PowerPoint 2007 Tutorial
Microsoft Office Excel 2007 Tutorial
Microsoft Office Word 2007 Tutorial
Java Source Code / Java Documentation » Sevlet Container » tomcat catalina » org.apache.catalina 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


org.apache.catalina.Context

All known Subclasses:   org.apache.catalina.core.StandardContext,
Context
public interface Context extends Container(Code)
A Context is a Container that represents a servlet context, and therefore an individual web application, in the Catalina servlet engine. It is therefore useful in almost every deployment of Catalina (even if a Connector attached to a web server (such as Apache) uses the web server's facilities to identify the appropriate Wrapper to handle this request. It also provides a convenient mechanism to use Interceptors that see every request processed by this particular web application.

The parent Container attached to a Context is generally a Host, but may be some other implementation, or may be omitted if it is not necessary.

The child containers attached to a Context are generally implementations of Wrapper (representing individual servlet definitions).


author:
   Craig R. McClanahan
version:
   $Revision: 1.12 $ $Date: 2004/05/26 15:25:12 $



Field Summary
final public static  StringRELOAD_EVENT
     The LifecycleEvent type sent when a context is reloaded.


Method Summary
public  voidaddApplicationListener(String listener)
     Add a new Listener class name to the set of Listeners configured for this application.
public  voidaddApplicationParameter(ApplicationParameter parameter)
     Add a new application parameter for this application.
public  voidaddConstraint(SecurityConstraint constraint)
     Add a security constraint to the set for this web application.
public  voidaddEjb(ContextEjb ejb)
     Add an EJB resource reference for this web application.
public  voidaddEnvironment(ContextEnvironment environment)
     Add an environment entry for this web application.
public  voidaddErrorPage(ErrorPage errorPage)
     Add an error page for the specified error or Java exception.
public  voidaddFilterDef(FilterDef filterDef)
     Add a filter definition to this Context.
public  voidaddFilterMap(FilterMap filterMap)
     Add a filter mapping to this Context.
public  voidaddInstanceListener(String listener)
     Add the classname of an InstanceListener to be added to each Wrapper appended to this Context.
public  voidaddJspMapping(String pattern)
     Add the given URL pattern as a jsp-property-group.
public  voidaddLocalEjb(ContextLocalEjb ejb)
     Add a local EJB resource reference for this web application.
public  voidaddLocaleEncodingMappingParameter(String locale, String encoding)
    
public  voidaddMimeMapping(String extension, String mimeType)
     Add a new MIME mapping, replacing any existing mapping for the specified extension.
public  voidaddParameter(String name, String value)
     Add a new context initialization parameter, replacing any existing value for the specified name.
public  voidaddResource(ContextResource resource)
     Add a resource reference for this web application.
public  voidaddResourceEnvRef(String name, String type)
     Add a resource environment reference for this web application.
public  voidaddResourceLink(ContextResourceLink resourceLink)
     Add a resource link for this web application.
public  voidaddRoleMapping(String role, String link)
     Add a security role reference for this web application.
public  voidaddSecurityRole(String role)
     Add a new security role for this web application.
public  voidaddServletMapping(String pattern, String name)
     Add a new servlet mapping, replacing any existing mapping for the specified pattern.
public  voidaddTaglib(String uri, String location)
     Add a JSP tag library for the specified URI.
public  voidaddWelcomeFile(String name)
     Add a new welcome file to the set recognized by this Context.
public  voidaddWrapperLifecycle(String listener)
     Add the classname of a LifecycleListener to be added to each Wrapper appended to this Context.
public  voidaddWrapperListener(String listener)
     Add the classname of a ContainerListener to be added to each Wrapper appended to this Context.
public  WrappercreateWrapper()
     Factory method to create and return a new Wrapper instance, of the Java implementation class appropriate for this Context implementation.
public  String[]findApplicationListeners()
     Return the set of application listener class names configured for this application.
public  ApplicationParameter[]findApplicationParameters()
     Return the set of application parameters for this application.
public  SecurityConstraint[]findConstraints()
     Return the set of security constraints for this web application.
public  ContextEjbfindEjb(String name)
     Return the EJB resource reference with the specified name, if any; otherwise, return null.
public  ContextEjb[]findEjbs()
     Return the defined EJB resource references for this application.
public  ContextEnvironmentfindEnvironment(String name)
     Return the environment entry with the specified name, if any; otherwise, return null.
public  ContextEnvironment[]findEnvironments()
     Return the set of defined environment entries for this web application.
public  ErrorPagefindErrorPage(int errorCode)
     Return the error page entry for the specified HTTP error code, if any; otherwise return null.
public  ErrorPagefindErrorPage(String exceptionType)
     Return the error page entry for the specified Java exception type, if any; otherwise return null.
public  ErrorPage[]findErrorPages()
     Return the set of defined error pages for all specified error codes and exception types.
public  FilterDeffindFilterDef(String filterName)
     Return the filter definition for the specified filter name, if any; otherwise return null.
public  FilterDef[]findFilterDefs()
     Return the set of defined filters for this Context.
public  FilterMap[]findFilterMaps()
     Return the set of filter mappings for this Context.
public  String[]findInstanceListeners()
     Return the set of InstanceListener classes that will be added to newly created Wrappers automatically.
public  ContextLocalEjbfindLocalEjb(String name)
     Return the local EJB resource reference with the specified name, if any; otherwise, return null.
public  ContextLocalEjb[]findLocalEjbs()
     Return the defined local EJB resource references for this application.
public  StringfindMimeMapping(String extension)
     Return the MIME type to which the specified extension is mapped, if any; otherwise return null.
public  String[]findMimeMappings()
     Return the extensions for which MIME mappings are defined.
public  StringfindParameter(String name)
     Return the value for the specified context initialization parameter name, if any; otherwise return null.
public  String[]findParameters()
     Return the names of all defined context initialization parameters for this Context.
public  ContextResourcefindResource(String name)
     Return the resource reference with the specified name, if any; otherwise return null.
public  StringfindResourceEnvRef(String name)
     Return the resource environment reference type for the specified name, if any; otherwise return null.
public  String[]findResourceEnvRefs()
     Return the set of resource environment reference names for this web application.
public  ContextResourceLinkfindResourceLink(String name)
     Return the resource link with the specified name, if any; otherwise return null.
public  ContextResourceLink[]findResourceLinks()
     Return the defined resource links for this application.
public  ContextResource[]findResources()
     Return the defined resource references for this application.
public  StringfindRoleMapping(String role)
     For the given security role (as used by an application), return the corresponding role name (as defined by the underlying Realm) if there is one.
public  booleanfindSecurityRole(String role)
     Return true if the specified security role is defined for this application; otherwise return false.
public  String[]findSecurityRoles()
     Return the security roles defined for this application.
public  StringfindServletMapping(String pattern)
     Return the servlet name mapped by the specified pattern (if any); otherwise return null.
public  String[]findServletMappings()
     Return the patterns of all defined servlet mappings for this Context.
public  StringfindStatusPage(int status)
     Return the context-relative URI of the error page for the specified HTTP status code, if any; otherwise return null.
public  int[]findStatusPages()
     Return the set of HTTP status codes for which error pages have been specified.
public  StringfindTaglib(String uri)
     Return the tag library descriptor location for the specified taglib URI, if any; otherwise, return null.
public  String[]findTaglibs()
     Return the URIs of all tag libraries for which a tag library descriptor location has been specified.
public  booleanfindWelcomeFile(String name)
     Return true if the specified welcome file is defined for this Context; otherwise return false.
public  String[]findWelcomeFiles()
     Return the set of welcome files defined for this Context.
public  String[]findWrapperLifecycles()
     Return the set of LifecycleListener classes that will be added to newly created Wrappers automatically.
public  String[]findWrapperListeners()
     Return the set of ContainerListener classes that will be added to newly created Wrappers automatically.
public  StringgetAltDDName()
     Return the alternate Deployment Descriptor name.
public  Object[]getApplicationEventListeners()
     Return the set of initialized application event listener objects, in the order they were specified in the web application deployment descriptor, for this application.
public  Object[]getApplicationLifecycleListeners()
     Return the set of initialized application lifecycle listener objects, in the order they were specified in the web application deployment descriptor, for this application.
public  booleangetAvailable()
     Return the application available flag for this Context.
public  CharsetMappergetCharsetMapper()
     Return the Locale to character set mapper for this Context.
public  StringgetConfigFile()
     Return the path to a file to save this Context information.
public  booleangetConfigured()
     Return the "correctly configured" flag for this Context.
public  booleangetCookies()
     Return the "use cookies for session ids" flag.
public  booleangetCrossContext()
     Return the "allow crossing servlet contexts" flag.
public  StringgetDisplayName()
     Return the display name of this web application.
public  booleangetDistributable()
     Return the distributable flag for this web application.
public  StringgetDocBase()
     Return the document root for this Context.
public  LoginConfiggetLoginConfig()
     Return the login configuration descriptor for this web application.
public  MappergetMapper()
     Get the request dispatcher mapper.
public  NamingResourcesgetNamingResources()
     Return the naming resources associated with this web application.
public  booleangetOverride()
     Return the override flag for this web application.
public  StringgetPath()
     Return the context path for this web application.
public  booleangetPrivileged()
     Return the privileged flag for this web application.
public  StringgetPublicId()
     Return the public identifier of the deployment descriptor DTD that is currently being parsed.
public  booleangetReloadable()
     Return the reloadable flag for this web application.
public  ServletContextgetServletContext()
     Return the servlet context for which this Context is a facade.
public  intgetSessionTimeout()
     Return the default session timeout (in minutes) for this web application.
public  booleangetTldNamespaceAware()
     Get the server.xml attribute's xmlNamespaceAware.
public  booleangetTldValidation()
     Get the server.xml attribute's webXmlValidation.
public  StringgetWrapperClass()
     Return the Java class name of the Wrapper implementation used for servlets registered in this Context.
public  booleangetXmlNamespaceAware()
     Get the server.xml attribute's xmlNamespaceAware.
public  booleangetXmlValidation()
     Get the server.xml attribute's xmlValidation.
public  voidreload()
     Reload this web application, if reloading is supported.
public  voidremoveApplicationListener(String listener)
     Remove the specified application listener class from the set of listeners for this application.
public  voidremoveApplicationParameter(String name)
     Remove the application parameter with the specified name from the set for this application.
public  voidremoveConstraint(SecurityConstraint constraint)
     Remove the specified security constraint from this web application.
public  voidremoveEjb(String name)
     Remove any EJB resource reference with the specified name.
public  voidremoveEnvironment(String name)
     Remove any environment entry with the specified name.
public  voidremoveErrorPage(ErrorPage errorPage)
     Remove the error page for the specified error code or Java language exception, if it exists; otherwise, no action is taken.
public  voidremoveFilterDef(FilterDef filterDef)
     Remove the specified filter definition from this Context, if it exists; otherwise, no action is taken.
public  voidremoveFilterMap(FilterMap filterMap)
     Remove a filter mapping from this Context.
public  voidremoveInstanceListener(String listener)
     Remove a class name from the set of InstanceListener classes that will be added to newly created Wrappers.
public  voidremoveLocalEjb(String name)
     Remove any local EJB resource reference with the specified name.
public  voidremoveMimeMapping(String extension)
     Remove the MIME mapping for the specified extension, if it exists; otherwise, no action is taken.
public  voidremoveParameter(String name)
     Remove the context initialization parameter with the specified name, if it exists; otherwise, no action is taken.
public  voidremoveResource(String name)
     Remove any resource reference with the specified name.
public  voidremoveResourceEnvRef(String name)
     Remove any resource environment reference with the specified name.
public  voidremoveResourceLink(String name)
     Remove any resource link with the specified name.
public  voidremoveRoleMapping(String role)
    
public  voidremoveSecurityRole(String role)
     Remove any security role with the specified name.
public  voidremoveServletMapping(String pattern)
     Remove any servlet mapping for the specified pattern, if it exists; otherwise, no action is taken.
public  voidremoveTaglib(String uri)
     Remove the tag library location forthe specified tag library URI.
public  voidremoveWelcomeFile(String name)
     Remove the specified welcome file name from the list recognized by this Context.
public  voidremoveWrapperLifecycle(String listener)
     Remove a class name from the set of LifecycleListener classes that will be added to newly created Wrappers.
public  voidremoveWrapperListener(String listener)
     Remove a class name from the set of ContainerListener classes that will be added to newly created Wrappers.
public  voidsetAltDDName(String altDDName)
     Set an alternate Deployment Descriptor name.
public  voidsetApplicationEventListeners(Object listeners)
     Store the set of initialized application event listener objects, in the order they were specified in the web application deployment descriptor, for this application.
public  voidsetApplicationLifecycleListeners(Object listeners)
     Store the set of initialized application lifecycle listener objects, in the order they were specified in the web application deployment descriptor, for this application.
public  voidsetAvailable(boolean available)
     Set the application available flag for this Context.
public  voidsetCharsetMapper(CharsetMapper mapper)
     Set the Locale to character set mapper for this Context.
public  voidsetConfigFile(String configFile)
     Set the path to a file to save this Context information.
public  voidsetConfigured(boolean configured)
     Set the "correctly configured" flag for this Context.
public  voidsetCookies(boolean cookies)
     Set the "use cookies for session ids" flag.
public  voidsetCrossContext(boolean crossContext)
     Set the "allow crossing servlet contexts" flag.
public  voidsetDisplayName(String displayName)
     Set the display name of this web application.
public  voidsetDistributable(boolean distributable)
     Set the distributable flag for this web application.
public  voidsetDocBase(String docBase)
     Set the document root for this Context.
public  voidsetLoginConfig(LoginConfig config)
     Set the login configuration descriptor for this web application.
public  voidsetNamingResources(NamingResources namingResources)
     Set the naming resources for this web application.
public  voidsetOverride(boolean override)
     Set the override flag for this web application.
public  voidsetPath(String path)
     Set the context path for this web application.
public  voidsetPrivileged(boolean privileged)
     Set the privileged flag for this web application.
public  voidsetPublicId(String publicId)
     Set the public identifier of the deployment descriptor DTD that is currently being parsed.
public  voidsetReloadable(boolean reloadable)
     Set the reloadable flag for this web application.
public  voidsetSessionTimeout(int timeout)
     Set the default session timeout (in minutes) for this web application.
public  voidsetTldNamespaceAware(boolean tldNamespaceAware)
     Set the namespace aware feature of the XML parser used when parsing xml instances.
public  voidsetTldValidation(boolean tldValidation)
     Set the validation feature of the XML parser used when parsing tlds files.
public  voidsetWrapperClass(String wrapperClass)
     Set the Java class name of the Wrapper implementation used for servlets registered in this Context.
public  voidsetXmlNamespaceAware(boolean xmlNamespaceAware)
     Set the namespace aware feature of the XML parser used when parsing xml instances.
public  voidsetXmlValidation(boolean xmlValidation)
     Set the validation feature of the XML parser used when parsing xml instances.

Field Detail
RELOAD_EVENT
final public static String RELOAD_EVENT(Code)
The LifecycleEvent type sent when a context is reloaded.





Method Detail
addApplicationListener
public void addApplicationListener(String listener)(Code)
Add a new Listener class name to the set of Listeners configured for this application.
Parameters:
  listener - Java class name of a listener class



addApplicationParameter
public void addApplicationParameter(ApplicationParameter parameter)(Code)
Add a new application parameter for this application.
Parameters:
  parameter - The new application parameter



addConstraint
public void addConstraint(SecurityConstraint constraint)(Code)
Add a security constraint to the set for this web application.



addEjb
public void addEjb(ContextEjb ejb)(Code)
Add an EJB resource reference for this web application.
Parameters:
  ejb - New EJB resource reference



addEnvironment
public void addEnvironment(ContextEnvironment environment)(Code)
Add an environment entry for this web application.
Parameters:
  environment - New environment entry



addErrorPage
public void addErrorPage(ErrorPage errorPage)(Code)
Add an error page for the specified error or Java exception.
Parameters:
  errorPage - The error page definition to be added



addFilterDef
public void addFilterDef(FilterDef filterDef)(Code)
Add a filter definition to this Context.
Parameters:
  filterDef - The filter definition to be added



addFilterMap
public void addFilterMap(FilterMap filterMap)(Code)
Add a filter mapping to this Context.
Parameters:
  filterMap - The filter mapping to be added



addInstanceListener
public void addInstanceListener(String listener)(Code)
Add the classname of an InstanceListener to be added to each Wrapper appended to this Context.
Parameters:
  listener - Java class name of an InstanceListener class



addJspMapping
public void addJspMapping(String pattern)(Code)
Add the given URL pattern as a jsp-property-group. This maps resources that match the given pattern so they will be passed to the JSP container. Though there are other elements in the property group, we only care about the URL pattern here. The JSP container will parse the rest.
Parameters:
  pattern - URL pattern to be mapped



addLocalEjb
public void addLocalEjb(ContextLocalEjb ejb)(Code)
Add a local EJB resource reference for this web application.
Parameters:
  ejb - New local EJB resource reference



addLocaleEncodingMappingParameter
public void addLocaleEncodingMappingParameter(String locale, String encoding)(Code)
Add a Locale Encoding Mapping (see Sec 5.4 of Servlet spec 2.4)
Parameters:
  locale - locale to map an encoding for
Parameters:
  encoding - encoding to be used for a give locale



addMimeMapping
public void addMimeMapping(String extension, String mimeType)(Code)
Add a new MIME mapping, replacing any existing mapping for the specified extension.
Parameters:
  extension - Filename extension being mapped
Parameters:
  mimeType - Corresponding MIME type



addParameter
public void addParameter(String name, String value)(Code)
Add a new context initialization parameter, replacing any existing value for the specified name.
Parameters:
  name - Name of the new parameter
Parameters:
  value - Value of the new parameter



addResource
public void addResource(ContextResource resource)(Code)
Add a resource reference for this web application.
Parameters:
  resource - New resource reference



addResourceEnvRef
public void addResourceEnvRef(String name, String type)(Code)
Add a resource environment reference for this web application.
Parameters:
  name - The resource environment reference name
Parameters:
  type - The resource environment reference type



addResourceLink
public void addResourceLink(ContextResourceLink resourceLink)(Code)
Add a resource link for this web application.
Parameters:
  resourceLink - New resource link



addRoleMapping
public void addRoleMapping(String role, String link)(Code)
Add a security role reference for this web application.
Parameters:
  role - Security role used in the application
Parameters:
  link - Actual security role to check for



addSecurityRole
public void addSecurityRole(String role)(Code)
Add a new security role for this web application.
Parameters:
  role - New security role



addServletMapping
public void addServletMapping(String pattern, String name)(Code)
Add a new servlet mapping, replacing any existing mapping for the specified pattern.
Parameters:
  pattern - URL pattern to be mapped
Parameters:
  name - Name of the corresponding servlet to execute



addTaglib
public void addTaglib(String uri, String location)(Code)
Add a JSP tag library for the specified URI.
Parameters:
  uri - URI, relative to the web.xml file, of this tag library
Parameters:
  location - Location of the tag library descriptor



addWelcomeFile
public void addWelcomeFile(String name)(Code)
Add a new welcome file to the set recognized by this Context.
Parameters:
  name - New welcome file name



addWrapperLifecycle
public void addWrapperLifecycle(String listener)(Code)
Add the classname of a LifecycleListener to be added to each Wrapper appended to this Context.
Parameters:
  listener - Java class name of a LifecycleListener class



addWrapperListener
public void addWrapperListener(String listener)(Code)
Add the classname of a ContainerListener to be added to each Wrapper appended to this Context.
Parameters:
  listener - Java class name of a ContainerListener class



createWrapper
public Wrapper createWrapper()(Code)
Factory method to create and return a new Wrapper instance, of the Java implementation class appropriate for this Context implementation. The constructor of the instantiated Wrapper will have been called, but no properties will have been set.



findApplicationListeners
public String[] findApplicationListeners()(Code)
Return the set of application listener class names configured for this application.



findApplicationParameters
public ApplicationParameter[] findApplicationParameters()(Code)
Return the set of application parameters for this application.



findConstraints
public SecurityConstraint[] findConstraints()(Code)
Return the set of security constraints for this web application. If there are none, a zero-length array is returned.



findEjb
public ContextEjb findEjb(String name)(Code)
Return the EJB resource reference with the specified name, if any; otherwise, return null.
Parameters:
  name - Name of the desired EJB resource reference



findEjbs
public ContextEjb[] findEjbs()(Code)
Return the defined EJB resource references for this application. If there are none, a zero-length array is returned.



findEnvironment
public ContextEnvironment findEnvironment(String name)(Code)
Return the environment entry with the specified name, if any; otherwise, return null.
Parameters:
  name - Name of the desired environment entry



findEnvironments
public ContextEnvironment[] findEnvironments()(Code)
Return the set of defined environment entries for this web application. If none have been defined, a zero-length array is returned.



findErrorPage
public ErrorPage findErrorPage(int errorCode)(Code)
Return the error page entry for the specified HTTP error code, if any; otherwise return null.
Parameters:
  errorCode - Error code to look up



findErrorPage
public ErrorPage findErrorPage(String exceptionType)(Code)
Return the error page entry for the specified Java exception type, if any; otherwise return null.
Parameters:
  exceptionType - Exception type to look up



findErrorPages
public ErrorPage[] findErrorPages()(Code)
Return the set of defined error pages for all specified error codes and exception types.



findFilterDef
public FilterDef findFilterDef(String filterName)(Code)
Return the filter definition for the specified filter name, if any; otherwise return null.
Parameters:
  filterName - Filter name to look up



findFilterDefs
public FilterDef[] findFilterDefs()(Code)
Return the set of defined filters for this Context.



findFilterMaps
public FilterMap[] findFilterMaps()(Code)
Return the set of filter mappings for this Context.



findInstanceListeners
public String[] findInstanceListeners()(Code)
Return the set of InstanceListener classes that will be added to newly created Wrappers automatically.



findLocalEjb
public ContextLocalEjb findLocalEjb(String name)(Code)
Return the local EJB resource reference with the specified name, if any; otherwise, return null.
Parameters:
  name - Name of the desired EJB resource reference



findLocalEjbs
public ContextLocalEjb[] findLocalEjbs()(Code)
Return the defined local EJB resource references for this application. If there are none, a zero-length array is returned.



findMimeMapping
public String findMimeMapping(String extension)(Code)
Return the MIME type to which the specified extension is mapped, if any; otherwise return null.
Parameters:
  extension - Extension to map to a MIME type



findMimeMappings
public String[] findMimeMappings()(Code)
Return the extensions for which MIME mappings are defined. If there are none, a zero-length array is returned.



findParameter
public String findParameter(String name)(Code)
Return the value for the specified context initialization parameter name, if any; otherwise return null.
Parameters:
  name - Name of the parameter to return



findParameters
public String[] findParameters()(Code)
Return the names of all defined context initialization parameters for this Context. If no parameters are defined, a zero-length array is returned.



findResource
public ContextResource findResource(String name)(Code)
Return the resource reference with the specified name, if any; otherwise return null.
Parameters:
  name - Name of the desired resource reference



findResourceEnvRef
public String findResourceEnvRef(String name)(Code)
Return the resource environment reference type for the specified name, if any; otherwise return null.
Parameters:
  name - Name of the desired resource environment reference



findResourceEnvRefs
public String[] findResourceEnvRefs()(Code)
Return the set of resource environment reference names for this web application. If none have been specified, a zero-length array is returned.



findResourceLink
public ContextResourceLink findResourceLink(String name)(Code)
Return the resource link with the specified name, if any; otherwise return null.
Parameters:
  name - Name of the desired resource link



findResourceLinks
public ContextResourceLink[] findResourceLinks()(Code)
Return the defined resource links for this application. If none have been defined, a zero-length array is returned.



findResources
public ContextResource[] findResources()(Code)
Return the defined resource references for this application. If none have been defined, a zero-length array is returned.



findRoleMapping
public String findRoleMapping(String role)(Code)
For the given security role (as used by an application), return the corresponding role name (as defined by the underlying Realm) if there is one. Otherwise, return the specified role unchanged.
Parameters:
  role - Security role to map



findSecurityRole
public boolean findSecurityRole(String role)(Code)
Return true if the specified security role is defined for this application; otherwise return false.
Parameters:
  role - Security role to verify



findSecurityRoles
public String[] findSecurityRoles()(Code)
Return the security roles defined for this application. If none have been defined, a zero-length array is returned.



findServletMapping
public String findServletMapping(String pattern)(Code)
Return the servlet name mapped by the specified pattern (if any); otherwise return null.
Parameters:
  pattern - Pattern for which a mapping is requested



findServletMappings
public String[] findServletMappings()(Code)
Return the patterns of all defined servlet mappings for this Context. If no mappings are defined, a zero-length array is returned.



findStatusPage
public String findStatusPage(int status)(Code)
Return the context-relative URI of the error page for the specified HTTP status code, if any; otherwise return null.
Parameters:
  status - HTTP status code to look up



findStatusPages
public int[] findStatusPages()(Code)
Return the set of HTTP status codes for which error pages have been specified. If none are specified, a zero-length array is returned.



findTaglib
public String findTaglib(String uri)(Code)
Return the tag library descriptor location for the specified taglib URI, if any; otherwise, return null.
Parameters:
  uri - URI, relative to the web.xml file



findTaglibs
public String[] findTaglibs()(Code)
Return the URIs of all tag libraries for which a tag library descriptor location has been specified. If none are specified, a zero-length array is returned.



findWelcomeFile
public boolean findWelcomeFile(String name)(Code)
Return true if the specified welcome file is defined for this Context; otherwise return false.
Parameters:
  name - Welcome file to verify



findWelcomeFiles
public String[] findWelcomeFiles()(Code)
Return the set of welcome files defined for this Context. If none are defined, a zero-length array is returned.



findWrapperLifecycles
public String[] findWrapperLifecycles()(Code)
Return the set of LifecycleListener classes that will be added to newly created Wrappers automatically.



findWrapperListeners
public String[] findWrapperListeners()(Code)
Return the set of ContainerListener classes that will be added to newly created Wrappers automatically.



getAltDDName
public String getAltDDName()(Code)
Return the alternate Deployment Descriptor name.



getApplicationEventListeners
public Object[] getApplicationEventListeners()(Code)
Return the set of initialized application event listener objects, in the order they were specified in the web application deployment descriptor, for this application.
exception:
  IllegalStateException - if this method is called beforethis application has started, or after it has been stopped



getApplicationLifecycleListeners
public Object[] getApplicationLifecycleListeners()(Code)
Return the set of initialized application lifecycle listener objects, in the order they were specified in the web application deployment descriptor, for this application.
exception:
  IllegalStateException - if this method is called beforethis application has started, or after it has been stopped



getAvailable
public boolean getAvailable()(Code)
Return the application available flag for this Context.



getCharsetMapper
public CharsetMapper getCharsetMapper()(Code)
Return the Locale to character set mapper for this Context.



getConfigFile
public String getConfigFile()(Code)
Return the path to a file to save this Context information.



getConfigured
public boolean getConfigured()(Code)
Return the "correctly configured" flag for this Context.



getCookies
public boolean getCookies()(Code)
Return the "use cookies for session ids" flag.



getCrossContext
public boolean getCrossContext()(Code)
Return the "allow crossing servlet contexts" flag.



getDisplayName
public String getDisplayName()(Code)
Return the display name of this web application.



getDistributable
public boolean getDistributable()(Code)
Return the distributable flag for this web application.



getDocBase
public String getDocBase()(Code)
Return the document root for this Context. This can be an absolute pathname, a relative pathname, or a URL.



getLoginConfig
public LoginConfig getLoginConfig()(Code)
Return the login configuration descriptor for this web application.



getMapper
public Mapper getMapper()(Code)
Get the request dispatcher mapper.



getNamingResources
public NamingResources getNamingResources()(Code)
Return the naming resources associated with this web application.



getOverride
public boolean getOverride()(Code)
Return the override flag for this web application.



getPath
public String getPath()(Code)
Return the context path for this web application.



getPrivileged
public boolean getPrivileged()(Code)
Return the privileged flag for this web application.



getPublicId
public String getPublicId()(Code)
Return the public identifier of the deployment descriptor DTD that is currently being parsed.



getReloadable
public boolean getReloadable()(Code)
Return the reloadable flag for this web application.



getServletContext
public ServletContext getServletContext()(Code)
Return the servlet context for which this Context is a facade.



getSessionTimeout
public int getSessionTimeout()(Code)
Return the default session timeout (in minutes) for this web application.



getTldNamespaceAware
public boolean getTldNamespaceAware()(Code)
Get the server.xml attribute's xmlNamespaceAware. true if namespace awarenes is enabled.



getTldValidation
public boolean getTldValidation()(Code)
Get the server.xml attribute's webXmlValidation. true if validation is enabled.



getWrapperClass
public String getWrapperClass()(Code)
Return the Java class name of the Wrapper implementation used for servlets registered in this Context.



getXmlNamespaceAware
public boolean getXmlNamespaceAware()(Code)
Get the server.xml attribute's xmlNamespaceAware. true if namespace awarenes is enabled.



getXmlValidation
public boolean getXmlValidation()(Code)
Get the server.xml attribute's xmlValidation. true if validation is enabled.



reload
public void reload()(Code)
Reload this web application, if reloading is supported.
exception:
  IllegalStateException - if the reloadableproperty is set to false.



removeApplicationListener
public void removeApplicationListener(String listener)(Code)
Remove the specified application listener class from the set of listeners for this application.
Parameters:
  listener - Java class name of the listener to be removed



removeApplicationParameter
public void removeApplicationParameter(String name)(Code)
Remove the application parameter with the specified name from the set for this application.
Parameters:
  name - Name of the application parameter to remove



removeConstraint
public void removeConstraint(SecurityConstraint constraint)(Code)
Remove the specified security constraint from this web application.
Parameters:
  constraint - Constraint to be removed



removeEjb
public void removeEjb(String name)(Code)
Remove any EJB resource reference with the specified name.
Parameters:
  name - Name of the EJB resource reference to remove



removeEnvironment
public void removeEnvironment(String name)(Code)
Remove any environment entry with the specified name.
Parameters:
  name - Name of the environment entry to remove



removeErrorPage
public void removeErrorPage(ErrorPage errorPage)(Code)
Remove the error page for the specified error code or Java language exception, if it exists; otherwise, no action is taken.
Parameters:
  errorPage - The error page definition to be removed



removeFilterDef
public void removeFilterDef(FilterDef filterDef)(Code)
Remove the specified filter definition from this Context, if it exists; otherwise, no action is taken.
Parameters:
  filterDef - Filter definition to be removed



removeFilterMap
public void removeFilterMap(FilterMap filterMap)(Code)
Remove a filter mapping from this Context.
Parameters:
  filterMap - The filter mapping to be removed



removeInstanceListener
public void removeInstanceListener(String listener)(Code)
Remove a class name from the set of InstanceListener classes that will be added to newly created Wrappers.
Parameters:
  listener - Class name of an InstanceListener class to be removed



removeLocalEjb
public void removeLocalEjb(String name)(Code)
Remove any local EJB resource reference with the specified name.
Parameters:
  name - Name of the EJB resource reference to remove



removeMimeMapping
public void removeMimeMapping(String extension)(Code)
Remove the MIME mapping for the specified extension, if it exists; otherwise, no action is taken.
Parameters:
  extension - Extension to remove the mapping for



removeParameter
public void removeParameter(String name)(Code)
Remove the context initialization parameter with the specified name, if it exists; otherwise, no action is taken.
Parameters:
  name - Name of the parameter to remove



removeResource
public void removeResource(String name)(Code)
Remove any resource reference with the specified name.
Parameters:
  name - Name of the resource reference to remove



removeResourceEnvRef
public void removeResourceEnvRef(String name)(Code)
Remove any resource environment reference with the specified name.
Parameters:
  name - Name of the resource environment reference to remove



removeResourceLink
public void removeResourceLink(String name)(Code)
Remove any resource link with the specified name.
Parameters:
  name - Name of the resource link to remove



removeRoleMapping
public void removeRoleMapping(String role)(Code)
Remove any security role reference for the specified name
Parameters:
  role - Security role (as used in the application) to remove



removeSecurityRole
public void removeSecurityRole(String role)(Code)
Remove any security role with the specified name.
Parameters:
  role - Security role to remove



removeServletMapping
public void removeServletMapping(String pattern)(Code)
Remove any servlet mapping for the specified pattern, if it exists; otherwise, no action is taken.
Parameters:
  pattern - URL pattern of the mapping to remove



removeTaglib
public void removeTaglib(String uri)(Code)
Remove the tag library location forthe specified tag library URI.
Parameters:
  uri - URI, relative to the web.xml file



removeWelcomeFile
public void removeWelcomeFile(String name)(Code)
Remove the specified welcome file name from the list recognized by this Context.
Parameters:
  name - Name of the welcome file to be removed



removeWrapperLifecycle
public void removeWrapperLifecycle(String listener)(Code)
Remove a class name from the set of LifecycleListener classes that will be added to newly created Wrappers.
Parameters:
  listener - Class name of a LifecycleListener class to be removed



removeWrapperListener
public void removeWrapperListener(String listener)(Code)
Remove a class name from the set of ContainerListener classes that will be added to newly created Wrappers.
Parameters:
  listener - Class name of a ContainerListener class to be removed



setAltDDName
public void setAltDDName(String altDDName)(Code)
Set an alternate Deployment Descriptor name.



setApplicationEventListeners
public void setApplicationEventListeners(Object listeners)(Code)
Store the set of initialized application event listener objects, in the order they were specified in the web application deployment descriptor, for this application.
Parameters:
  listeners - The set of instantiated listener objects.



setApplicationLifecycleListeners
public void setApplicationLifecycleListeners(Object listeners)(Code)
Store the set of initialized application lifecycle listener objects, in the order they were specified in the web application deployment descriptor, for this application.
Parameters:
  listeners - The set of instantiated listener objects.



setAvailable
public void setAvailable(boolean available)(Code)
Set the application available flag for this Context.
Parameters:
  available - The new application available flag



setCharsetMapper
public void setCharsetMapper(CharsetMapper mapper)(Code)
Set the Locale to character set mapper for this Context.
Parameters:
  mapper - The new mapper



setConfigFile
public void setConfigFile(String configFile)(Code)
Set the path to a file to save this Context information.
Parameters:
  configFile - The path to a file to save this Context information.



setConfigured
public void setConfigured(boolean configured)(Code)
Set the "correctly configured" flag for this Context. This can be set to false by startup listeners that detect a fatal configuration error to avoid the application from being made available.
Parameters:
  configured - The new correctly configured flag



setCookies
public void setCookies(boolean cookies)(Code)
Set the "use cookies for session ids" flag.
Parameters:
  cookies - The new flag



setCrossContext
public void setCrossContext(boolean crossContext)(Code)
Set the "allow crossing servlet contexts" flag.
Parameters:
  crossContext - The new cross contexts flag



setDisplayName
public void setDisplayName(String displayName)(Code)
Set the display name of this web application.
Parameters:
  displayName - The new display name



setDistributable
public void setDistributable(boolean distributable)(Code)
Set the distributable flag for this web application.
Parameters:
  distributable - The new distributable flag



setDocBase
public void setDocBase(String docBase)(Code)
Set the document root for this Context. This can be an absolute pathname, a relative pathname, or a URL.
Parameters:
  docBase - The new document root



setLoginConfig
public void setLoginConfig(LoginConfig config)(Code)
Set the login configuration descriptor for this web application.
Parameters:
  config - The new login configuration



setNamingResources
public void setNamingResources(NamingResources namingResources)(Code)
Set the naming resources for this web application.
Parameters:
  namingResources - The new naming resources



setOverride
public void setOverride(boolean override)(Code)
Set the override flag for this web application.
Parameters:
  override - The new override flag



setPath
public void setPath(String path)(Code)
Set the context path for this web application.
Parameters:
  path - The new context path



setPrivileged
public void setPrivileged(boolean privileged)(Code)
Set the privileged flag for this web application.
Parameters:
  privileged - The new privileged flag



setPublicId
public void setPublicId(String publicId)(Code)
Set the public identifier of the deployment descriptor DTD that is currently being parsed.
Parameters:
  publicId - The public identifier



setReloadable
public void setReloadable(boolean reloadable)(Code)
Set the reloadable flag for this web application.
Parameters:
  reloadable - The new reloadable flag



setSessionTimeout
public void setSessionTimeout(int timeout)(Code)
Set the default session timeout (in minutes) for this web application.
Parameters:
  timeout - The new default session timeout



setTldNamespaceAware
public void setTldNamespaceAware(boolean tldNamespaceAware)(Code)
Set the namespace aware feature of the XML parser used when parsing xml instances.
Parameters:
  tldNamespaceAware - true to enable namespace awareness



setTldValidation
public void setTldValidation(boolean tldValidation)(Code)
Set the validation feature of the XML parser used when parsing tlds files.
Parameters:
  tldValidation - true to enable xml instance validation



setWrapperClass
public void setWrapperClass(String wrapperClass)(Code)
Set the Java class name of the Wrapper implementation used for servlets registered in this Context.
Parameters:
  wrapperClass - The new wrapper class



setXmlNamespaceAware
public void setXmlNamespaceAware(boolean xmlNamespaceAware)(Code)
Set the namespace aware feature of the XML parser used when parsing xml instances.
Parameters:
  xmlNamespaceAware - true to enable namespace awareness



setXmlValidation
public void setXmlValidation(boolean xmlValidation)(Code)
Set the validation feature of the XML parser used when parsing xml instances.
Parameters:
  xmlValidation - true to enable xml instance validation



www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.