XMOJO 5 API Docs

com.adventnet.adaptors.html
Interface HttpServerInterface

All Known Implementing Classes:
JettyHtmlServer

public interface HttpServerInterface

Interface to plug-in user's WebServer to the HTML Adaptor and HTTP Connector.

Since:
AdventNet Agent Toolkit (Java Edition) 4.2 release.

Method Summary
 java.lang.String getConfigFileName()
          Getter for the configFileName.
 void restartHttpServer()
          Restarts the WebServer.
 void setConfigFileName(java.lang.String configFileName)
          Setter for the configuration file Name with location.
 void setPort(int port)
          Setter for the port.
 void startHttpServer()
          Method to start the WebServer initially.
 void stopHttpServer()
          Stops the WebServer.
 

Method Detail

startHttpServer

public void startHttpServer()
                     throws java.lang.Exception
Method to start the WebServer initially.
Throws:
java.lang.Exception - while error starting WebServer.

stopHttpServer

public void stopHttpServer()
                    throws java.lang.Exception
Stops the WebServer.
Throws:
java.lang.Exception - on error while stopping WebServer.

restartHttpServer

public void restartHttpServer()
                       throws java.lang.Exception
Restarts the WebServer.
Throws:
java.lang.Exception - while error trying to restart the WebServer

setConfigFileName

public void setConfigFileName(java.lang.String configFileName)
Setter for the configuration file Name with location.
Parameters:
configFileName - The configuration file name with path.

getConfigFileName

public java.lang.String getConfigFileName()
Getter for the configFileName.
Returns:
The configuration file Name by which the Server is running.

setPort

public void setPort(int port)
Setter for the port.
Parameters:
the - port number at which the web server should run.

XMOJO 5 API Docs

Copyright ©2003 XMOJO.org. All Rights Reserved.