Embedded HTTP server - Revision history

Akivela: /* Services */

2014-12-20T09:44:00Z

‎Services

Akivela: /* See also */

2014-08-15T09:08:55Z

‎See also

Akivela at 09:02, 15 August 2014

2014-08-15T09:02:56Z

Olli: /* Configuring the HTTP server */

2014-05-16T09:45:45Z

‎Configuring the HTTP server

Olli: /* See also */

2014-05-16T09:43:02Z

‎See also

Olli: /* Setting up new service modules */

2014-05-16T09:42:13Z

‎Setting up new service modules

Olli: /* Services */

2014-05-16T09:37:00Z

‎Services

Olli: /* Configuring the HTTP server */

2014-05-16T09:34:41Z

‎Configuring the HTTP server

Olli at 09:34, 16 May 2014

2014-05-16T09:34:03Z

Olli: /* See also */

2014-03-25T14:12:58Z

‎See also

@@ Line 71: / Line 71: @@
 * '''d3matrix''' - [[D3 matrix service module]]
 * '''layer''' - [[D3 layer visualization]]
 Individual services can be configured by modifying their '''config.xml''' file in their service directory. Each service has its directory under '''resources/server'''. You will need to restart Wandora application after modifying the xml configuration files. The structure of the xml configuration files is described in [[Wandora modules framework]].

@@ Line 99: / Line 99: @@
 * The Embedded HTTP server works on the [[Wandora modules framework]], see that page for more details about setting up and configuring module bundles and services.
 * [[Setting up Wandora Piccolo server|Wandora Piccolo]] is a similar older framework but has been deprecated in favour of the modules framework.
 __NOTOC__

← Older revision		Revision as of 09:02, 15 August 2014
Line 1:		Line 1:
−	'''The built-in server is about to undergo some changes. The framework will be changed to the modules framework. For the most part, things will function identically to the old system. Creating new services and managing them however will change. This page has been changed to reflect the new system so it may be slightly different to the current public release.'''
−
	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.		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.

← Older revision		Revision as of 09:45, 16 May 2014
Line 10:		Line 10:


−	[[Image:~~Server_settings~~.~~gif~~\|center]]	+	[[Image:modulesserversettings.png\|center]]

@@ Line 99: / Line 99: @@
 == See also ==
-* [[Wandora modules framework]] is a framework for integrating Wandora with Apache Tomcat, or some other servlet container.
+* The Embedded HTTP server works on the [[Wandora modules framework]], see that page for more details about setting up and configuring module bundles and services.
 * [[Setting up Wandora Piccolo server|Wandora Piccolo]] is a similar older framework but has been deprecated in favour of the modules framework.
 __NOTOC__

@@ Line 80: / Line 80: @@
 == Setting up new service modules ==
