Skip to content

Commit

Permalink
minor changes
Browse files Browse the repository at this point in the history
  • Loading branch information
bertocco committed Mar 11, 2016
1 parent 78c48d3 commit 76748e2
Show file tree
Hide file tree
Showing 2 changed files with 321 additions and 1 deletion.
2 changes: 1 addition & 1 deletion en-US/AC_UsersGuide.xml
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
<!--
<xi:include href="Revision_History.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
-->
<xi:include href="web.xml.appendix.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="webdescriptor.appendix.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="build_script.appendix.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<index />
</book>
Expand Down
320 changes: 320 additions & 0 deletions en-US/webdescriptor.appendix.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,320 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE appendix PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!ENTITY PRODUCT "Documentation">
<!ENTITY BOOKID "ACUsersGuide">
<!ENTITY YEAR "2016">
<!ENTITY HOLDER "| You need to change the HOLDER entity in the en-US/AC_UsersGuide.ent file |">
]>
<appendix>
<title>web.xml file descriptor content</title>
<para>
This appendix provide an example of deployment file descriptoe web.xml.
<screen>
&lt;?xml version="1.0" encoding="UTF-8"?&gt;

&lt;!--
************************************************************************
******************* CANADIAN ASTRONOMY DATA CENTRE *******************
************** CENTRE CANADIEN DE DONNÉES ASTRONOMIQUES **************
*
* (c) 2010. (c) 2010.
* Government of Canada Gouvernement du Canada
* National Research Council Conseil national de recherches
* Ottawa, Canada, K1A 0R6 Ottawa, Canada, K1A 0R6
* All rights reserved Tous droits réservés
*
* NRC disclaims any warranties, Le CNRC dénie toute garantie
* expressed, implied, or énoncée, implicite ou légale,
* statutory, of any kind with de quelque nature que ce
* respect to the software, soit, concernant le logiciel,
* including without limitation y compris sans restriction
* any warranty of merchantability toute garantie de valeur
* or fitness for a particular marchande ou de pertinence
* purpose. NRC shall not be pour un usage particulier.
* liable in any event for any Le CNRC ne pourra en aucun cas
* damages, whether direct or être tenu responsable de tout
* indirect, special or general, dommage, direct ou indirect,
* consequential or incidental, particulier ou général,
* arising from the use of the accessoire ou fortuit, résultant
* software. Neither the name de l'utilisation du logiciel. Ni
* of the National Research le nom du Conseil National de
* Council of Canada nor the Recherches du Canada ni les noms
* names of its contributors may de ses participants ne peuvent
* be used to endorse or promote être utilisés pour approuver ou
* products derived from this promouvoir les produits dérivés
* software without specific prior de ce logiciel sans autorisation
* written permission. préalable et particulière
* par écrit.
*
* This file is part of the Ce fichier fait partie du projet
* OpenCADC project. OpenCADC.
*
* OpenCADC is free software: OpenCADC est un logiciel libre ;
* you can redistribute it and/or vous pouvez le redistribuer ou le
* modify it under the terms of modifier suivant les termes de
* the GNU Affero General Public la “GNU Affero General Public
* License as published by the License” telle que publiée
* Free Software Foundation, par la Free Software Foundation
* either version 3 of the : soit la version 3 de cette
* License, or (at your option) licence, soit (à votre gré)
* any later version. toute version ultérieure.
*
* OpenCADC is distributed in the OpenCADC est distribué
* hope that it will be useful, dans l’espoir qu’il vous
* but WITHOUT ANY WARRANTY; sera utile, mais SANS AUCUNE
* without even the implied GARANTIE : sans même la garantie
* warranty of MERCHANTABILITY implicite de COMMERCIALISABILITÉ
* or FITNESS FOR A PARTICULAR ni d’ADÉQUATION À UN OBJECTIF
* PURPOSE. See the GNU Affero PARTICULIER. Consultez la Licence
* General Public License for Générale Publique GNU Affero
* more details. pour plus de détails.
*
* You should have received Vous devriez avoir reçu une
* a copy of the GNU Affero copie de la Licence Générale
* General Public License along Publique GNU Affero avec
* with OpenCADC. If not, see OpenCADC ; si ce n’est
* &lt;http://www.gnu.org/licenses/&gt;. pas le cas, consultez :
* &lt;http://www.gnu.org/licenses/&gt;.
*
************************************************************************
--&gt;
&lt;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 http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd"&gt;

