net.sf.xenqtt.application
Interface XenqttApplication

All Known Implementing Classes:

AbstractXenqttApplication, HelpApplication, HttpGatewayApplication, LicenseApplication, MockBrokerApplication, ProxyApplication, TestClientApplication, VersionApplication

public interface XenqttApplication

Specifies a type that implements a Xenqtt application. A Xenqtt application is an application that can be invoked via the command-line by the user. All applications are instantiated every time xenqtt is run so they should not do anything significant during construction. All applications must have a no-arg constructor.

Method Summary

String	getDescription() This is used to display a detailed description of what this application does.
String	getName()
String	getOptsText() The command line options string to display as part of the usage statement.
String	getOptsUsageText() The usage description of the opts in getOptsText().
String	getSummary() This is used to display a single line summary of what this application does.
void	start(AppContext appContext) Start the application.
void	stop() Stop the application.

Method Detail

start

void start(AppContext appContext)
           throws Exception

Start the application. This method is called by the main thread that is used in launching Xenqtt.

Parameters:

appContext - The context for the application.

Throws:

Exception

stop

void stop()
          throws Exception

Stop the application. This method is called once the application is halted normally (e.g. CTRL-c). The application should take all appropriate shutdown actions at this point. This is called by the main thread that is used in launching Xenqtt

Throws:

Exception

getName

String getName()

Returns:

The application's name for use on the command line

getOptsText

String getOptsText()

The command line options string to display as part of the usage statement.

Returns:

The opts to display

getOptsUsageText

String getOptsUsageText()

The usage description of the opts in getOptsText(). There should be a line in the format "\n\topt : description" for each opt in the getOptsText() string.

Returns:

The usage text to display

getSummary

String getSummary()

This is used to display a single line summary of what this application does. For use in documentation.

Returns:

The summary display

getDescription

String getDescription()

This is used to display a detailed description of what this application does. For use in documentation.

Returns:

The description.