amber.server.manager
Interface CoreInterface

All Known Implementing Classes:

Core

public interface CoreInterface

This class is the interface for the main server class.

Version:

1.0.0

Author:

Dr. David J. Knowles

Method Summary

java.lang.String	getAmberRoot() Returns the directory where the Amber server is currently running.
ApplicationManager	getApplicationManager() This function returns the application manager object responsible for handling the requirements of managing applications and their associated handlers.
ConnectionManager	getConnectionManager() This function returns the connection manager object responsible for handling incoming connections.
DatabaseManager	getDatabaseManager() This function returns the database manager object responsible for handling incoming database connections.
java.lang.String	getDocumentRoot() Returns the directory of the web server's document root.
amber.utility.AmberLicenseKey	getLicenseKey() Returns the license key object.
ConnectionHandler	getManager(int type) This function returns the manager object responsible for handling the requirements of the specified remote object type
java.lang.String	getNewSessionIdentifier() This function returns a unique session identifier.
void	sendEmail(java.lang.String to, java.lang.String from, java.lang.String subject, java.lang.String body, java.lang.String smtpServer) This function sends a mail message to the specified user.
void	setLoggingLevel(int level) This function sets the level of logging in the server.
void	stopServer() This function stops the server.

Method Detail

getManager

public ConnectionHandler getManager(int type)

This function returns the manager object responsible for handling the requirements of the specified remote object type

Returns:

ConnectionHandler which manages the remote objects.

getApplicationManager

public ApplicationManager getApplicationManager()

This function returns the application manager object responsible for handling the requirements of managing applications and their associated handlers.

Returns:

ApplicationManager which manages the applications.

getConnectionManager

public ConnectionManager getConnectionManager()

This function returns the connection manager object responsible for handling incoming connections.

Returns:

ConnectionManager which manages connections.

getDatabaseManager

public DatabaseManager getDatabaseManager()

This function returns the database manager object responsible for handling incoming database connections.

Returns:

DatabaseManager which manages database connections.

stopServer

public void stopServer()

This function stops the server.

setLoggingLevel

public void setLoggingLevel(int level)
                     throws ManagerException

This function sets the level of logging in the server.

Parameters:

level - int level to set the debugging to. This corresponds to values in the Log object.

Throws:

ManagerException - with any errors.

getNewSessionIdentifier

public java.lang.String getNewSessionIdentifier()

This function returns a unique session identifier. This information is used when reestablishing the connection correctly. during fail-over.

Returns:

String containing the session identifier.

getLicenseKey

public amber.utility.AmberLicenseKey getLicenseKey()

Returns the license key object.

Returns:

AmberLicenseKey containing the current license conditions.

sendEmail

public void sendEmail(java.lang.String to,
                      java.lang.String from,
                      java.lang.String subject,
                      java.lang.String body,
                      java.lang.String smtpServer)

This function sends a mail message to the specified user.

Parameters:

to - String name of the recipient.

from - String name of the sender.

subject - String containing the subject of the e-mail.

body - String containing the body of the text mail message.

smtpServer - String containing the SMTP mail server address.

getAmberRoot

public java.lang.String getAmberRoot()

Returns the directory where the Amber server is currently running.

Returns:

String containing the Amber server directory.

getDocumentRoot

public java.lang.String getDocumentRoot()

Returns the directory of the web server's document root.

Returns:

String containing the document root directory.