Embedded HTTP server
(→Using the server) |
|||
| Line 3: | Line 3: | ||
Note that this server is not designed for large scale web applications, you should use Wandora Piccolo framework and a real servlet container such as Apache Tomcat for that. See [[Setting up Wandora Piccolo server]] for more information. | Note that this server is not designed for large scale web applications, you should use Wandora Piccolo framework and a real servlet container such as Apache Tomcat for that. See [[Setting up Wandora Piccolo server]] for more information. | ||
| − | + | You can configure several different services on the built-in server. These provide different methods of access to the open topic map. These include browsing the topic map through HTML pages, a SOAP based web service access, an RSS feed, a special service for [[Wandora Drupal extras]] and a service for the [[Wandora Firefox plugin]]. These are explained in more detail below. | |
== Configuring the HTTP server == | == Configuring the HTTP server == | ||
| − | To configure the server, select the ''Server'' menu and choose ''Server settings''. The server should work in port 8898 with default settings and allow anonymous but local only connections. | + | To configure the server, select the ''Server'' menu and choose ''Server settings''. The server should work in port 8898 with default settings and allow anonymous but local only connections. In addition to the global server settings, each service has their own settings. These are explained in more detail below. |
{| cellspacing="0" cellpadding="5" border="1" | {| cellspacing="0" cellpadding="5" border="1" | ||
| Line 21: | Line 21: | ||
|- | |- | ||
| valign="top" | Local only | | valign="top" | Local only | ||
| − | | valign="top" | Check this to only allow local connections. If this is checked, you will most likely need to use the loopback address (127.0.0.1 or localhost) to be able to connect. It is recommended that you either keep this checked or otherwise limit access to the server for example with a firewall. | + | | valign="top" | Check this to only allow local connections. If this is checked, you will most likely need to use the loopback address (127.0.0.1 or localhost) to be able to connect. It is recommended that you either keep this checked or otherwise limit access to the server for example with a firewall. The service specific settings have a similar option. If the global local only option is set then all services are only available through local connection regardless of their settings. If the global option is not set, then the service specific settings are used. |
|- | |- | ||
| valign="top" | Use SSL | | valign="top" | Use SSL | ||
| Line 33: | Line 33: | ||
| valign="top" | You may optionally set a user name and password. If these are set, server will only accept authorized connections. Note that these are stored in plain text in Wandora settings file. Also they are not encrypted when transmitted over the net unless SSL options is checked. Leave this blank allows anyone to use the server. | | valign="top" | You may optionally set a user name and password. If these are set, server will only accept authorized connections. Note that these are stored in plain text in Wandora settings file. Also they are not encrypted when transmitted over the net unless SSL options is checked. Leave this blank allows anyone to use the server. | ||
|- | |- | ||
| − | | valign="top" | | + | | valign="top" | Server path |
| − | | valign="top" | | + | | valign="top" | The path that contains the service configuration files. You will need to completely restart Wandora after changing this. |
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
|} | |} | ||
Revision as of 11:30, 30 October 2009
Wandora has a built-in simple http server that can be used to browse a topic map with any web browser or share a topic map.
Note that this server is not designed for large scale web applications, you should use Wandora Piccolo framework and a real servlet container such as Apache Tomcat for that. See Setting up Wandora Piccolo server for more information.
You can configure several different services on the built-in server. These provide different methods of access to the open topic map. These include browsing the topic map through HTML pages, a SOAP based web service access, an RSS feed, a special service for Wandora Drupal extras and a service for the Wandora Firefox plugin. These are explained in more detail below.
Configuring the HTTP server
To configure the server, select the Server menu and choose Server settings. The server should work in port 8898 with default settings and allow anonymous but local only connections. In addition to the global server settings, each service has their own settings. These are explained in more detail below.
| Option | Description |
|---|---|
| Auto start | Check this option to have the HTTP server start automatically whenever you start Wandora. |
| Port | The port used by the server. |
| Local only | Check this to only allow local connections. If this is checked, you will most likely need to use the loopback address (127.0.0.1 or localhost) to be able to connect. It is recommended that you either keep this checked or otherwise limit access to the server for example with a firewall. The service specific settings have a similar option. If the global local only option is set then all services are only available through local connection regardless of their settings. If the global option is not set, then the service specific settings are used. |
| Use SSL | If this is checked, the server will use SSL encryption. This option does not work out of the box. You will need to setup the certificate and encryption keys first. This is done using the keytool utility that should be in bin directory of your Java Development Kit.
For example: keytool -genkey -keystore storefile -keyalg RSA After you have generated the certificate you need to run java with the following parameters: -Djavax.net.ssl.keyStore=storefile -Djavax.net.ssl.keyStorePassword=password |
| User name | You may optionally set a user name and password. If these are set, server will only accept authorized connections. Note that these are stored in plain text in Wandora settings file. Also they are not encrypted when transmitted over the net unless SSL options is checked. Leave this blank allows anyone to use the server. |
| Server path | The path that contains the service configuration files. You will need to completely restart Wandora after changing this. |
Starting the server
After you have configured the server you can start it by selecting Server menu and choosing Start server. You can also click the icon in lower right corner. This icon will also indicate server status. Red circle means that server is disabled, green means that the server is running, bright green means that the server handled a request less than one second ago.
If you checked the Auto start option, the server will start automatically whenever you start Wandora.
Using the server
To use the server open a web browser and enter the IP address or name of your machine and the port number specified in server settings. Usually you will have the web browser and Wandora application open in the same machine so you can use the loopback address 127.0.0.1 or localhost.
To see the currently open topic in Wandora application request file "/topic". For example, using the default 8898 port and loopback address you would use http://localhost:8898/topic . Note that for this to work you actually must have opened some topic in Wandora application.
To see other than currently open topic, use get parameter topic with the subject identifier of the topic you would like to see. For example http://localhost:8898/topic?topic=http%3A%2F%2Fwww.wandora.org%2Fcore%2Fschema-type . The default templates will produce links to all other related topics using this link format allowing very easy browsing of the topic map. Image below views Firefox with Schema type topic served by Wandora's embedded HTTP server.
