jondo.interfaces
Interface IConfiguration

All Known Implementing Classes:
SimpleConfiguration, SimpleForwarderConfiguration

public interface IConfiguration


Method Summary
 java.lang.String getApplicationName()
           
 ICachingDatabase getDatabaseInterface()
          Optional: a database interface for caching the database entries.
 IAntiCensorshipForwarding getForwardingSettings()
           
 java.net.InetAddress getListenHost()
          Returns the listener host name or null if the application should listen on all host names.
 int getListenPort()
          Returns a valid listen port.
 AbstractPasswordReader getPasswordReader()
           
 SimpleProxyInterface getProxyInterface()
          Returns a proxy interface or null if no proxy is used.
 org.w3c.dom.Element read()
          Returns the configuration content as String.
 void write(org.w3c.dom.Element a_doc)
          Writes the configuration.
 

Method Detail

read

org.w3c.dom.Element read()
                         throws java.lang.Exception
Returns the configuration content as String.

Returns:
the configuration content as String or null if the configuration is empty or does not exist
Throws:
java.lang.Exception - if an error occurs while reading the configuration to a String

write

void write(org.w3c.dom.Element a_doc)
           throws java.lang.Exception
Writes the configuration.

Parameters:
a_configurationContent -
Throws:
java.lang.Exception

getDatabaseInterface

ICachingDatabase getDatabaseInterface()
Optional: a database interface for caching the database entries. Leads to a faster startup. May be null.

Returns:

getListenPort

int getListenPort()
Returns a valid listen port.

Returns:
a valid listen port

getListenHost

java.net.InetAddress getListenHost()
Returns the listener host name or null if the application should listen on all host names.

Returns:
the listener host name or null if the application should listen on all host names

getPasswordReader

AbstractPasswordReader getPasswordReader()

getProxyInterface

SimpleProxyInterface getProxyInterface()
Returns a proxy interface or null if no proxy is used. Typically, such a proxy configuration is only needed on user desktop environments, but not for server applications.

Returns:

getApplicationName

java.lang.String getApplicationName()

getForwardingSettings

IAntiCensorshipForwarding getForwardingSettings()