Implementing the Jini Technology Lookup, Discovery, and Join Compatibility Kit, v1.0 Admin Interface

Introduction

An "Admin" is an object that is responsible for starting and stopping the program you are testing. If you wish to automate Jini(TM) Technology Lookup, Discovery, and Join Compatibility Kit (LDJ Kit) testing of your program, you will need to implement your own, specialized Admin object to start and stop your program automatically. In addition, it may be necessary to implement your own Admin in certain circumstances where the supplied default Admins do not work for your program.

The LDJ Kit includes three default Admins (one each for clients, services, and lookup services), which simply ask you to start and stop your program at the times determined to be appropriate by each test. Also included are Admins written for the services and lookup service contributed by Sun Microsystems, which serve as examples of how to write Admins using the service starter framework. For details on this framework, see the Jini API documentation, generated by the javadoc tool, for the com.sun.jini.start package.

Admin Interfaces

There are four related Admin interfaces. Most of the interfaces have a static string that is the name of the category for which the interface is used. When writing your own Admin, you must implement one or more of these interfaces. The interface(s) you implement must be the one(s) appropriate for your program category.

BasicAdmin

package com.sun.jini.compat.harness;
public interface BasicAdmin {
    void setConfig(Config conf);
    void start() throws RemoteException;
    InetAddress getAddress() throws RemoteException;
    void stop() throws RemoteException;
}

The methods of BasicAdmin are:

setConfig: This method provides the Admin object access to the Config object (see "Config Object"). This method is always called immediately after the Admin constructor.

start: This method starts the program being tested. The LDJ Kit tests will call this method whenever they need the program started. The implementation of this method should put the program in a state where it is starting to participate in the Jini discovery protocols. Typically this method will call the service starter framework or Runtime.getRuntime().exec() to start the service.

getAddress: This method should return the network address of the program or the hardware on which the program is running. If a program is multi-homed, one working address should be returned. This method can only be called between the start and stop methods; otherwise the behavior is undefined.

stop: This method stops the program being tested. The LDJ Kit tests will call stop whenever they need the program stopped. The implementation of this method should completely stop the program, cleaning up any state, and resetting the program to its initial pre-test state.

BasicClientAdmin

package com.sun.jini.compat.harness;
public interface BasicClientAdmin extends BasicAdmin {
    String CATEGORY = "client";
}

BasicServiceAdmin

package com.sun.jini.compat.harness;
public interface BasicServiceAdmin extends BasicAdmin {
    String CATEGORY = "service";
    ServiceItem pickService(ServiceItem[] services) throws RemoteException;
    ServiceTemplate getTemplate() throws RemoteException;
}

The additional methods of BasicServiceAdmin will only be called after calls to BasicAdmin.setConfig() and BasicAdmin.start() and before a call to BasicAdmin.stop(). The additional methods are:

pickService: Given an array of ServiceItem instances, this method must return the ServiceItem of the service being tested or return null if the service is not represented in the array.

getTemplate: This method must return a ServiceTemplate that matches the service being tested. The template does not need to be exact, but the more exact it is, the more efficient the testing will be. In fact a fully wildcarded ServiceTemplate is a legal return value.

BasicLookupAdmin

package com.sun.jini.compat.harness;
public interface BasicLookupAdmin extends BasicAdmin {
    String CATEGORY = "lookup";
    ServiceRegistrar getServiceRegistrar() throws RemoteException;
}

The additional method of BasicLookupAdmin will only be called after calls to BasicAdmin.setConfig() and BasicAdmin.start() and before a call to BasicAdmin.stop(). The additional method is:

getServiceRegistrar: This method must return the ServiceRegistrar of the lookup service being tested.

Implementation Notes

Your Admin must not start your program in the same virtual machine for the Java(TM) platform (VM) as the LDJ Kit. Starting a program in the same VM as the LDJ Kit will likely cause the CodeDownloadTest to fail.

Do not call System.exit() in your Admin implementation. Calling this method will stop the LDJ Kit prematurely.

Config Object

Using Your Admin