net.larsan.norna.base
Interface SoftwareInfo


public interface SoftwareInfo

This interface can be implemented by modules in the Norna framework. It provides the system with runtime information about the module. Implementors should take care not to block any threads on this interface.

This interface should return information about the software and not the current installation, multiple installations of the same software will be kept apart without the use of this interface.

Information from this interface will be searchable in the service registry in order to find services during runtime.

Version:
Alpha-0.2 / 2002-10-06 21:37
Author:
Lars J. Nilsson

Method Summary
 java.lang.String getDescription()
          Get a description of the service.
 java.lang.String getOriginator()
          Get software vendor, creator, or copyright holder.
 java.lang.String getPublicID()
          Get module public ID.
 java.lang.String getRelease()
          Get current release tag.
 java.lang.String getSoftwareName()
          Get the software name.
 double getVersion()
          Get current software version.
 

Method Detail

getPublicID

public java.lang.String getPublicID()
Get module public ID. This public ID does not have to be globally unique for the service but it is recomnded that it is composed of a namespace plus a software identifier to avoid possible clashes anyway. As an example, the ID of the Urd reference implementation of the service registry might be:
    http://larsan.net/ns/urd/net.larsan.urd.impl.ServiceRegistryImpl
 

Returns:
The module's public ID, must never return null

getSoftwareName

public java.lang.String getSoftwareName()
Get the software name. This method should return the name of the service software.

Returns:
The software name, may return null

getOriginator

public java.lang.String getOriginator()
Get software vendor, creator, or copyright holder. This is not contact information for the service but rather an identifier for the creator.

Returns:
The software vendor or author, may return null

getRelease

public java.lang.String getRelease()
Get current release tag. This tag may be used to differentiate between relese versions of the same software which might have the same release version.

Returns:
Release tag id, may return null

getVersion

public double getVersion()
Get current software version.

Returns:
Software version as a double

getDescription

public java.lang.String getDescription()
Get a description of the service. This is a textual description which should be kept short and informative as it might be displayed on devices with limited character line length such as console applications.

Returns:
A textual description of the software, may return null