&lt;display-name&gt;ac_ws&lt;/display-name&gt;

&lt;!--
The Servlets to handle Requests.
--&gt;
&lt;servlet&gt;
&lt;servlet-name&gt;GroupServlet&lt;/servlet-name&gt;
&lt;servlet-class&gt;ca.nrc.cadc.ac.server.web.GroupServlet&lt;/servlet-class&gt;
&lt;load-on-startup&gt;2&lt;/load-on-startup&gt;
&lt;/servlet&gt;

&lt;servlet&gt;
&lt;servlet-name&gt;UserServlet&lt;/servlet-name&gt;
&lt;servlet-class&gt;ca.nrc.cadc.ac.server.web.UserServlet&lt;/servlet-class&gt;

&lt;!-- The following two lists of principal names must be of the same
length and correspond to each other in order. Users who do augment
subject calls are constructed by taking the principals out of these
lists in order. Principal names are separated by spaces.--&gt;
&lt;init-param&gt;
&lt;param-name&gt;ca.nrc.cadc.ac.server.web.UserServlet.NotAugmentedX500Principals&lt;/param-name&gt;
&lt;param-value&gt;a_user_dn&lt;/param-value&gt;
&lt;/init-param&gt;
&lt;init-param&gt;
&lt;param-name&gt;ca.nrc.cadc.ac.server.web.UserServlet.NotAugmentedHttpPrincipals&lt;/param-name&gt;
&lt;param-value&gt;srvops dataops&lt;/param-value&gt;
&lt;/init-param&gt;
&lt;load-on-startup&gt;2&lt;/load-on-startup&gt;
&lt;/servlet&gt;

&lt;servlet&gt;
&lt;servlet-name&gt;LoginServlet&lt;/servlet-name&gt;
&lt;servlet-class&gt;ca.nrc.cadc.ac.server.web.LoginServlet&lt;/servlet-class&gt;
&lt;!-- users in the proxyGroup can impersonate other users except users that are
members of the nonImpersonGroup --&gt;
&lt;init-param&gt;
&lt;param-name&gt;ca.nrc.cadc.ac.server.web.LoginServlet.proxyGroup&lt;/param-name&gt;
&lt;param-value&gt;CADC&lt;/param-value&gt;
&lt;/init-param&gt;
&lt;init-param&gt;
&lt;param-name&gt;ca.nrc.cadc.ac.server.web.LoginServlet.nonImpersonGroup&lt;/param-name&gt;
&lt;param-value&gt;CADC&lt;/param-value&gt;
&lt;/init-param&gt;

&lt;load-on-startup&gt;3&lt;/load-on-startup&gt;
&lt;/servlet&gt;

&lt;servlet&gt;
&lt;servlet-name&gt;PasswordServlet&lt;/servlet-name&gt;
&lt;servlet-class&gt;ca.nrc.cadc.ac.server.web.PasswordServlet&lt;/servlet-class&gt;

&lt;load-on-startup&gt;3&lt;/load-on-startup&gt;
&lt;/servlet&gt;

&lt;servlet&gt;
&lt;servlet-name&gt;WhoAmIServlet&lt;/servlet-name&gt;
&lt;servlet-class&gt;ca.nrc.cadc.ac.server.web.WhoAmIServlet&lt;/servlet-class&gt;

&lt;load-on-startup&gt;3&lt;/load-on-startup&gt;
&lt;/servlet&gt;

