Skip to content
This repository has been archived by the owner on Feb 1, 2019. It is now read-only.

Latest commit

 

History

History
72 lines (54 loc) · 3.2 KB

README-CONDDBWEB.md

File metadata and controls

72 lines (54 loc) · 3.2 KB
Raw

CondDBWeb

Author: A.Formica

Date : 2015/01/01
   Copyright (C) 2015  A.Formica

    This program is free software: you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program.  If not, see <http://www.gnu.org/licenses/>.

Table of Contents

  1. Deployment
  2. List of delivered services
  3. Command examples

Deployment

  • tomcat deployment: mvn clean tomcat7:redeploy In case tomcat container has been started, and provided you have correctly told maven how to access it, the deployment is pretty straightforward. Here is an example of the setting.xml file that should be present in <user_home>/.m2/ :
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<settings xmlns="http://maven.apache.org/SETTINGS/1.1.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/SETTINGS/1.1.0 http://maven.apache.org/xsd/settings-1.1.0.xsd">
  <servers>
        <server>
        <id>TomcatServer</id>
        <username>tomcatuser</username>
        <password>tomcatpassword</password>
        </server>
  </servers>
  <localRepository>/usr/local/maven/repository/</localRepository>
</settings>

  • jetty deployment for testing: mvn -Dspring.profiles.active=jetty,h2 jetty:run Running jetty is even easier, since it can be started directly by maven.

  • wildfly deployment: instruction TO BE COMPLETED For the moment just copy the war file created in ./target into the wildfly deployment directory

Be careful if you are using authentication that the correct profile is set in CATALINA_OPTS or in the web.xml file contained in this module.

List of delivered services

The PhysCondDB/CondDBWeb module delivers a set of RESTful services that can be used to interact with the conditions DB. The present DB structure is described in the module conddb-data . The low level services for DB interactions are defined in conddb-svc . The RESTful services allows data management methods implemented via HTTP protocol. In the following list we describe how to get the documentation on the methods available.

  • Swagger documentation of services. The application uses swagger to document the REST services, by putting some specific annotations on the @Controller methods which implement a given task. To get the swagger description of the application you can download the json file that is generated at the url:
  http://localhost:8080/physconddb/api/rest/swagger.json   GET
  • Visualize the services Use swagger-ui to visualize the services and test them. You can also generate dynamic html documentation using swagger-codegen.

Command examples

TO BE DONE.