OOHome Server

OOHome: WebService Interface


Introduction

The WebService interface is a minimal set of functionality and does NOT provide full server management capabilities. The reasoning here is that the management functions deal with quite complex and abstract objects (even such a "simple" thing as a module's ID) that exposing these through the web isn't exactly an easy undertaking. So, until a larger demand for a more comprehensive interface is realized, the basic interface is available.

It is not recommended that this service interface be exposed outside of your local environment: it does not provide any security mechanisms and, even though it's quite simple and limited, may provide a vector for a malicious attack on your systems. (Chances are though, that the extent of this "attack" may simply be turning on your bedroom lights at 3 A.M. - which, in my opinion, is eligible for capital punishment.)

Setup and Usage

The port number can be supplied to the server application via it's server.properties file with the key webservice.port. If this value is not provided, a default of 8080 is used. The WebService is always initialized when the server application starts.

The service URL is http://localhost:port/oohome and the WSDL can be obtained by appending ?wsdl to the end of this URL. Obviously, if the server application is running on a different physical machine, that machine's name or IP address will need to be used.

Functions

This is a list of the available operations. Full details on the parameters and returns are available in the WSDL obtained from the running service.


StableFord Software SourceForge.net Logo