&lt;!-- sync ac search servlet--&gt;
&lt;servlet&gt;
&lt;servlet-name&gt;ACSearchServlet&lt;/servlet-name&gt;
&lt;servlet-class&gt;ca.nrc.cadc.uws.server.SyncServlet&lt;/servlet-class&gt;
&lt;init-param&gt;
&lt;param-name&gt;ca.nrc.cadc.uws.server.SyncServlet.execOnGET&lt;/param-name&gt;
&lt;param-value&gt;true&lt;/param-value&gt;
&lt;/init-param&gt;
&lt;init-param&gt;
&lt;param-name&gt;ca.nrc.cadc.uws.server.SyncServlet.execOnPOST&lt;/param-name&gt;
&lt;param-value&gt;true&lt;/param-value&gt;
&lt;/init-param&gt;
&lt;init-param&gt;
&lt;param-name&gt;ca.nrc.cadc.uws.server.JobManager&lt;/param-name&gt;
&lt;param-value&gt;ca.nrc.cadc.ac.server.web.ACSearchJobManager&lt;/param-value&gt;
&lt;/init-param&gt;
&lt;load-on-startup&gt;2&lt;/load-on-startup&gt;
&lt;/servlet&gt;

&lt;servlet&gt;
&lt;servlet-name&gt;AvailabilityServlet&lt;/servlet-name&gt;
&lt;servlet-class&gt;ca.nrc.cadc.vosi.AvailabilityServlet&lt;/servlet-class&gt;
&lt;init-param&gt;
&lt;param-name&gt;ca.nrc.cadc.vosi.WebService&lt;/param-name&gt;
&lt;param-value&gt;ca.nrc.cadc.ac.server.web.ServiceAvailability&lt;/param-value&gt;
&lt;/init-param&gt;
&lt;load-on-startup&gt;3&lt;/load-on-startup&gt;
&lt;/servlet&gt;

&lt;servlet&gt;
&lt;!--
To make sure the logging level gets set before any
logging gets done, set load-on-startup to a smaller
whole number than is used for any other servlet
in this webapp. This assumes Tomcat 5.5 or later.
--&gt;
&lt;servlet-name&gt;logControl&lt;/servlet-name&gt;
&lt;servlet-class&gt;ca.nrc.cadc.log.LogControlServlet&lt;/servlet-class&gt;
&lt;init-param&gt;
&lt;param-name&gt;logLevel&lt;/param-name&gt;
&lt;param-value&gt;info&lt;/param-value&gt;
&lt;/init-param&gt;
&lt;init-param&gt;
&lt;param-name&gt;logLevelPackages&lt;/param-name&gt;
&lt;param-value&gt;
ca.nrc.cadc.auth
ca.nrc.cadc.ac
ca.nrc.cadc.vosi
&lt;/param-value&gt;
&lt;/init-param&gt;
&lt;init-param&gt;
&lt;param-name&gt;logAccessGroup&lt;/param-name&gt;
&lt;param-value&gt;CADC&lt;/param-value&gt;
&lt;/init-param&gt;
&lt;init-param&gt;
&lt;param-name&gt;groupAuthorizer&lt;/param-name&gt;
&lt;param-value&gt;ca.nrc.cadc.auth.CADCGroupAuthorizer&lt;/param-value&gt;
&lt;/init-param&gt;
&lt;load-on-startup&gt;1&lt;/load-on-startup&gt;
&lt;/servlet&gt;

