xPL4Java
- xPL for anyone
V1.4a -- released March 22, 2008
xPL4Java
is a platform to run (and create) xPL
applications for any computer that has Java available. That
includes Windows, Mac OSX, Linux, Solaris and a number of
others. If you have Java (1.5 or later), you can run (or
develop) xPL applications!
Running
a xPL4Java based application
If you have an
xPL based application that uses xPL4Java, this section
is for you.
Keep in mind
that steps 1-4 need only be done once ever (well, you do
have to restart the container when your computer boots, but that is
covered in the INSTALL.txt
document. Once the container is running, it can support many,
many xPL4Java applications all at the same time (so you only need to
start one program to run all your xPL4Java applications automatically).
To run an
xPL4Java based application:
- Make sure you have Java 1.5 or later (also called Java5)
- Download the xPL4Java
distribution (tgz format)
- Unzip the file into a directory
- Start the xPL4Java container/manager
- Install your application and it should run
You can
read all
about the installation process in INSTALL.txt
xPLHAL
Starting with
version 1.4, xPL4Java includes an automatically started xPLHAL engine
(called xPLHAL4Java). This engine works just like the xPLHAL
service that runs under windows, but can be executed on any
platform. It fully supports events (recurring and one time),
determinators (rules), globals, logging, scripting, etc. The
xPLHAL4Java engine is administered using the xPLHALMgr GUI
application. This application is a windows-only GUI, but it is
only needed to setup and edit your rules/engines. When you are
done making changes, just close it and leave the xPLHAL4Java engine
running. The xPLHALJava engine can be running on any other
machine (or the same machine) and any platform Java runs on.
Developing
xPL4Java application
Developing an
application using xPL4Java insures your hard work can be
used by the largest number of people. In fact, you may find your
application running on platforms you have never even heard of (or never
seen yourself). The environment is rich and geared toward taking
out as much of the "drudgery" of a new xPL application as possible and
provide simple access, to whatever degree you want, to all the richness
the xPL protocol provides.
To get started
in developing xPL4Java based apps:
Download the xPL4Java SDK (tgz format)
Read the xPL4Java_Intro.txt
file
Browse the
xPL4Java API
documentation
If you already
use xPL4Java, you can read about changes for this
release in CHANGELOG.txt
Read about the xPLServer
for easy deployment and hosting of multiple xPL4Java apps
Download the xPL4Java
distribution
(tgz format)
The installation
kit includes all source code, the API docs as well as
other documentation, the xPL4Java container itself, support jar files
and a few examples of writing your own xPL4Java modules.
Because it's
layered, you can use as much or as little of the framework
as needed. If you just want access to raw xPL messages and
sending (with formatters and parsers), you can easily access
that. Or layer a little more on until you reach the level you
need for your application.
Example
code (all included in the xPL4Java download)
xPL_SimpleLogger.java
- a
simple event logger of xPL events to a file or the console
xPL_Clock.java
- a simple
configurable clock that sends time updates to the xPL network
xPL4Java is copyright 2007, Gerald R Duprey Jr
xPL4Java is
licensed under the Apache License, Version 2.0 (the
"License"); you may not
use this file
except in compliance with the License. You may obtain a
copy of
the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required
by applicable law or agreed to in writing, software
distributed
under the
License is distributed on an "AS IS" BASIS, WITHOUT
WARRANTIES OR
CONDITIONS OF
ANY KIND, either express or implied. See the License for
the
specific
language governing permissions and limitations under the
License