Java Doc for Host.java in  » Sevlet-Container » apache-tomcat-6.0.14 » 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 » apache tomcat 6.0.14 » org.apache.catalina 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


org.apache.catalina.Host

All known Subclasses:   org.apache.catalina.core.StandardHost,
Host
public interface Host extends Container(Code)
A Host is a Container that represents a virtual host in the Catalina servlet engine. It is useful in the following types of scenarios:
  • You wish to use Interceptors that see every single request processed by this particular virtual host.
  • You wish to run Catalina in with a standalone HTTP connector, but still want support for multiple virtual hosts.
In general, you would not use a Host when deploying Catalina connected to a web server (such as Apache), because the Connector will have utilized the web server's facilities to determine which Context (or perhaps even which Wrapper) should be utilized to process this request.

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

The child containers attached to a Host are generally implementations of Context (representing an individual servlet context).
author:
   Craig R. McClanahan
version:
   $Revision: 467222 $ $Date: 2006-10-24 05:17:11 +0200 (mar., 24 oct. 2006) $



Field Summary
final public static  StringADD_ALIAS_EVENT
     The ContainerEvent event type sent when a new alias is added by addAlias().
final public static  StringREMOVE_ALIAS_EVENT
     The ContainerEvent event type sent when an old alias is removed by removeAlias().


Method Summary
public  voidaddAlias(String alias)
     Add an alias name that should be mapped to this same Host.
public  String[]findAliases()
     Return the set of alias names for this Host.
public  StringgetAppBase()
     Return the application root for this Host.
public  booleangetAutoDeploy()
     Return the value of the auto deploy flag.
public  StringgetConfigClass()
     Return the Java class name of the context configuration class for new web applications.
public  booleangetDeployOnStartup()
     Return the value of the deploy on startup flag.
public  StringgetName()
     Return the canonical, fully qualified, name of the virtual host this Container represents.
public  booleangetXmlNamespaceAware()
     Get the server.xml attribute's xmlNamespaceAware.
public  booleangetXmlValidation()
     Get the server.xml attribute's xmlValidation.
public  Contextmap(String uri)
     Return the Context that would be used to process the specified host-relative request URI, if any; otherwise return null.
public  voidremoveAlias(String alias)
     Remove the specified alias name from the aliases for this Host.
public  voidsetAppBase(String appBase)
     Set the application root for this Host.
public  voidsetAutoDeploy(boolean autoDeploy)
     Set the auto deploy flag value for this host.
public  voidsetConfigClass(String configClass)
     Set the Java class name of the context configuration class for new web applications.
public  voidsetDeployOnStartup(boolean deployOnStartup)
     Set the deploy on startup flag value for this host.
public  voidsetName(String name)
     Set the canonical, fully qualified, name of the virtual host this Container represents.
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
ADD_ALIAS_EVENT
final public static String ADD_ALIAS_EVENT(Code)
The ContainerEvent event type sent when a new alias is added by addAlias().



REMOVE_ALIAS_EVENT
final public static String REMOVE_ALIAS_EVENT(Code)
The ContainerEvent event type sent when an old alias is removed by removeAlias().





Method Detail
addAlias
public void addAlias(String alias)(Code)
Add an alias name that should be mapped to this same Host.
Parameters:
  alias - The alias to be added



findAliases
public String[] findAliases()(Code)
Return the set of alias names for this Host. If none are defined, a zero length array is returned.



getAppBase
public String getAppBase()(Code)
Return the application root for this Host. This can be an absolute pathname, a relative pathname, or a URL.



getAutoDeploy
public boolean getAutoDeploy()(Code)
Return the value of the auto deploy flag. If true, it indicates that this host's child webapps should be discovred and automatically deployed dynamically.



getConfigClass
public String getConfigClass()(Code)
Return the Java class name of the context configuration class for new web applications.



getDeployOnStartup
public boolean getDeployOnStartup()(Code)
Return the value of the deploy on startup flag. If true, it indicates that this host's child webapps should be discovred and automatically deployed.



getName
public String getName()(Code)
Return the canonical, fully qualified, name of the virtual host this Container represents.



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.



map
public Context map(String uri)(Code)
Return the Context that would be used to process the specified host-relative request URI, if any; otherwise return null.
Parameters:
  uri - Request URI to be mapped



removeAlias
public void removeAlias(String alias)(Code)
Remove the specified alias name from the aliases for this Host.
Parameters:
  alias - Alias name to be removed



setAppBase
public void setAppBase(String appBase)(Code)
Set the application root for this Host. This can be an absolute pathname, a relative pathname, or a URL.
Parameters:
  appBase - The new application root



setAutoDeploy
public void setAutoDeploy(boolean autoDeploy)(Code)
Set the auto deploy flag value for this host.
Parameters:
  autoDeploy - The new auto deploy flag



setConfigClass
public void setConfigClass(String configClass)(Code)
Set the Java class name of the context configuration class for new web applications.
Parameters:
  configClass - The new context configuration class



setDeployOnStartup
public void setDeployOnStartup(boolean deployOnStartup)(Code)
Set the deploy on startup flag value for this host.
Parameters:
  deployOnStartup - The new deploy on startup flag



setName
public void setName(String name)(Code)
Set the canonical, fully qualified, name of the virtual host this Container represents.
Parameters:
  name - Virtual host name
exception:
  IllegalArgumentException - if name is null



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.