Wandora modules framework - Revision history

Akivela: /* Example embedded server app */

2014-08-15T09:05:23Z

‎Example embedded server app

Akivela: /* Embedded server */

2014-08-15T09:04:48Z

‎Embedded server

Olli: /* Embedded server */

2014-05-16T09:49:41Z

‎Embedded server

Olli: /* Embedded server */

2014-05-16T09:48:45Z

‎Embedded server

Olli: /* Embedded server */

2014-05-16T09:24:55Z

‎Embedded server

Olli: /* Access control */

2014-05-16T09:20:39Z

‎Access control

Olli: /* Access control */

2014-05-16T09:19:50Z

‎Access control

Olli: /* org.wandora.modules package */

2014-05-16T09:14:21Z

‎org.wandora.modules package

Olli: /* Embedded server */

2014-05-16T09:11:56Z

‎Embedded server

Olli: /* Example embedded server app */

2014-05-16T09:10:48Z

‎Example embedded server app

← Older revision		Revision as of 09:05, 15 August 2014
Line 51:		Line 51:

	You may have to restart your servlet container too. After that, you should be able to browse the topic map by going to [http://localhost:8080/ModulesWebAppSample/wandora http://localhost:8080/ModulesWebAppSample/wandora] or whatever you set as the ''urlbase'' of your web app.		You may have to restart your servlet container too. After that, you should be able to browse the topic map by going to [http://localhost:8080/ModulesWebAppSample/wandora http://localhost:8080/ModulesWebAppSample/wandora] or whatever you set as the ''urlbase'' of your web app.
−
−	~~== Example embedded server app ==~~
−
−	'''The embedded server is about to be changed. The entire old framework is being changed to the modules framework. The adapter module described here will become unnecessary in the next release. See the next section for information on how the server will work.'''
−
−	The [[Embedded HTTP server]] also contains a sample that uses the modules framework in the ''resources/server/modules'' folder. The ''modulesconfig.xml'' is almost identical to the web app sample, with the exception of some of the variables at start which are automatically set by Wandora. Also the topic map manager is Wandora itself instead of a manager that loads the topic map from a file.
−
−	To use this, you only need to start the embedded server in the ''Server'' menu inside Wandora, or click the little icon at the bottom right corner of the window. After that, go to [http://localhost:8898/modules/ http://localhost:8898/modules/] with your browser.
−
−	Note that the sample modules application looks and behaves exactly like the basic topic application, which as a whole is much simpler, consisting only of a single velocity template and not much else. As such, the sample modules application isn't terribly useful, but it could be extended into a much more complicated application.
−
−	A nice use case for using the modules framework in the embedded server would be real time topic map editing for a web app that is normally ran on a proper servlet container. With minimal changes to the ''modulesconfig.xml'' file, you can run the same system inside Wandora and immediately see all the changes you make into the topic map. Thus you can make changes to the topic map and immediately see what they would look like in the final website.

	== Embedded server ==		== Embedded server ==

← Older revision		Revision as of 09:04, 15 August 2014
Line 65:		Line 65:

	== Embedded server ==		== Embedded server ==
−
−	'''The embedded server is about to be changed. The entire old framework is being changed to the modules framework. The adapter described in the previous section will become unnecessary, instead the entire server is based on the modules framework. However, these changed are not yet in the currently released version.'''

	The [[Embedded HTTP server]] is based on the modules framework. The framework consists of a root module manager which loads module bundles from subdirectories. The root manager has its own xml configuration file at ''resources/server/baseconfig.xml'' which sets up the basic environment for the module bundles. Each module bundle is in its own subdirectory with its own ''config.xml'' configuration file and any other files it needs, such as templates, data files, and images and style sheets. The module bundles may import modules from the root manager so that they don't need to recreate all the commonly needed modules. The root manager also sets some variables relating to the child module bundle paths. But for the most part, each module bundle operates as a separate module collection, and most everything described on this page about modules and their configuration applies to module bundles too.		The [[Embedded HTTP server]] is based on the modules framework. The framework consists of a root module manager which loads module bundles from subdirectories. The root manager has its own xml configuration file at ''resources/server/baseconfig.xml'' which sets up the basic environment for the module bundles. Each module bundle is in its own subdirectory with its own ''config.xml'' configuration file and any other files it needs, such as templates, data files, and images and style sheets. The module bundles may import modules from the root manager so that they don't need to recreate all the commonly needed modules. The root manager also sets some variables relating to the child module bundle paths. But for the most part, each module bundle operates as a separate module collection, and most everything described on this page about modules and their configuration applies to module bundles too.

@@ Line 70: / Line 70: @@
 The [[Embedded HTTP server]] is based on the modules framework. The framework consists of a root module manager which loads module bundles from subdirectories. The root manager has its own xml configuration file at ''resources/server/baseconfig.xml'' which sets up the basic environment for the module bundles. Each module bundle is in its own subdirectory with its own ''config.xml'' configuration file and any other files it needs, such as templates, data files, and images and style sheets. The module bundles may import modules from the root manager so that they don't need to recreate all the commonly needed modules. The root manager also sets some variables relating to the child module bundle paths. But for the most part, each module bundle operates as a separate module collection, and most everything described on this page about modules and their configuration applies to module bundles too.
-Importing modules is done using the ''<import>'' element. For example, using the following in the ''config.xml'' of a module bundle imports a ''VelocityEngineModule'' from the ''baseconfig.xml'' of the parent manager into the manager of the child bundle. After this, modules in the child bundle can use ''VelocityEngineModule'' in other modules.
+Importing modules is done using the ''<import>'' element. For example, using the following in the ''config.xml'' of a module bundle imports a ''VelocityEngineModule'' from the ''baseconfig.xml'' of the parent manager into the manager of the child bundle. After this, modules in the child bundle can use ''VelocityEngineModule'' in other modules. This should be placed on the same level as all the module definitions, not inside a module definition.
   <import class="org.wandora.modules.servlet.VelocityEngineModule"></import>

@@ Line 70: / Line 70: @@
 The [[Embedded HTTP server]] is based on the modules framework. The framework consists of a root module manager which loads module bundles from subdirectories. The root manager has its own xml configuration file at ''resources/server/baseconfig.xml'' which sets up the basic environment for the module bundles. Each module bundle is in its own subdirectory with its own ''config.xml'' configuration file and any other files it needs, such as templates, data files, and images and style sheets. The module bundles may import modules from the root manager so that they don't need to recreate all the commonly needed modules. The root manager also sets some variables relating to the child module bundle paths. But for the most part, each module bundle operates as a separate module collection, and most everything described on this page about modules and their configuration applies to module bundles too.
-Importing modules is done using the ''<import>'' element. For example, the following imports a ''VelocityEngineModule''.
+Importing modules is done using the ''<import>'' element. For example, using the following in the ''config.xml'' of a module bundle imports a ''VelocityEngineModule'' from the ''baseconfig.xml'' of the parent manager into the manager of the child bundle. After this, modules in the child bundle can use ''VelocityEngineModule'' in other modules.
   <import class="org.wandora.modules.servlet.VelocityEngineModule"></import>

← Older revision		Revision as of 09:24, 16 May 2014
Line 69:		Line 69:

	The [[Embedded HTTP server]] is based on the modules framework. The framework consists of a root module manager which loads module bundles from subdirectories. The root manager has its own xml configuration file at ''resources/server/baseconfig.xml'' which sets up the basic environment for the module bundles. Each module bundle is in its own subdirectory with its own ''config.xml'' configuration file and any other files it needs, such as templates, data files, and images and style sheets. The module bundles may import modules from the root manager so that they don't need to recreate all the commonly needed modules. The root manager also sets some variables relating to the child module bundle paths. But for the most part, each module bundle operates as a separate module collection, and most everything described on this page about modules and their configuration applies to module bundles too.		The [[Embedded HTTP server]] is based on the modules framework. The framework consists of a root module manager which loads module bundles from subdirectories. The root manager has its own xml configuration file at ''resources/server/baseconfig.xml'' which sets up the basic environment for the module bundles. Each module bundle is in its own subdirectory with its own ''config.xml'' configuration file and any other files it needs, such as templates, data files, and images and style sheets. The module bundles may import modules from the root manager so that they don't need to recreate all the commonly needed modules. The root manager also sets some variables relating to the child module bundle paths. But for the most part, each module bundle operates as a separate module collection, and most everything described on this page about modules and their configuration applies to module bundles too.
		+
		+	Importing modules is done using the ''<import>'' element. For example, the following imports a ''VelocityEngineModule''.
		+
		+	<import class="org.wandora.modules.servlet.VelocityEngineModule"></import>
		+
		+	Note that the class specified here must be the class used when looking for the module. This is usually an interface, rather than the implementation. The actual module imported will then be some module that implements the specified class. If you try to import using the actual implementing class, the module will not be found. Although, some modules may require other modules based on a specific implementation too, this depends on the module that is dependant on the other module.

	== Configuration file ==		== Configuration file ==

@@ Line 206: / Line 206: @@
 * GenericContext
-: This is the base class for most other context modules, but you can also use it on its own. In particular, using the urlPrefix parameter, you can control which http requests are directed into this context based on the path of the request. You may also use the contextPath parameter to change the default path on the server the actions use. It defaults to the directory containing the server ''modulesconfig.xml'' but can be changed to, for example, a subdirectory of that using a GenericContext.
+: This is the base class for most other context modules, but you can also use it on its own. In particular, using the urlPrefix parameter, you can control which http requests are directed into this context based on the path of the request. You may also use the contextPath parameter to change the default path on the server the actions use. It defaults to the directory containing the server ''modulesconfig.xml'' but can be changed to, for example, a subdirectory of that using a GenericContext. Because GenericContext is the base class of most other contexts, you can use these features with other contexts as well.
 * BasicUserAuthenticator
 : This module is basic in the sense that it performs the authentication using the BASIC www authentication scheme and it is also basic in functionality. It stores the passwords of users in plain text so it should never be used in production environment, at least not when user details are collected from a large unspecified group of users. It may be suitable for situations where you have only one or a few users, as in a small group of administrators, that need to be authenticated, and the risks of storing passwords on the server in plain text is of no concern. Even then, you should encrypt the connection using https, otherwise your password will also be transmitted in plain text.

@@ Line 148: / Line 148: @@
 * NetAuthenticatorModule
 : If your server tries to request a resource through http, and the request must be authenticated with a user and a password, you can use this to add an authenticator for it. Note that this is not user authentication for incoming requests, this is for providing login details for requests the server initiates to other servers.
 === org.wandora.modules.cache package ===

@@ Line 68: / Line 68: @@
 '''The embedded server is about to be changed. The entire old framework is being changed to the modules framework. The adapter described in the previous section will become unnecessary, instead the entire server is based on the modules framework. However, these changed are not yet in the currently released version.'''
-The [[Embedded HTTP server]] is based on the modules framework. The framework consists of a root module manager which loads module bundles from subdirectories. The root manager has its own xml configuration file at ''resources/server/baseconfig.xml'' which sets up the basic environment for the module bundles. Each module bundle is in its own subdirectory with its own ''config.xml'' configuration file and any other files it needs, such as templates, data files, and images and style sheets. The module bundles may import modules from the root manager so that they don't need to recreate all the commonly needed modules. The root manager also sets some variables relating to the child module bundle paths. But for the most part, each module bundle operates as a separate module collection.
+The [[Embedded HTTP server]] is based on the modules framework. The framework consists of a root module manager which loads module bundles from subdirectories. The root manager has its own xml configuration file at ''resources/server/baseconfig.xml'' which sets up the basic environment for the module bundles. Each module bundle is in its own subdirectory with its own ''config.xml'' configuration file and any other files it needs, such as templates, data files, and images and style sheets. The module bundles may import modules from the root manager so that they don't need to recreate all the commonly needed modules. The root manager also sets some variables relating to the child module bundle paths. But for the most part, each module bundle operates as a separate module collection, and most everything described on this page about modules and their configuration applies to module bundles too.
 == Configuration file ==

@@ Line 53: / Line 53: @@
 == Example embedded server app ==
 The [[Embedded HTTP server]] also contains a sample that uses the modules framework in the ''resources/server/modules'' folder. The ''modulesconfig.xml'' is almost identical to the web app sample, with the exception of some of the variables at start which are automatically set by Wandora. Also the topic map manager is Wandora itself instead of a manager that loads the topic map from a file.
@@ Line 61: / Line 63: @@
 A nice use case for using the modules framework in the embedded server would be real time topic map editing for a web app that is normally ran on a proper servlet container. With minimal changes to the ''modulesconfig.xml'' file, you can run the same system inside Wandora and immediately see all the changes you make into the topic map. Thus you can make changes to the topic map and immediately see what they would look like in the final website.
 == Configuration file ==