Author: alex.guizar(a)jboss.com Date: 2010-11-23 22:16:00 -0500 (Tue, 23 Nov 2010) New Revision: 6839 Modified: projects/jsf-console/branches/jsf-console-3.2-soa/console-jee5/src/main/webapp/WEB-INF/jboss-web.xml projects/jsf-console/branches/jsf-console-3.2-soa/console-jee5/src/main/webapp/WEB-INF/web.xml projects/jsf-console/branches/jsf-console-3.2-soa/console-tomcat/src/main/webapp/WEB-INF/web.xml projects/jsf-console/branches/jsf-console-3.2-soa/console/src/main/webapp/WEB-INF/jboss-web.xml projects/jsf-console/branches/jsf-console-3.2-soa/console/src/main/webapp/WEB-INF/web.xml Log: rephrase comments in web deployment descriptors Modified: projects/jsf-console/branches/jsf-console-3.2-soa/console/src/main/webapp/WEB-INF/jboss-web.xml =================================================================== --- projects/jsf-console/branches/jsf-console-3.2-soa/console/src/main/webapp/WEB-INF/jboss-web.xml 2010-11-23 13:45:16 UTC (rev 6838) +++ projects/jsf-console/branches/jsf-console-3.2-soa/console/src/main/webapp/WEB-INF/jboss-web.xml 2010-11-24 03:16:00 UTC (rev 6839) @@ -1,6 +1,5 @@ <?xml version="1.0" encoding="UTF-8"?> -<!DOCTYPE jboss-web PUBLIC - "-//JBoss//DTD Web Application 2.4//EN" +<!DOCTYPE jboss-web PUBLIC "-//JBoss//DTD Web Application 2.4//EN" "http://www.jboss.org/j2ee/dtd/jboss-web_4_0.dtd"> <jboss-web> @@ -30,5 +29,4 @@ <message-destination-ref-name>jms/JobQueue</message-destination-ref-name> <jndi-name>queue/JbpmJobQueue</jndi-name> </message-destination-ref> - </jboss-web> Modified: projects/jsf-console/branches/jsf-console-3.2-soa/console/src/main/webapp/WEB-INF/web.xml =================================================================== --- projects/jsf-console/branches/jsf-console-3.2-soa/console/src/main/webapp/WEB-INF/web.xml 2010-11-23 13:45:16 UTC (rev 6838) +++ projects/jsf-console/branches/jsf-console-3.2-soa/console/src/main/webapp/WEB-INF/web.xml 2010-11-24 03:16:00 UTC (rev 6839) @@ -2,28 +2,27 @@ <web-app version="2.4" xmlns="http://java.sun.com/xml/ns/j2ee" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://java.sun.com/xml/ns/j2ee http://java.sun.com/xml/ns/j2ee/web-app_2_4.xsd"> - <servlet> - <description>Enable the JSF servlet. See faces-config.xml for Faces-specific configuration.</description> + <description>Enable the JSF servlet, see also faces-config.xml</description> <servlet-name>Faces Servlet</servlet-name> <servlet-class>javax.faces.webapp.FacesServlet</servlet-class> <load-on-startup>1</load-on-startup> </servlet> - <!-- Mapping for all plain pages. --> + <!-- Mapping for all plain pages --> <servlet-mapping> <servlet-name>Faces Servlet</servlet-name> <url-pattern>*.jsf</url-pattern> </servlet-mapping> - <!-- This mapping is for the process images. --> + <!-- This mapping is for the process images --> <servlet-mapping> <servlet-name>Faces Servlet</servlet-name> <url-pattern>/app/pi/*</url-pattern> </servlet-mapping> <context-param> - <description>Use Documents Saved as *.xhtml</description> + <description>Use documents saved as *.xhtml</description> <param-name>javax.faces.DEFAULT_SUFFIX</param-name> <param-value>.xhtml</param-value> </context-param> @@ -34,15 +33,12 @@ <param-value>false</param-value> </context-param> - <!-- A simple JSP to redirect to the basic search page. --> + <!-- Redirection to the basic search page --> <welcome-file-list> <welcome-file>index.jsp</welcome-file> </welcome-file-list> - <!-- - This role list should be changed to include all the relevant roles for your - environment. - --> + <!-- This role list can be adjusted to the target environment. --> <security-role> <role-name>admin</role-name> </security-role> @@ -51,9 +47,8 @@ </security-role> <!-- - Security constraints - optionally customize the role name to require a login - before access is allowed. Also, be sure to edit jboss-web.xml to configure - the security domain if you are deploying inside JBoss AS. + Security constraints. Optionally change the role name required to gain access. + Edit jboss-web.xml to set the security domain if you are deploying to JBoss AS. --> <security-constraint> <web-resource-collection> @@ -65,7 +60,7 @@ </auth-constraint> </security-constraint> - <!-- Example Login page - lists sample users --> + <!-- Example login page --> <login-config> <auth-method>FORM</auth-method> <form-login-config> @@ -73,8 +68,9 @@ <form-error-page>/ua/login-example.jsf?error=true</form-error-page> </form-login-config> </login-config> + <!-- Example login page --> - <!-- Login configuration option #1 - use the login page ==> + <!-- Form-based authentication === <login-config> <auth-method>FORM</auth-method> <form-login-config> @@ -82,43 +78,39 @@ <form-error-page>/ua/login.jsf?error=true</form-error-page> </form-login-config> </login-config> - <!== Login configuration option #1 --> + ==== Form-based authentication --> - <!-- Login configuration option #2 - use basic auth ==> + <!-- Basic authentication === <login-config> <auth-method>BASIC</auth-method> <realm-name>jBPM Administration Console</realm-name> </login-config> - <!== Login configuration option #2 --> + ==== Basic authentication --> - <!-- Job executor launcher ==> + <!-- Job executor launcher === <listener> - <description> - Starts the job executor on initialization and stops it on destruction. - </description> + <description>Starts and stops the job executor.</description> <listener-class>org.jbpm.web.JobExecutorLauncher</listener-class> </listener> - <!== Job executor launcher --> + ==== Job executor launcher --> <listener> - <description>Closes the jBPM configuration on destruction, releasing resources. - This listener should appear after the job executor launcher, - to avoid reopening the configuration.</description> + <description>Closes the jBPM configuration. If the job executor launcher is present, this + listener must appear after it, to avoid reopening the configuration.</description> <listener-class>org.jbpm.web.JbpmConfigurationCloser</listener-class> </listener> <resource-ref> - <description>Logical name of the data source that provides connections to the persistence service. - Must match the hibernate.connection.datasource property in the Hibernate - configuration file.</description> + <description>Data source providing JDBC connections to the persistence service. Must match + the connection.datasource property in the Hibernate configuration.</description> <res-ref-name>jdbc/JbpmDataSource</res-ref-name> <res-type>javax.sql.DataSource</res-type> <res-auth>Container</res-auth> </resource-ref> <resource-ref> - <description>Logical name of the factory that provides JMS connections to the message service. - Required for processes that contain asynchronous continuations.</description> + <description>Factory providing JMS connections to the message service. Required for + processes that contain asynchronous continuations.</description> <res-ref-name>jms/JbpmConnectionFactory</res-ref-name> <res-type>javax.jms.ConnectionFactory</res-type> <res-auth>Container</res-auth> @@ -134,11 +126,10 @@ </ejb-local-ref> <message-destination-ref> - <description>The message service sends job messages to the queue referenced here. - This must be the same queue from which the JobListenerBean receives messages.</description> + <description>The message service sends job messages to the queue referenced here. Must match + the queue from which JobListenerBean receives messages.</description> <message-destination-ref-name>jms/JobQueue</message-destination-ref-name> <message-destination-type>javax.jms.Queue</message-destination-type> <message-destination-usage>Produces</message-destination-usage> </message-destination-ref> - </web-app> Modified: projects/jsf-console/branches/jsf-console-3.2-soa/console-jee5/src/main/webapp/WEB-INF/jboss-web.xml =================================================================== --- projects/jsf-console/branches/jsf-console-3.2-soa/console-jee5/src/main/webapp/WEB-INF/jboss-web.xml 2010-11-23 13:45:16 UTC (rev 6838) +++ projects/jsf-console/branches/jsf-console-3.2-soa/console-jee5/src/main/webapp/WEB-INF/jboss-web.xml 2010-11-24 03:16:00 UTC (rev 6839) @@ -1,6 +1,6 @@ <?xml version="1.0" encoding="UTF-8"?> -<!DOCTYPE jboss-web PUBLIC "-//JBoss//DTD Web Application 2.4//EN" - "http://www.jboss.org/j2ee/dtd/jboss-web_4_0.dtd"> +<!DOCTYPE jboss-web PUBLIC "-//JBoss//DTD Web Application 5.0//EN" + "http://www.jboss.org/j2ee/dtd/jboss-web_5_0.dtd"> <jboss-web> <!-- Modified: projects/jsf-console/branches/jsf-console-3.2-soa/console-jee5/src/main/webapp/WEB-INF/web.xml =================================================================== --- projects/jsf-console/branches/jsf-console-3.2-soa/console-jee5/src/main/webapp/WEB-INF/web.xml 2010-11-23 13:45:16 UTC (rev 6838) +++ projects/jsf-console/branches/jsf-console-3.2-soa/console-jee5/src/main/webapp/WEB-INF/web.xml 2010-11-24 03:16:00 UTC (rev 6839) @@ -1,9 +1,8 @@ <?xml version="1.0" encoding="UTF-8"?> -<web-app version="2.4" xmlns="http://java.sun.com/xml/ns/j2ee" - xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" - xsi:schemaLocation="http://java.sun.com/xml/ns/j2ee http://java.sun.com/xml/ns/j2ee/web-app_2_4.xsd"> +<web-app version="2.5" xmlns="http://java.sun.com/xml/ns/javaee" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" + xsi:schemaLocation="http://java.sun.com/xml/ns/javaee/web-app_2_5.xs... <servlet> - <description>Enable the JSF servlet. See faces-config.xml for Faces-specific configuration.</description> + <description>Enable the JSF servlet, see also faces-config.xml</description> <servlet-name>Faces Servlet</servlet-name> <servlet-class>javax.faces.webapp.FacesServlet</servlet-class> <load-on-startup>1</load-on-startup> @@ -22,7 +21,7 @@ </servlet-mapping> <context-param> - <description>Use Documents Saved as *.xhtml</description> + <description>Use documents saved as *.xhtml</description> <param-name>javax.faces.DEFAULT_SUFFIX</param-name> <param-value>.xhtml</param-value> </context-param> @@ -33,15 +32,12 @@ <param-value>false</param-value> </context-param> - <!-- A simple JSP to redirect to the basic search page --> + <!-- Redirection to the basic search page --> <welcome-file-list> <welcome-file>index.jsp</welcome-file> </welcome-file-list> - <!-- - This role list should be changed to include all the relevant roles for your - environment. - --> + <!-- This role list can be adjusted to the target environment. --> <security-role> <role-name>admin</role-name> </security-role> @@ -50,9 +46,8 @@ </security-role> <!-- - Security constraints - optionally customize the role name to require a login - before access is allowed. Also, be sure to edit jboss-web.xml to configure - the security domain if you are deploying inside JBoss AS. + Security constraints. Optionally change the role name required to gain access. + Edit jboss-web.xml to set the security domain if you are deploying to JBoss AS. --> <security-constraint> <web-resource-collection> @@ -64,7 +59,7 @@ </auth-constraint> </security-constraint> - <!-- Example Login page - lists sample users --> + <!-- Example login page --> <login-config> <auth-method>FORM</auth-method> <form-login-config> @@ -72,8 +67,9 @@ <form-error-page>/ua/login-example.jsf?error=true</form-error-page> </form-login-config> </login-config> + <!-- Example login page --> - <!-- Login configuration option #1 - use the login page ==> + <!-- Form-based authentication === <login-config> <auth-method>FORM</auth-method> <form-login-config> @@ -81,53 +77,46 @@ <form-error-page>/ua/login.jsf?error=true</form-error-page> </form-login-config> </login-config> - <!== Login configuration option #1 --> + ==== Form-based authentication --> - <!-- Login configuration option #2 - use basic auth ==> + <!-- Basic authentication === <login-config> <auth-method>BASIC</auth-method> <realm-name>jBPM Administration Console</realm-name> </login-config> - <!== Login configuration option #2 --> + ==== Basic authentication --> - <!-- Job executor launcher ==> + <!-- Job executor launcher === <listener> - <description> - Starts the job executor on initialization and stops it on destruction. - </description> + <description>Starts and stops the job executor.</description> <listener-class>org.jbpm.web.JobExecutorLauncher</listener-class> </listener> - <!== Job executor launcher --> + ==== Job executor launcher --> <listener> - <description>Closes the jBPM configuration on destruction, releasing resources. - This listener should appear after the job executor launcher, - to avoid reopening the configuration.</description> + <description>Closes the jBPM configuration. If the job executor launcher is present, this + listener must appear after it, to avoid reopening the configuration.</description> <listener-class>org.jbpm.web.JbpmConfigurationCloser</listener-class> </listener> <resource-ref> - <description>Logical name of the data source that provides connections to the persistence service. - Must match the hibernate.connection.datasource property in the Hibernate - configuration file.</description> + <description>Data source providing JDBC connections to the persistence service. Must match + the connection.datasource property in the Hibernate configuration.</description> <res-ref-name>jdbc/JbpmDataSource</res-ref-name> <res-type>javax.sql.DataSource</res-type> - <res-auth>Container</res-auth> </resource-ref> <resource-ref> - <description>Logical name of the factory that provides JMS connections to the message service. - Required for processes that contain asynchronous continuations.</description> + <description>Factory providing JMS connections to the message service. Required for + processes that contain asynchronous continuations.</description> <res-ref-name>jms/JbpmConnectionFactory</res-ref-name> <res-type>javax.jms.ConnectionFactory</res-type> - <res-auth>Container</res-auth> </resource-ref> <message-destination-ref> - <description>The message service sends job messages to the queue referenced here. - This must be the same queue from which the JobListenerBean receives messages.</description> + <description>The message service sends job messages to the queue referenced here. Must match + the queue from which JobListenerBean receives messages.</description> <message-destination-ref-name>jms/JobQueue</message-destination-ref-name> <message-destination-type>javax.jms.Queue</message-destination-type> - <message-destination-usage>Produces</message-destination-usage> </message-destination-ref> </web-app> Modified: projects/jsf-console/branches/jsf-console-3.2-soa/console-tomcat/src/main/webapp/WEB-INF/web.xml =================================================================== --- projects/jsf-console/branches/jsf-console-3.2-soa/console-tomcat/src/main/webapp/WEB-INF/web.xml 2010-11-23 13:45:16 UTC (rev 6838) +++ projects/jsf-console/branches/jsf-console-3.2-soa/console-tomcat/src/main/webapp/WEB-INF/web.xml 2010-11-24 03:16:00 UTC (rev 6839) @@ -3,7 +3,7 @@ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://java.sun.com/xml/ns/j2ee http://java.sun.com/xml/ns/j2ee/web-app_2_4.xsd"> <servlet> - <description>Enable the JSF servlet. See faces-config.xml for Faces-specific configuration.</description> + <description>Enable the JSF servlet, see also faces-config.xml</description> <servlet-name>Faces Servlet</servlet-name> <servlet-class>javax.faces.webapp.FacesServlet</servlet-class> <load-on-startup>1</load-on-startup> @@ -22,7 +22,7 @@ </servlet-mapping> <context-param> - <description>Use Documents Saved as *.xhtml</description> + <description>Use documents saved as *.xhtml</description> <param-name>javax.faces.DEFAULT_SUFFIX</param-name> <param-value>.xhtml</param-value> </context-param> @@ -33,15 +33,12 @@ <param-value>false</param-value> </context-param> - <!-- A simple JSP to redirect to the basic search page --> + <!-- Redirection to the basic search page --> <welcome-file-list> <welcome-file>index.jsp</welcome-file> </welcome-file-list> - <!-- - This role list should be changed to include all the relevant roles for your - environment. - --> + <!-- This role list can be adjusted to the target environment. --> <security-role> <role-name>admin</role-name> </security-role> @@ -50,9 +47,8 @@ </security-role> <!-- - Security constraints - optionally customize the role name to require a login - before access is allowed. Also, be sure to edit jboss-web.xml to configure - the security domain if you are deploying inside JBoss AS. + Security constraints. Optionally change the role name required to gain access. + Edit context.xml to configure the authentication realm if you are deploying to Tomcat. --> <security-constraint> <web-resource-collection> @@ -64,7 +60,7 @@ </auth-constraint> </security-constraint> - <!-- Example Login page - lists sample users --> + <!-- Example login page --> <login-config> <auth-method>FORM</auth-method> <form-login-config> @@ -72,8 +68,9 @@ <form-error-page>/ua/login-example.jsf?error=true</form-error-page> </form-login-config> </login-config> + <!-- Example login page --> - <!-- Login configuration option #1 - use the login page ==> + <!-- Form-based authentication === <login-config> <auth-method>FORM</auth-method> <form-login-config> @@ -81,35 +78,31 @@ <form-error-page>/ua/login.jsf?error=true</form-error-page> </form-login-config> </login-config> - <!== Login configuration option #1 --> + ==== Form-based authentication --> - <!-- Login configuration option #2 - use basic auth ==> + <!-- Basic authentication === <login-config> <auth-method>BASIC</auth-method> <realm-name>jBPM Administration Console</realm-name> </login-config> - <!== Login configuration option #2 --> + ==== Basic authentication --> <!-- Job executor launcher --> <listener> - <description> - Starts the job executor on initialization and stops it on destruction. - </description> + <description>Starts and stops the job executor.</description> <listener-class>org.jbpm.web.JobExecutorLauncher</listener-class> </listener> <!-- Job executor launcher --> <listener> - <description>Closes the jBPM configuration on destruction, releasing resources. - This listener should appear after the job executor launcher, - to avoid reopening the configuration.</description> + <description>Closes the jBPM configuration. If the job executor launcher is present, this + listener must appear after it, to avoid reopening the configuration.</description> <listener-class>org.jbpm.web.JbpmConfigurationCloser</listener-class> </listener> <resource-ref> - <description>Logical name of the data source that provides connections to the persistence service. - Must match the hibernate.connection.datasource property in the Hibernate - configuration file.</description> + <description>Data source providing JDBC connections to the persistence service. Must match + the connection.datasource property in the Hibernate configuration.</description> <res-ref-name>jdbc/JbpmDataSource</res-ref-name> <res-type>javax.sql.DataSource</res-type> <res-auth>Container</res-auth>