&lt;servlet-mapping&gt;
&lt;servlet-name&gt;GroupServlet&lt;/servlet-name&gt;
&lt;url-pattern&gt;/groups/*&lt;/url-pattern&gt;
&lt;/servlet-mapping&gt;

&lt;servlet-mapping&gt;
&lt;servlet-name&gt;GroupServlet&lt;/servlet-name&gt;
&lt;url-pattern&gt;/auth/groups/*&lt;/url-pattern&gt;
&lt;/servlet-mapping&gt;

&lt;servlet-mapping&gt;
&lt;servlet-name&gt;UserServlet&lt;/servlet-name&gt;
&lt;url-pattern&gt;/users/*&lt;/url-pattern&gt;
&lt;/servlet-mapping&gt;

&lt;servlet-mapping&gt;
&lt;servlet-name&gt;UserServlet&lt;/servlet-name&gt;
&lt;url-pattern&gt;/auth/users/*&lt;/url-pattern&gt;
&lt;/servlet-mapping&gt;

&lt;servlet-mapping&gt;
&lt;servlet-name&gt;LoginServlet&lt;/servlet-name&gt;
&lt;url-pattern&gt;/login&lt;/url-pattern&gt;
&lt;/servlet-mapping&gt;

&lt;servlet-mapping&gt;
&lt;servlet-name&gt;PasswordServlet&lt;/servlet-name&gt;
&lt;url-pattern&gt;/password&lt;/url-pattern&gt;
&lt;/servlet-mapping&gt;

&lt;servlet-mapping&gt;
&lt;servlet-name&gt;PasswordServlet&lt;/servlet-name&gt;
&lt;url-pattern&gt;/auth/password&lt;/url-pattern&gt;
&lt;/servlet-mapping&gt;

&lt;servlet-mapping&gt;
&lt;servlet-name&gt;ACSearchServlet&lt;/servlet-name&gt;
&lt;url-pattern&gt;/search/*&lt;/url-pattern&gt;
&lt;/servlet-mapping&gt;

&lt;servlet-mapping&gt;
&lt;servlet-name&gt;ACSearchServlet&lt;/servlet-name&gt;
&lt;url-pattern&gt;/auth/search/*&lt;/url-pattern&gt;
&lt;/servlet-mapping&gt;

&lt;servlet-mapping&gt;
&lt;servlet-name&gt;WhoAmIServlet&lt;/servlet-name&gt;
&lt;url-pattern&gt;/whoami&lt;/url-pattern&gt;
&lt;/servlet-mapping&gt;

&lt;servlet-mapping&gt;
&lt;servlet-name&gt;WhoAmIServlet&lt;/servlet-name&gt;
&lt;url-pattern&gt;/auth/whoami&lt;/url-pattern&gt;
&lt;/servlet-mapping&gt;

&lt;!--
The Availability service.
--&gt;
&lt;servlet-mapping&gt;
&lt;servlet-name&gt;AvailabilityServlet&lt;/servlet-name&gt;
&lt;url-pattern&gt;/availability&lt;/url-pattern&gt;
&lt;/servlet-mapping&gt;

&lt;!--
The Log service
--&gt;
&lt;servlet-mapping&gt;
&lt;servlet-name&gt;logControl&lt;/servlet-name&gt;
&lt;url-pattern&gt;/logControl&lt;/url-pattern&gt;
&lt;/servlet-mapping&gt;

&lt;welcome-file-list&gt;
&lt;welcome-file&gt;index.jsp&lt;/welcome-file&gt;
&lt;/welcome-file-list&gt;

&lt;!-- Define the public security role --&gt;
&lt;security-role&gt;
&lt;description&gt;Public security role&lt;/description&gt;
&lt;role-name&gt;public&lt;/role-name&gt;
&lt;/security-role&gt;

&lt;!-- Define a security constraint for auth servlet --&gt;
&lt;security-constraint&gt;
&lt;web-resource-collection&gt;
&lt;web-resource-name&gt;auth&lt;/web-resource-name&gt;
&lt;description/&gt;
&lt;url-pattern&gt;/auth/*&lt;/url-pattern&gt;
&lt;url-pattern&gt;/logControl/*&lt;/url-pattern&gt;
&lt;http-method&gt;GET&lt;/http-method&gt;
&lt;http-method&gt;POST&lt;/http-method&gt;
&lt;http-method&gt;HEAD&lt;/http-method&gt;
&lt;http-method&gt;PUT&lt;/http-method&gt;
&lt;http-method&gt;OPTIONS&lt;/http-method&gt;
&lt;http-method&gt;TRACE&lt;/http-method&gt;
&lt;http-method&gt;DELETE&lt;/http-method&gt;
&lt;/web-resource-collection&gt;
&lt;auth-constraint&gt;
&lt;description&gt;force authentication for all requests&lt;/description&gt;
&lt;role-name&gt;public&lt;/role-name&gt;
&lt;/auth-constraint&gt;
&lt;/security-constraint&gt;

&lt;!--
BASIC Http Authentication for logControl
--&gt;
&lt;login-config&gt;
&lt;auth-method&gt;BASIC&lt;/auth-method&gt;
&lt;realm-name&gt;Canadian Astronomy Data Centre&lt;/realm-name&gt;
&lt;/login-config&gt;
&lt;/web-app&gt;
</screen>
</para>
</appendix>

0 comments on commit 76748e2

Please sign in to comment.