Standard Services

The ORE is distributed with a small set of useful services that other oplets can utilize:

start.jar

The boot controller oplet

logger.jar

Centralized logging

shell.jar

Simple command line shell

logwriter.jar

A repackaging of the logger functionality

ahttp.jar

A very simple HTTP server

oreservlets.jar

Some simple servlets

More standard services will be added to this set as the ORE matures.

start.jar

This oplet is in com.nortelnetworks.service.start. It controls how the ORE bootstraps the initial set of oplets. In a host-based configuration, the ORE uses the value of the ORESTART environment variable to obtain a URL for this oplet. When it is installed and started, this oplet loads a properties file from the same location that it came from. The start property in this file specifies a list of the URLs of all the other oplets that should be installed and started at boot time. For example:

start: logger.jar file:/opt/ore/jars/shell.jar http://oops/startupShell.jar

This states that the ORE should load the logger oplet, followed by the built-in shell, and then finally the basic shell commands. Oplets loaded later in the list can depend on services provided by oplets earlier in the list.

logger.jar

This oplet is in com.nortelnetworks.service.logger. This oplet provides a simple logger service that is used by most of the other standard services. User oplets are encouraged to use it as well. The logger interface is rather basic, but should suffice for many applications.

shell.jar

This oplet is in com.nortelnetworks.service.shell. The ORE provides a simple command line shell to let you administrate the oplets and services. The shell is listening on port 1999 on the device hosting the ORE:

java5% telnet localhost 1999
Trying 127.0.0.1...
Connected to localhost.
Escape character is '^]'.
Welcome to the OpenNet shell
OpletShell> oplets
file:/bnw/home/rduncan/ore/sdk/ore-0.1/jars/start.jar
file:/bnw/home/rduncan/ore/sdk/ore-0.1/jars/logger.jar
file:/bnw/home/rduncan/ore/sdk/ore-0.1/jars/shell.jar
file:/bnw/home/rduncan/ore/sdk/ore-0.1/jars/startupShell.jar
OpletShell> 

The initial set of commands are:

install

Install an oplet

start

Start an oplet

stop

Stop an oplet

uninstall

Uninstall an oplet

load

Install and start an oplet

unload

Stop and uninstall an oplet

oplets

List the currently installed oplets

services

List the currently running services

pwd

Show the current directory

cd

Change the current directory

mkdir

Make a new directory

ls

List the contents of the current directory

Oplets can create their own commands and add them to the shell by creating an instance of com.nortelnetworks.ore.service.shell.Command and calling com.nortelnetworks.ore.shell.ShellService.register().

logwriter.jar

This oplet is in com.nortelnetworks.service.logwriter. It provides an alternate interface to the standard logger service that might be more convenient. This new interface might be migrated into the logger service in a future release.

It provides clients with objects that implement the java.io.Writer interface. It stores the text that the client writes to it until a flush is performed. Then it sends the message to the underlying logger service.

ahttp.jar

This oplet is in com.nortelnetworks.service.ahttp. It provides a rather simple HTTP server, with support for servlets.

oreservlets.jar

This oplet is in com.nortelnetworks.service.oreservlets. It consists of a small set of servlets that make use of the HTTP server service. More servlets will be added to this set as the ORE matures. Included in this release are:

/ore/main

The main ORE oplet

/ore/oplets

A list of all of the currently installed oplets

/ore/log

Contains recent console log messages

The server runs on port 9090; so if you are running the host-based ORE on a machine called ringo you should point your browser to: http://ringo:9090/ore/main.