net.sf.xenqtt.httpgateway
Class HttpGatewayApplication

java.lang.Object
  net.sf.xenqtt.application.AbstractXenqttApplication
      net.sf.xenqtt.httpgateway.HttpGatewayApplication

All Implemented Interfaces:

XenqttApplication

public class HttpGatewayApplication
extends AbstractXenqttApplication

Runs an HTTP gateway as a XenQTT command line application

Constructor Summary

HttpGatewayApplication()

Method Summary

String	getDescription() This is used to display a detailed description of what this application does.
String	getOptsText() The command line options string to display as part of the usage statement.
String	getOptsUsageText() The usage description of the opts in XenqttApplication.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.

Methods inherited from class net.sf.xenqtt.application.AbstractXenqttApplication

getName

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

HttpGatewayApplication

public HttpGatewayApplication()

Method Detail

start

public void start(AppContext appContext)
           throws Exception

Description copied from interface: XenqttApplication

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

See Also:

XenqttApplication.start(net.sf.xenqtt.AppContext)

stop

public void stop()
          throws Exception

Description copied from interface: XenqttApplication

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

See Also:

XenqttApplication.stop()

getOptsText

public String getOptsText()

Description copied from interface: XenqttApplication

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

Returns:

The opts to display

See Also:

XenqttApplication.getOptsText()

getOptsUsageText

public String getOptsUsageText()

Description copied from interface: XenqttApplication

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

Returns:

The usage text to display

See Also:

XenqttApplication.getOptsUsageText()

getSummary

public String getSummary()

Description copied from interface: XenqttApplication

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

Returns:

The summary display

See Also:

XenqttApplication.getSummary()

getDescription

public String getDescription()

Description copied from interface: XenqttApplication

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

Returns:

The description.

See Also:

XenqttApplication.getDescription()