WxService

From OpenSimulator

(Difference between revisions)
Jump to: navigation, search
m
m (marking as obsolete, replaced 404 link using wayback archive but may be incomplete)
 
(9 intermediate revisions by 3 users not shown)
Line 1: Line 1:
An add-on set of services provided by BlueWall.
+
{{obsolete}}
 +
'''Purpose''': This page had good information at one point, but it is too out of date to really have value now.  We need to capture the information in another page, or do major work to bring the page up to date.
  
See http://bluewallvirtual.com/WxService
+
'''Tag:''' <nowiki>{{obsolete}}</nowiki>
  
His introductory notes from his blog on 17-Apr-2011 follow:
+
== An example module for Robust ==
 +
WxService is a user-space module consisting of a set of connector, service and handler for Robust. It provides a starting point and example for writing modules to run in the Robust server shell. The example framework demonstrates...
 +
* the steps needed to configure and load the application under the Robust server
 +
* servicing requests that interact with existing core OpenSimulator services
 +
* adding commands to the Robust console
 +
* adding a custom database with migrations
 +
* building an application under Robust
  
In the past, web interfaces and other external applications have been built to manipulate the OpenSimulator data directly. Recent web interfaces and applications are still being developed using these same techniques, but it is arguable whether whether this is a best practice. I don't believe that allowing a host of applications direct access to my data is a good practice at all, so I have been developing WxServices for OpenSimulator. WxServices is in the WxService branch of the OpenSimulator git repo. And below is a description and quick tour of some example code to exercise it.
+
The purpose of WxService is to show how one can leverage the Robust shell to provide points of interaction with OpenSimulator core for external applications. This gives anyone an opportunity to build applications that can interact with OpenSimulator without manipulating the databases directly (bad, bad, bad). It also allows applications that have traditionally used in external apache/php services to be more tightly integrated into the OpenSimulator framework. It should make distribution of modules to users simpler by using the OpenSimulator database facilities to migrate data on installations or upgrades. And, the applications can be made better by providing management commands in the console.
  
WxService is a Robust service that provides a framework for developing secure middleware connectors. The service exposes an interface that allows handlers to be developed in the addon-module directory, along with other end-user developed code. Then manages them in a way similar to the way the Robust handler components are managed. The user provided connectors implement handlers that allow external applications such as web interfaces and management systems to securely and reliably work with the OpenSim internal resources. And, by providing the mechanism to allow the POST handlers for the service to reside outside the core development tree allows easier distribution and integration for third party developers to share code with other users in the same way that region modules can be shared now. Also, an optional https server is enabled to secure the traffic between the application and the service.
+
== '''Example code''' ==
 +
The code is laid out in directories similar to the core services and connectors in OpenSimulator core and is heavily commented. It should be pretty easy to follow and adapt to your own projects. See: https://web.archive.org/web/20151116065351/http://bluewallvirtual.com:80/WxService for code and discussion forum. For help, post in the forum there (no account required) or find me (BlueWall) on IRC - Freenode #opensim

Latest revision as of 06:39, 15 September 2020

Purpose: This page had good information at one point, but it is too out of date to really have value now. We need to capture the information in another page, or do major work to bring the page up to date.

Tag: {{obsolete}}

[edit] An example module for Robust

WxService is a user-space module consisting of a set of connector, service and handler for Robust. It provides a starting point and example for writing modules to run in the Robust server shell. The example framework demonstrates...

  • the steps needed to configure and load the application under the Robust server
  • servicing requests that interact with existing core OpenSimulator services
  • adding commands to the Robust console
  • adding a custom database with migrations
  • building an application under Robust

The purpose of WxService is to show how one can leverage the Robust shell to provide points of interaction with OpenSimulator core for external applications. This gives anyone an opportunity to build applications that can interact with OpenSimulator without manipulating the databases directly (bad, bad, bad). It also allows applications that have traditionally used in external apache/php services to be more tightly integrated into the OpenSimulator framework. It should make distribution of modules to users simpler by using the OpenSimulator database facilities to migrate data on installations or upgrades. And, the applications can be made better by providing management commands in the console.

[edit] Example code

The code is laid out in directories similar to the core services and connectors in OpenSimulator core and is heavily commented. It should be pretty easy to follow and adapt to your own projects. See: https://web.archive.org/web/20151116065351/http://bluewallvirtual.com:80/WxService for code and discussion forum. For help, post in the forum there (no account required) or find me (BlueWall) on IRC - Freenode #opensim

Personal tools
General
About This Wiki