-Wandora reads all services from folder '''resources/server'''. This folder contains one folder for each service module. Each service folder contains at least '''config.xml''' specifying options for the output module. For example default service '''topic''' contains '''config.xml''':
+Wandora reads all services from folder '''resources/server'''. This folder contains subdirectories for module bundles. Generally each module bundle contains one service but they can also be configured to contain several services. In any case the whole module bundle and its services are specified in the '''config.xml''' file in the module bundle directory. The structure of the xml configuration file is described at [[Wandora modules framework]].
- <?xml version="1.0" encoding="UTF-8"?>
+To create a completely new module bundle and service, follow these steps.
- <options>
-   <enabled>true</enabled>
-   <template>viewtopic.vhtml</template>
-   <user></user>
-   <password></password>
-   <localonly>true</localonly>
- </options>
-Configuring embedded HTTP server in Wandora application allows you to change all options in '''config.xml'''. If you decide to edit configuration file manually, you need to restart Wandora application in order to apply changes. However, you can't create nor delete services with Wandora application. Service creation and deletion requires manual actions. To set up yet another parallel service for Wandora's embedded HTTP server follow next steps
+* Create a folder in '''resources/server'''. Folder name will be used when accessing the service. For example, if you create a folder '''my-service''' in '''resources/server''', your service is called '''my-service''' and you have to access the service with URL
-−
-* Create a folder in '''resources/server'''. Folder name will be service's name. You'll be accessing the service using it's name. For example, if you create a folder '''my-service''' in '''resources/server''', your service is called '''my-service''' and you have to access the service with URL
   http://127.0.0.1:8898/my-service
-* Create a configuration file '''config.xml''' in the service directory. The configuration file is important as Wandora application recognizes services only if they have a valid configuration file. Enter appropriate XML elements and content to the configuration file. You can always take a look at the existing services if you are unsure about required options.
+* Create a configuration file '''config.xml''' in the service directory. The configuration file is important as Wandora application recognizes services only if they have a valid configuration file. Enter appropriate XML elements and content to the configuration file. It is probably a good idea to use an existing configuration file from one of the default services as a basis. The bundle in the directory '''topic''' is a good example for a service that serves information about a single topic for each http request.
 * Create all other files such as templates, graphics etc. required by your service. Generally, if you create a template based output service such as '''topic''', you need to create at least one Velocity template file.
 * Restart Wandora application.

@@ Line 41: / Line 41: @@
   |}
-In addition to the settings dialog, some server settings can be configured by modifying the configuration xml files of the server itself and of each service. The structure of these files is described on the [[Wandora modules framework]] page. The server configuration file is in ''resources/server/baseconfig.xml''. All services are in subdirectories under ''resources/server'' and their ''config.xml'' configuration files are in the directory of the service.
+In addition to the settings dialog, some server settings can be configured by modifying the configuration xml files of the server itself and of each service. The structure of these files is described on the [[Wandora modules framework]] page. The server configuration file is in '''resources/server/baseconfig.xml'''. All services are in subdirectories under '''resources/server''' and their '''config.xml''' configuration files are in the directory of the service.
 == Starting the server ==

@@ Line 1: / Line 1: @@
-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.
+'''The built-in server is about to undergo some changes. The framework will be changed to the modules framework. For the most part, things will function identically to the old system. Creating new services and managing them however will change. This page has been changed to reflect the new system so it may be slightly different to the current public release.'''
-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.
+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.
 == Configuring the HTTP server ==
@@ Line 34: / Line 36: @@
   | valign="top" | Server path
   | valign="top" | The path that contains the service configuration files. By default the path is '''resources/server/'''. You will need to completely restart Wandora after changing this.
   |}
-In addition to the global server settings, each service has their own settings. Some of these options are common to all services.
+In addition to the settings dialog, some server settings can be configured by modifying the configuration xml files of the server itself and of each service. The structure of these files is described on the [[Wandora modules framework]] page. The server configuration file is in ''resources/server/baseconfig.xml''. All services are in subdirectories under ''resources/server'' and their ''config.xml'' configuration files are in the directory of the service.
-−
-{| cellspacing="0" cellpadding="5" border="1"
- |-
- ! Option
- ! Description
- |-
- | valign="top" | Enabled
- | valign="top" | Use this to enable or disable this service.
- |-
- | valign="top" | Local only
- | valign="top" | Check this to only allow local connections. See the server wide similar option for more details.
- |-
- | valign="top" | User
- | valign="top" | You can provide a user name and password required to login to the service. Note that these are stored in plain text in the options file. Also, unless you use the SSL option, they are also sent in plain text through the net.
- |-
- | valign="top" | Password
- | valign="top" | See ''User'' above.
- |-
- | valign="top" | Handler
- | valign="top" | The Java class that handles this service. Leave blank for the default handler. Service classes should implement the  [http://www.wandora.org/wandora/docs/api/org/wandora/application/server/WebAppHandler.html WebAppHandler] interface.
- |}
-−
-Depending on the chosen handler, there may be other service specific options too. These are explained below.
 == Starting the server ==