From jbossweb-commits at lists.jboss.org Mon Feb 11 05:14:15 2013
Content-Type: multipart/mixed; boundary="===============1552019583959442020=="
MIME-Version: 1.0
From: jbossweb-commits at lists.jboss.org
To: jbossweb-commits at lists.jboss.org
Subject: [jbossweb-commits] JBossWeb SVN: r2158 - in
branches/7.2.x/webapps/docs: config and 1 other directory.
Date: Mon, 11 Feb 2013 05:14:15 -0500
Message-ID: <201302111014.r1BAEFKF003063@svn01.web.mwc.hst.phx2.redhat.com>
--===============1552019583959442020==
Content-Type: text/plain; charset="utf-8"
MIME-Version: 1.0
Content-Transfer-Encoding: quoted-printable
Author: jfrederic.clere(a)jboss.com
Date: 2013-02-11 05:14:15 -0500 (Mon, 11 Feb 2013)
New Revision: 2158
Modified:
branches/7.2.x/webapps/docs/config/context.xml
branches/7.2.x/webapps/docs/tomcat-docs.xsl
Log:
Arrange docs.
Modified: branches/7.2.x/webapps/docs/config/context.xml
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D
--- branches/7.2.x/webapps/docs/config/context.xml 2013-02-07 13:17:05 UTC =
(rev 2157)
+++ branches/7.2.x/webapps/docs/config/context.xml 2013-02-11 10:14:15 UTC =
(rev 2158)
@@ -7,7 +7,7 @@
&project;
=
For JBoss Web, unlike Tomcat 4.x, it is NOT recommended to place
- <Context> elements directly in the server.xml file. This
- is because it makes modifing the Context configuration
- more invasive since the main conf/server.xml
file cannot be
- reloaded without restarting JBoss Web.
In AS7 the file context.xml is ignored + Most of the old context.xml configuration has been moved to + jboss-web.xml (See jboss-web.xml).
= -Context elements may be explicitly defined: -
$CATALINA_BASE/conf/context.xml
file: =
- the Context element information will be loaded by all webapps.$CATALINA_BASE/conf/[enginename]/[hostname]/context.xml.default
- file: the Context element information will be loaded by all webapps of t=
hat
- host.
$CATALINA_BASE/conf/[enginename]/[hostname]/
directory.
- The name of the file (less the .xml extension) will be used as the
- context path. Multi-level context paths may be defined using #, e.g.
- foo#bar.xml
for a context path of /foo/bar
. The
- default web application may be defined by using a file called
- ROOT.xml
.$CATALINA_BASE/conf/[enginename]/[hostname]/
, in an individ=
ual
- file at /META-INF/context.xml
inside the application files.=
If
- the web application is packaged as a WAR then
- /META-INF/context.xml
will be copied to
- $CATALINA_BASE/conf/[enginename]/[hostname]/
and renamed to
- match the application's context path. Once this file exists, it will not=
be
- replaced if a new WAR with a newer /META-INF/context.xml
is
- placed in the host's appBase.conf/server.xml
.In addition to explicitly specified Context elements, there are - several techniques by which Context elements can be created automatically - for you. See - Automatic Application Deployment and - User Web Applications - for more information.
- --- = = @@ -118,63 +70,40 @@ the thread will invoke the backgroundProcess method on this host = and all its child containers. A context will use background = processing to perform session expiration and class monitoring for - reloading. If not specified, the default value for this attribute = is = - -1, which means the context will rely on the background processing = - thread of its parent host. + reloading. The value of this attribut is 10 seconds. =The description below uses the variable name $CATALINA_HOME - to refer to the directory into which you have installed JBoss Web, - and is the base directory against which most relative paths are - resolved. However, if you have configured Tomcat for multiple - instances by setting a CATALINA_BASE directory, you should use - $CATALINA_BASE instead of $CATALINA_HOME for each of these - references.
-
Java class name of the implementation to use. This class must
implement the org.apache.catalina.Context
interface.
- If not specified, the standard value (defined below) will be used.=
Set to true
if you want cookies to be used for
- session identifier communication if supported by the client (this
- is the default). Set to false
if you want to disable
- the use of cookies for session identifier communication, and rely
- only on URL rewriting by the application.
To control the cookies use session-config
=
+ in web.xml
Set to true
if you want calls within this applicat=
ion
+
Use disable-cross-context
in jboss-web.xml
Set to false
if you want calls within this applica=
tion
to ServletContext.getContext()
to successfully return=
a
request dispatcher for other web applications running on this virt=
ual
- host. Set to false
(the default) in security
+ host. Set to true
(the default) in security
conscious environments, to make getContext()
always
return null
.
The Document Base (also known as the Context
- Root) directory for this web application, or the pathname
- to the web application archive file (if this web application is
- being executed directly from the WAR file). You may specify
- an absolute pathname for this directory or WAR file, or a pathname
- that is relative to the appBase
directory of the
- owning Host.
Can't be changed in AS7
Set to true
to have explicit settings in this
- Context element override any corresponding settings in either the =
global
- or Host default contexts. By default, s=
ettings
- from a default context will be used.
If a symbolic link is used for docBase then changes to the - symbolic link will only be effective after a JBoss Web restart or - by undeploying and redeploying the conext. A context reload is not - sufficient.
+Not supported in AS7
Set to true
to allow this context to use container
- servlets, like the manager servlet. Use of the privileged
- attribute will change the context's parent class loader to be the
- Server class loader rather than the Shared class
- loader. Note that in a default installation, the Common c=
lass
- loader is used for both the Server and the Shared
- class loaders.
Not supported in AS7
context-root
in jboss-web.xml to configure that i=
n AS7.
deployment-scanner
in stan=
dalone.xml
+ or development
in the jsp-configuration element insid=
e the
+ subsystem=3Dweb element.
Java class name of the org.apache.catalina.Wrapper
implementation class that will be used for servlets managed by this
- Context. If not specified, a standard default value will be used.=
org.apache.catalina.core.StandardWrapper
is=
used.
Actually not supported in AS7
If the value of this flag is true
, symlinks will be
allowed inside the web application, pointing to resources outside =
the
web application base path. If not specified, the default value
@@ -235,51 +162,29 @@
If true, the JBoss Web classloader will take extra measures to =
avoid
- JAR file locking when resources are accessed inside JARs through U=
RLs.
- This will impact startup time of applications, but could prove to =
be useful
- on platforms or configurations where file locking can occur.
- If not specified, the default value is false
.
Not supported in AS7
If true, JBoss Web will prevent any file locking.
- This will significantly impact startup time of applications, =
- but allows full webapp hot deploy and undeploy on platforms =
- or configurations where file locking can occur.
- If not specified, the default value is false
.
Please note that setting this to true
has some sid=
e effects,
- including the disabling of JSP reloading in a running server: see
- Bugzilla 37668.
-
- Please note that setting this flag to true in applications that are
- outside the appBase for the Host (the webapps
directo=
ry
- by default) will cause the application to be
- deleted on JBoss Web shutdown. You probably don'=
t want to
- do this, so think twice before setting antiResourceLocking=3Dtrue =
on a webapp
- that's outside the appBase for its Host.
-
Not supported in AS7
Maximum size of the static resource cache in kilobytes. =
- If not specified, the default value is 10240
- (10 megabytes).
10240
+ (10 megabytes) is used in AS7.
Amount of time in milliseconds between cache entries revalidati=
on.
- If not specified, the default value is 5000
=
- (5 seconds).
5000
=
+ (5 seconds) is used in AS7.
If the value of this flag is true
, the cache for s=
tatic
- resources will be used. If not specified, the default value
- of the flag is true
.
true
is used in AS7.
NOTE: This flag MUST NOT be set to false on the Windows plat= form (or any other OS which does not have a case sensitive filesystem), as it will disable case sensitivity checks, allowing JSP source co= de - disclosure, among other security problems.
+ disclosure, among other security problems. + The default valuetrue
is used in AS7.
Whether the context should process TLDs on startup. The default is true. The false setting is intended for special cases - that know in advance TLDs are not part of the webapp.
+ that know in advance TLDs are not part of the webapp. + The default valuetrue
is used in AS7.
If the value of this flag is true
, the bytes outpu=
t to
- System.out and System.err by the web application will be redirecte=
d to
- the web application logger. If not specified, the default value
- of the flag is false
.
Not supported in AS7. The outputs go to server.log file
If the value of this flag is true
, the TLD files
- XML validation will be namespace-aware. If you turn this flag on,
- you should probably also turn tldValidation
on. The
- default value for this flag is false
, and setting it
- to true will incur a performance penalty.
-
Not supported in AS7
If the value of this flag is true
, the TLD files
- will be XML validated on context startup. The default value for
- this flag is false
, and setting it to true will incur
- a performance penalty.
Not supported in AS7
Amount of ms that the container will wait for servlets to unloa=
d.
- If not specified, the default value of the flag is 2000 =
- ms.
Not supported in AS7
If true, JBoss Web will unpack all compressed web applications =
before
- running them.
- If not specified, the default value is true
.
Not supported in AS7
+AS7 will unpack all compressed web applications before + running them.
Set to true
(the default) to have Catalina enable a
- JNDI InitialContext
for this web application that is
- compatible with Java2 Enterprise Edition (J2EE) platform
- conventions.
Not supported in AS7
java.io.File
) named
javax.servlet.context.tempdir
as described in the
- Servlet Specification. If not specified, a suitable directory
- underneath $CATALINA_HOME/work
will be provided.
+ Servlet Specification.
+ In AS7 something like standalone/tmp/work/jboss.web
i=
s used.
You can nest at most one instance of the following utility components - by nesting a corresponding element inside your Context - element:
-A context is associated with the =
- org.apache.catalina.core.ContainerBase.[enginename].[hostname=
].[path]
- log category. Note that the brackets are actually part of the name=
, don't omit them.
In AS7 most of the feature of context.xml
are now in <=
code>jboss-web.xml.
+ See jboss-web.xml for more i=
nformation.
When you run a web server, one of the output files normally generat= ed - is an access log, which generates one line of information for - each request processed by the server, in a standard format. Catalina - includes an optional Valve implementation t= hat - can create access logs in the same standard format created by web serv= ers, - or in any number of custom formats.
- -You can ask Catalina to create an access log for all requests - processed by an Engine, - Host, or Context - by nesting a Valve element like this:
- -See Access Log Valve - for more information on the configuration attributes that are - supported.
- -If you use the standard Context implementation, - the following configuration steps occur automtically when Catalina - is started, or whenever this web application is reloaded. No special - configuration is required to enable this feature.
- = -conf/web.xml
- will be processed as defaults for this web application. This is u=
sed
- to establish default mappings (such as mapping the *.jsp
- extension to the corresponding JSP servlet), and other standard
- features that apply to all web applications.
/WEB-INF/web.xml
resource for this web application
- will be processed (if this resource exists).You can configure named values that will be made visible to the
- web application as servlet context initialization parameters by nesting
- <Parameter>
elements inside this element. For
- example, you can create an initialization parameter like this:
This is equivalent to the inclusion of the following element in the
- web application deployment descriptor (/WEB-INF/web.xml
):
-
but does not require modification of the deployment descri= ptor - to customize this value.
- -The valid attributes for a <Parameter>
element
- are as follows:
Optional, human-readable description of this context - initialization parameter.
-The name of the context initialization parameter to be created.=
-Set this to false
if you do not w=
ant
- a <context-param>
for the same parameter name,
- found in the web application deployment descriptor, to override the
- value specified here. By default, overrides are allowed.
The parameter value that will be presented to the application
- when requested by calling
- ServletContext.getInitParameter()
.
You can configure named values that will be made visible to the
- web application as environment entry resources, by nesting
- <Environment>
entries inside this element. For
- example, you can create an environment entry like this:
This is equivalent to the inclusion of the following element in the
- web application deployment descriptor (/WEB-INF/web.xml
):
-
but does not require modification of the deployment descri= ptor - to customize this value.
- -The valid attributes for an <Environment>
element
- are as follows:
Optional, human-readable description of this environment entry.=
-The name of the environment entry to be created, relative to the
- java:comp/env
context.
Set this to false
if you do not w=
ant
- an <env-entry>
for the same environment entry n=
ame,
- found in the web application deployment descriptor, to override the
- value specified here. By default, overrides are allowed.
The fully qualified Java class name expected by the web applica=
tion
- for this environment entry. Must be one of the legal values for
- <env-entry-type>
in the web application deploym=
ent
- descriptor: java.lang.Boolean
,
- java.lang.Byte
, java.lang.Character
,
- java.lang.Double
, java.lang.Float
,
- java.lang.Integer
, java.lang.Long
,
- java.lang.Short
, or java.lang.String
.
The parameter value that will be presented to the application
- when requested from the JNDI context. This value must be converta=
ble
- to the Java type defined by the type
attribute.
If you have implemented a Java object that needs to know when this
- Context is started or stopped, you can declare it by
- nesting a Listener element inside this element. The
- class name you specify must implement the
- org.apache.catalina.LifecycleListener
interface, and
- it will be notified about the occurrence of the coresponding
- lifecycle events. Configuration of such a listener looks like this:=
p>
-
-
Note that a Listener can have any number of additional properties - that may be configured from this element. Attribute names are matched - to corresponding JavaBean property names using the standard property - method naming patterns.
- -You can ask Catalina to check the IP address, or host name, on every - incoming request directed to the surrounding - Engine, Host, or - Context element. The remote address or n= ame - will be checked against a configured list of "accept" and/or "deny" - filters, which are defined using the Regular Expression syntax support= ed - by the Jakarta Regexp - regular expression library. Requests that come from locations that are - not accepted will be rejected with an HTTP "Forbidden" error. - Example filter declarations:
- -See Remote Address Fil= ter - and Remote Host Filter f= or - more information about the configuration options that are supported.= p> - -
You can declare the characteristics of the resource
- to be returned for JNDI lookups of <resource-ref>
a=
nd
- <resource-env-ref>
elements in the web application
- deployment descriptor. You MUST also define
- the needed resource parameters as attributes of the Resource =
- element, to configure the object factory to be used (if not known to J=
Boss Web =
- already), and the properties used to configure that object factory.
For example, you can create a resource definition like this:
-This is equivalent to the inclusion of the following element in the
- web application deployment descriptor (/WEB-INF/web.xml
):=
but does not require modification of the deployment - descriptor to customize this value.
- -The valid attributes for a <Resource>
element
- are as follows:
Specify whether the web Application code signs on to the
- corresponding resource manager programatically, or whether the
- Container will sign on to the resource manager on behalf of the
- application. The value of this attribute must be
- Application
or Container
. This
- attribute is required if the web application
- will use a <resource-ref>
element in the web
- application deployment descriptor, but is optional if the
- application uses a <resource-env-ref>
instead.<=
/p>
-
Optional, human-readable description of this resource.
-The name of the resource to be created, relative to the
- java:comp/env
context.
Specify whether connections obtained through this resource
- manager can be shared. The value of this attribute must be
- Shareable
or Unshareable
. By default,
- connections are assumed to be shareable.
The fully qualified Java class name expected by the web - application when it performs a lookup for this resource.
-This element is used to create a link to a global JNDI resource. D= oing - a JNDI lookup on the link name will then return the linked global = - resource.
- -For example, you can create a resource link like this:
-The valid attributes for a <ResourceLink>
element
- are as follows:
The name of the linked global resource in the = - global JNDI context.
-The name of the resource link to be created, relative to the
- java:comp/env
context.
The fully qualified Java class name expected by the web - application when it performs a lookup for this resource link.
-You can declare the characteristics of the UserTransaction
- to be returned for JNDI lookup for java:comp/UserTransaction. =
- You MUST define an object factory class to instantiate
- this object as well as the needed resource parameters as attributes of=
the =
-
Transaction
=
- element, and the properties used to configure that object factory.
The valid attributes for the <Transaction>
eleme=
nt
- are as follows:
The class name for the JNDI object factory.
-