Changes between Version 2 and Version 3 of PetascopeEmbedded


Ignore:
Timestamp:
Dec 18, 2015 1:20:54 PM (22 months ago)
Author:
pbaumann
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • PetascopeEmbedded

    v2 v3  
    77Petascope can be deployed with a standard servlet container like tomcat, or it can make use of the bundled jetty container to run out of the box without any further installation and configuration.
    88
    9 Following successful installation of rasdaman with jetty enabled, the petascope Web service gets automatically started by the general rasdaman launch script `start_rasdaman.sh`.
     9'''Start:''' Following successful installation of rasdaman with jetty enabled, the petascope Web service gets automatically started by the general rasdaman launch script `start_rasdaman.sh`.
    1010
    11 After successful start, petascope accepts requests according to OGC W*S standards at `http://localhost:8080/rasdaman/ows`.
     11'''Service URLs:''' After successful start, petascope accepts requests according to OGC W*S standards at `http://localhost:8080/rasdaman/ows`.
    1212Further, the SECORE Coordinate Reference System Resolver (CRS) service is available at `http://localhost:8080/def`.
    1313
    14 == How to run petascope with jetty ==
     14''' Stop:''' The petascope/jetty service gets stopped by `stop_rasdaman.sh`  *if* it has been started through `start_rasdaman.sh`. When started independently, petascope will have to be stopped independently.
    1515
    16 In the download directory, jetty is located in rasdaman folder `$RMANHOME/applications/petascope/jetty`.
    17 This folder contains:
    18 * def.war # this is the CRS (Coordinate Reference System) for Petascope.
    19 * jetty.jar # this is Jetty Servlet application is embedded to Petascope Web application.
    20 * README.txt # a file to help you how to build Jetty embedded with Petascope with java JDK by manually. (User need to copy file rasdaman.war (View 3.2 above) to this directory to run it).
    21 * start_petascope.class # a compiled java application to start Jetty with Petascope (view README.txt to see how to run this application).
    22 * start_petascope.java # a java source code application to start Jetty with Petascope (user could change port, extracted temporary folder of Jetty, view README.txt to see how to compile this application).
     16== How to change port? ==
    2317
    24 The configuration and `make install` process produces `$RMANHOME/share/rasdaman/war/rasdaman.war`.
     18By default, jetty uses port 8080. This can be changed by editing the petascope configuration file, `$RMANHOME/etc/petascope.properties`.
     19Open the file in a text editor and find the line
     20{{{
     21jetty_port=8080
     22}}}
     23Change this to the desired port, save the file, and restart jetty.
    2524
    26 === How to start Jetty embedded with Petascope? === 
     25== How to change the petascope extraction folder? ==
    2726
    28 
    29 === How to stop Jetty embedded with Petascope? ===
    30 
    31 
    32 Once again, when you stop rasdaman by running script ''stop_rasdaman.sh'' (default is in /usr/local/rasdaman/bin/stop_rasdaman.sh), this script will check Jetty embedded with Petascope has been started or not, then kill this process ('''NOTE:''' it will not kill your own Jetty process or your Jetty embedded with Petascope started manually).
     27By default, jetty extracts files from `rasdaman.war` and `def.war` (~100 MB) into `$RMANHOME/share/rasdaman/war/jetty_tmp`. This directory can be changed as follows.
     28Edit the petascope configuration file, `$RMANHOME/etc/petascope.properties`.
     29Open the file in a text editor and find the line
    3330{{{
    34 #!sh
    35    To stop rasdaman server, in terminal type: stop_rasdaman.sh
     31jetty_extracted_path=
    3632}}}
    37 
    38 === How could I change port and extracter files of Jetty embedded with Petascope folder? === 
    39 
    40 
    41 Default, Jetty embedded will use port '8080' and a folder to extracted file from 'rasdaman.war' and 'def.war' (default is: '/usr/local/rasdaman/share/rasdaman/war/jetty_tmp' ~ 100 MB). However, user could change port and this temporary folder if he or she want:
    42 
     33By default, this setting is empty making jetty use the default folder `$RMANHOME/share/rasdaman/war/jetty_tmp`. Add an absolute path, such as:
    4334{{{
    44 #!sh
    45    Instead of recompiling file start_rasdaman.java in 'Downloaded Rasdaman source code (View 3.3)', user just need to change the parameters in the file '$RMANHOME/install/etc/petascope.properties' ('''NOTE:''' user must 'make' and 'make install' rasdaman first to see this file)
    46 
    47    # Change port of Jetty (find 'jetty_port')
    48    jetty_port=8080 # you could change to 8088 or 9090 or whatever that has not started before ('''NOTE''': no 'space' before and after '=' for example jetty_port =8080 or jetty_port = 8080 and no comment after the end of port like, user could add a new line and comment).
    49 
    50    # Change extracted folder (find 'jetty_extracted_path')
    51    jetty_extracted_path=   # default is empty because jetty will extracted to default folder '/usr/local/rasdaman/share/rasdaman/war/jetty_tmp', so if you typed your new folder like '/tmp/jetty_tmp', when you start jetty (by start_rasaman.sh or manually) it will extract files to this temporary folder. '''NOTE''': also do not have 'space' or 'comment' like above.
    52    
     35jetty_extracted_path=/tmp/petascope-jetty'
    5336}}}
     37and restart petascope.
    5438
    5539== Troubleshooting ==   
    5640
    5741Q: Cannot start petascope/jetty to listen for Web requests.
    58 * A: In most cases, the reason is that the default port is in use by another web service application program. View 3.4 and 3.6 above to figure out and handle this problem.
     42* A: Most likely, the petascope port is in use by another web service application program. See above for changing the petascope port.
     43
     44Q: My port number and/or extraction directory settings are not recognized, petascope still uses the defaults.
     45* A: Assignments in the petascope configuration file, `petascope.properties`, must not contain any white space before or after the '='; for example, `jetty_port =8080` and `jetty_port = 8080` are both invalid. Further, no comment after the end of the assignment is allowed.
    5946
    6047Q: How can I check whether jetty is up and running?
     
    6956== For developers ==
    7057
     58In the download directory, jetty is located in rasdaman folder `$RMANHOME/applications/petascope/jetty`.
     59This folder contains:
     60* def.war # this is the CRS (Coordinate Reference System) for Petascope.
     61* jetty.jar # this is Jetty Servlet application is embedded to Petascope Web application.
     62* README.txt # a file to help you how to build Jetty embedded with Petascope with java JDK by manually. (User need to copy file rasdaman.war (View 3.2 above) to this directory to run it).
     63* start_petascope.class # a compiled java application to start Jetty with Petascope (view README.txt to see how to run this application).
     64* start_petascope.java # a java source code application to start Jetty with Petascope (user could change port, extracted temporary folder of Jetty, view README.txt to see how to compile this application).
     65
     66The configuration and `make install` process produces `$RMANHOME/share/rasdaman/war/rasdaman.war`.
     67
    7168Rebuilding petascope manually can be done as follows (after having run './configure' in `$RMANHOME`):
    7269{{{