dtw.webmail.util
Class JwmaSettings

java.lang.Object
  |
  +--dtw.webmail.util.JwmaSettings

public class JwmaSettings

extends java.lang.Object

Class implementing a wrapper for jwma's settings.

Version:

0.9.7 07/02/2003

Author:

Dieter Wimberger

Field Summary

static java.lang.String	DATA_DIR
static java.lang.String	ERROR_DESCRIPTION_FILE Defines the name of jwma's user visible error messages file.
static java.lang.String	ETC_DIR
static java.lang.String	I18N_DIR
static java.lang.String	LOG_DIR Defines a name of the static jwma direcory architecture.

Constructor Summary

protected

JwmaSettings(java.lang.String path) Constructs a new JwmaSettings instance.

Method Summary

static JwmaSettings	createJwmaSettings(java.lang.String path) Creates a JwmaSettings instance.
java.lang.String	getAccountCreationView() Returns a String representing a JwmaKernel view constant, denoting the view to be presented on account creation.
java.lang.String	getAdminControllerAlias() Returns a String representing the admin controller alias.
java.lang.String	getAdminErrorView() Returns a String representing the admin error view filename/URL ending.
java.lang.String	getAdminLoginView() Returns a String representing the admin login view filename/URL ending.
java.lang.String	getAdminMenuView() Returns a String representing the admin menu view filename/URL ending.
java.lang.String	getAdminPreferencesView() Returns a String representing the admin preferences view filename/URL ending.
java.lang.String	getAdminSettingsView() Returns a String representing the admin settings view filename/URL ending.
java.lang.String	getAdminStatusView() Returns a String representing the admin status view filename/URL ending.
java.lang.String[]	getAdminUsernames() Returns a String representing a list of usernames that have administrative rights.
java.lang.String[]	getCategories()
java.lang.String	getComposeView() Returns a String representing the compose view filename/URL ending.
java.lang.String	getContactEditView() Returns a String representing the contact edit view filename/URL ending.
java.lang.String	getContactGroupEditView() Returns a String representing the contact group edit view filename/URL ending.
java.lang.String	getContactGroupView() Returns a String representing the contact group view filename/URL ending.
java.lang.String	getContactManagementPluginClassName()
java.lang.String	getContactsControllerAlias() Returns a String representing the contacts controller alias.
java.lang.String	getContactsView() Returns a String representing the contacts view filename/URL ending.
java.lang.String	getContactView() Returns a String representing the contact view filename/URL ending.
java.lang.String	getControllerPrefix() Returns a String representing the prefix for the controllers.
java.lang.String	getDefaultMessageProcessingPipe() Returns a String representing the name of the default message processing pipe.
java.lang.String	getDump() Returns a String representing the settings file's path.
java.lang.String	getErrorView() Returns a String representing the error view filename/URL ending.
java.lang.String	getFirsttimeView() Returns a String representing the firsttime view filename/URL ending.
java.lang.String	getFolderView() Returns a String representing the folder view filename/URL ending.
java.lang.String[]	getLanguageList()
java.lang.String	getLoginView() Returns a String representing the login view filename/URL ending.
java.lang.String	getLogoutView() Returns a String representing the logout view filename/URL ending.
java.lang.String	getLogPropertiesFilename() Returns a String representing filename of the log4j properties file.
java.lang.String	getMailboxView() Returns a String representing the mailbox view filename/URL ending.
java.lang.String	getMailingControllerAlias() Returns a String representing the mailing controller alias.
java.lang.String	getMailTransportHost() Returns a String representing the MTA's hostname.
int	getMailTransportLimit() Returns an int representing the maximum size in kB's allowed for a message to be transported.
int	getMailTransportPort() Returns an int representing the port the MTA is running on.
java.lang.String	getMailTransportProtocol() Returns a String representing the mail transport protocol name.
java.lang.String	getMainControllerAlias() Returns a String representing the main controller alias.
java.lang.String	getMappingFilename() Returns a String representing filename of the mapping file used for XML serialization.
java.lang.String	getMessageView() Returns a String representing the message view filename/URL ending.
java.lang.String	getPath() Returns a String representing the settings file's path.
boolean	getPostOfficeAllowOverride() Tests if overriding the system's set postoffice is allowed.
java.lang.String	getPostOfficeHost() Returns a String representing the postoffice's hostname.
int	getPostOfficePort() Returns an int representing the port the postoffice is running on.
java.lang.String	getPostOfficeProtocol() Returns a String representing the post office protocol name.
java.lang.String	getPostOfficeSecureSocketFactory() Returns a String representing the fully qualified class name of the secure socket factory to be used for secure connections to the postoffice.
java.lang.String	getPostOfficeType() Returns a String representing the postoffice's type.
java.lang.String	getPreferencesView() Returns a String representing the preferences view filename/URL ending.
java.lang.String	getPrefPersistencePluginClassName() END i18n related
java.lang.String	getRandomAppendPluginClassName()
java.lang.String	getSystemLanguage() i18n related
java.lang.String	getTemplateFilename() Returns a String representing filename of the site's settings template file.
java.lang.String	getTextProcFilename() Returns a String representing filename of the text processing properties.
java.lang.String	getViewPrefix() Returns a String representing the prefix for the views.
boolean	isAccountCreationEnabled() Tests if creation of accounts is enabled.
boolean	isAdminEnabled() Tests if accessing the system's administration is enabled.
boolean	isMailTransportAuthenticated() Tests if the connection to the MTA should be authenticated.
boolean	isPostOfficeSecure() Tests if the connection to the postoffice should be secure.
void	load() Loads the properties file containing jwma's settings.
void	save() Saves the properties file containing jwma's settings.
void	setAccountCreationEnabled(boolean enabled) Sets the flag that controls if the automatic creation of accounts is enabled.
void	setAccountCreationView(java.lang.String view) Sets the view key constant of the view to be presented to the user on account creation.
void	setAdminControllerAlias(java.lang.String alias) Sets the alias for the admin controller.
void	setAdminEnabled(boolean enabled) Sets the flag that controls if the system's adminstration is enabled.
void	setAdminErrorView(java.lang.String name) Sets the filename/URL ending for the admin error view.
void	setAdminLoginView(java.lang.String name) Sets the filename/URL ending for the admin login view.
void	setAdminMenuView(java.lang.String name) Sets the filename/URL ending for the admin menu view.
void	setAdminPreferencesView(java.lang.String name) Sets the filename/URL ending for the admin preferences view.
void	setAdminSettingsView(java.lang.String name) Sets the filename/URL ending for the admin settings view.
void	setAdminStatusView(java.lang.String name) Sets the filename/URL ending for the admin status view.
void	setAdminUsernames(java.lang.String[] admins) Sets the admin's usernames.
void	setCategories(java.lang.String[] cats)
void	setComposeView(java.lang.String name) Sets the filename/URL ending for the compose view.
void	setContactEditView(java.lang.String name) Sets the filename/URL ending for the contact edit view.
void	setContactGroupEditView(java.lang.String name) Sets the filename/URL ending for the contact group edit view.
void	setContactGroupView(java.lang.String name) Sets the filename/URL ending for the contact group view.
void	setContactManagementPluginClassName(java.lang.String classname)
void	setContactsControllerAlias(java.lang.String alias) Sets the alias for the contacts controller.
void	setContactsView(java.lang.String name) Sets the filename/URL ending for the contacts view.
void	setContactView(java.lang.String name) Sets the filename/URL ending for the contact view.
void	setControllerPrefix(java.lang.String prefix) Sets the prefix for the controllers.
void	setDefaultMessageProcessingPipe(java.lang.String name) Returns a String representing the name of the default message processing pipe.
void	setErrorView(java.lang.String name) Sets the filename/URL ending for the error view.
void	setFirsttimeView(java.lang.String name) Sets the filename/URL ending for the firsttime view.
void	setFolderView(java.lang.String name) Sets the filename/URL ending for the folder view.
void	setLanguageList(java.lang.String[] languages)
void	setLoginView(java.lang.String name) Sets the filename/URL ending for the login view.
void	setLogoutView(java.lang.String name) Sets the filename/URL ending for the logout view.
void	setLogPropertiesFilename(java.lang.String name) Sets the the filename of the log4j properties file.
void	setMailboxView(java.lang.String name) Sets the filename/URL ending for the mailbox view.
void	setMailingControllerAlias(java.lang.String alias) Sets the alias for the mailing controller.
void	setMailTransportAuthenticated(boolean auth) Sets the flag that controls if connections to the MTA should be authenticated.
void	setMailTransportHost(java.lang.String host) Sets the host name of the MTA.
void	setMailTransportLimit(int size) Sets the transport size limitation.
void	setMailTransportPort(int num) Sets the port the MTA is running on.
void	setMailTransportProtocol(java.lang.String protocol) Sets the name of the mail transport protocol.
void	setMainControllerAlias(java.lang.String alias) Sets the alias for the main controller.
void	setMappingFilename(java.lang.String name) Sets the the filename of the mapping file used for XML serialization.
void	setMessageView(java.lang.String name) Sets the filename/URL ending for the message view.
void	setPostOfficeAllowOverride(boolean allowoverride) Sets the flag that controls if overriding the system's set postoffice is allowed or not.
void	setPostOfficeHost(java.lang.String host) Sets the host name of the postoffice.
void	setPostOfficePort(int num) Sets the port the postoffice is running on.
void	setPostOfficeProtocol(java.lang.String protocol) Sets the name of the postoffice protocol.
void	setPostOfficeSecure(boolean b) Sets the flag that controls if connections to the MTA should be secure.
void	setPostOfficeType(java.lang.String type) Sets the type of the postoffice.
void	setPostSecureFactory(java.lang.String factory) Sets the fully qualified class name of the secure socket factory to be used for secure connections to the postoffice.
void	setPreferencesView(java.lang.String name) Sets the filename/URL ending for the preferences view.
void	setPrefPersistencePluginClassName(java.lang.String classname)
void	setRandomAppendPluginClassName(java.lang.String classname)
void	setSystemLanguage(java.lang.String language)
void	setTemplateFilename(java.lang.String name) Sets the the filename of the site's settings template file.
void	setTextProcFilename(java.lang.String name) Sets the filename of the text processing properties.
void	setViewPrefix(java.lang.String prefix) Sets the prefix for the views.

Methods inherited from class java.lang.Object

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

Field Detail

LOG_DIR

public static final java.lang.String LOG_DIR

Defines a name of the static jwma direcory architecture.

See Also:

Constant Field Values

ETC_DIR

public static final java.lang.String ETC_DIR

See Also:

Constant Field Values

DATA_DIR

public static final java.lang.String DATA_DIR

See Also:

Constant Field Values

I18N_DIR

public static final java.lang.String I18N_DIR

See Also:

Constant Field Values

ERROR_DESCRIPTION_FILE

public static final java.lang.String ERROR_DESCRIPTION_FILE

Defines the name of jwma's user visible error messages file.

See Also:

Constant Field Values

Constructor Detail

JwmaSettings

protected JwmaSettings(java.lang.String path)

Constructs a new JwmaSettings instance. The given path should point to the persistent settings file. At the moment the file is a standard properties file.

Parameters:

path - the full path of the persistent settings file.

Method Detail

isAccountCreationEnabled

public boolean isAccountCreationEnabled()

Tests if creation of accounts is enabled.

Returns:

true if account creation is enabled, false otherwise.

setAccountCreationEnabled

public void setAccountCreationEnabled(boolean enabled)

Sets the flag that controls if the automatic creation of accounts is enabled.

getAccountCreationView

public java.lang.String getAccountCreationView()

Returns a String representing a JwmaKernel view constant, denoting the view to be presented on account creation.

Returns:

the account creation view key as String.

setAccountCreationView

public void setAccountCreationView(java.lang.String view)

Sets the view key constant of the view to be presented to the user on account creation.

Parameters:

view - the view key as String.

getAdminUsernames

public java.lang.String[] getAdminUsernames()

Returns a String representing a list of usernames that have administrative rights.

Returns:

the list of admin's usernames as String.

setAdminUsernames

public void setAdminUsernames(java.lang.String[] admins)

Sets the admin's usernames.

Parameters:

admins - the admin's usernames as String[].

isAdminEnabled

public boolean isAdminEnabled()

Tests if accessing the system's administration is enabled.

Returns:

true if administration is enabled, false otherwise.

setAdminEnabled

public void setAdminEnabled(boolean enabled)

Sets the flag that controls if the system's adminstration is enabled.

getControllerPrefix

public java.lang.String getControllerPrefix()

Returns a String representing the prefix for the controllers.

Returns:

the prefix for the controllers as String.

setControllerPrefix

public void setControllerPrefix(java.lang.String prefix)

Sets the prefix for the controllers.

Parameters:

prefix - the prefix for the controllers as String.

getMainControllerAlias

public java.lang.String getMainControllerAlias()

Returns a String representing the main controller alias.

Returns:

the alias of the main controller as String.

setMainControllerAlias

public void setMainControllerAlias(java.lang.String alias)

Sets the alias for the main controller.

Parameters:

alias - the alias for the main controller as String.

getMailingControllerAlias

public java.lang.String getMailingControllerAlias()

Returns a String representing the mailing controller alias.

Returns:

the alias of the mailing controller as String.

setMailingControllerAlias

public void setMailingControllerAlias(java.lang.String alias)

Sets the alias for the mailing controller.

Parameters:

alias - the alias for the mailing controller as String.

getAdminControllerAlias

public java.lang.String getAdminControllerAlias()

Returns a String representing the admin controller alias.

Returns:

the alias of the admin controller as String.

setAdminControllerAlias

public void setAdminControllerAlias(java.lang.String alias)

Sets the alias for the admin controller.

Parameters:

alias - the alias for the admin controller as String.

getContactsControllerAlias

public java.lang.String getContactsControllerAlias()

Returns a String representing the contacts controller alias.

Returns:

the alias of the contacts controller as String.

setContactsControllerAlias

public void setContactsControllerAlias(java.lang.String alias)

Sets the alias for the contacts controller.

Parameters:

alias - the alias for the contacts controller as String.

getPostOfficeProtocol

public java.lang.String getPostOfficeProtocol()

Returns a String representing the post office protocol name.

Returns:

the postoffice protocol name as String.

setPostOfficeProtocol

public void setPostOfficeProtocol(java.lang.String protocol)

Sets the name of the postoffice protocol.

Parameters:

protocol - the name of the postoffice protocol as String.

getPostOfficeHost

public java.lang.String getPostOfficeHost()

Returns a String representing the postoffice's hostname.

Returns:

the postoffice hostname as String.

setPostOfficeHost

public void setPostOfficeHost(java.lang.String host)

Sets the host name of the postoffice.

Parameters:

host - the hostname of the postoffice as String.

getPostOfficePort

public int getPostOfficePort()

Returns an int representing the port the postoffice is running on.

Returns:

the port number as int.

setPostOfficePort

public void setPostOfficePort(int num)

Sets the port the postoffice is running on.

getPostOfficeType

public java.lang.String getPostOfficeType()

Returns a String representing the postoffice's type.

• mixed: folders in the store can hold folders and files.
• plain: folders in the store can hold only folders or messages.
• auto: folder types are checked by jwma
Note that in jwma terminology the folder that can only hold messages is called a mailbox

Returns:

the postoffice type as String.

setPostOfficeType

public void setPostOfficeType(java.lang.String type)

Sets the type of the postoffice.

Parameters:

type - the type of the postoffice as String.

getPostOfficeAllowOverride

public boolean getPostOfficeAllowOverride()

Tests if overriding the system's set postoffice is allowed.

Returns:

true if overriding is allowed, false otherwise.

setPostOfficeAllowOverride

public void setPostOfficeAllowOverride(boolean allowoverride)

Sets the flag that controls if overriding the system's set postoffice is allowed or not.

isPostOfficeSecure

public boolean isPostOfficeSecure()

Tests if the connection to the postoffice should be secure.

Returns:

true if secure, false otherwise.

setPostOfficeSecure

public void setPostOfficeSecure(boolean b)

Sets the flag that controls if connections to the MTA should be secure.

getPostOfficeSecureSocketFactory

public java.lang.String getPostOfficeSecureSocketFactory()

Returns a String representing the fully qualified class name of the secure socket factory to be used for secure connections to the postoffice.

Returns:

the secure socket factory classname as String.

setPostSecureFactory

public void setPostSecureFactory(java.lang.String factory)

Sets the fully qualified class name of the secure socket factory to be used for secure connections to the postoffice.

getMailTransportProtocol

public java.lang.String getMailTransportProtocol()

Returns a String representing the mail transport protocol name.

Returns:

the mail transport protocol name as String.

setMailTransportProtocol

public void setMailTransportProtocol(java.lang.String protocol)

Sets the name of the mail transport protocol.

Parameters:

protocol - the name of the mail transport protocol as String.

getMailTransportHost

public java.lang.String getMailTransportHost()

Returns a String representing the MTA's hostname.

Returns:

the MTA's hostname as String.

setMailTransportHost

public void setMailTransportHost(java.lang.String host)

Sets the host name of the MTA.

Parameters:

host - the hostname of the MTA as String.

getMailTransportPort

public int getMailTransportPort()

Returns an int representing the port the MTA is running on.

Returns:

the port number as int.

setMailTransportPort

public void setMailTransportPort(int num)

Sets the port the MTA is running on.

isMailTransportAuthenticated

public boolean isMailTransportAuthenticated()

Tests if the connection to the MTA should be authenticated.

Returns:

true if authentication required, false otherwise.

setMailTransportAuthenticated

public void setMailTransportAuthenticated(boolean auth)

Sets the flag that controls if connections to the MTA should be authenticated.

getMailTransportLimit

public int getMailTransportLimit()

Returns an int representing the maximum size in kB's allowed for a message to be transported.

Returns:

maximum size of a message in kB's as int.

setMailTransportLimit

public void setMailTransportLimit(int size)

Sets the transport size limitation.

Parameters:

size - the number of kB's a message can reach at maximum as int.

getMappingFilename

public java.lang.String getMappingFilename()

Returns a String representing filename of the mapping file used for XML serialization.

Returns:

the filename of the mapping file as String.

setMappingFilename

public void setMappingFilename(java.lang.String name)

Sets the the filename of the mapping file used for XML serialization.

There should not be any path appended to this filename, because the path is constructed from different settings.

Parameters:

name - the filename of the mapping file as String.

getTemplateFilename

public java.lang.String getTemplateFilename()

Returns a String representing filename of the site's settings template file.

This file represents a serialized JwmaPreferences instance that is used for cloning new user's settings.

Returns:

the filename of the site's settings template file as String.

setTemplateFilename

public void setTemplateFilename(java.lang.String name)

Sets the the filename of the site's settings template file.

This file represents a serialized JwmaPreferences instance that is used for cloning new user's settings. There should not be any path appended to this filename, because the path is constructed from different settings.

Parameters:

name - the filename of the site's settings template file as String.

getLogPropertiesFilename

public java.lang.String getLogPropertiesFilename()

Returns a String representing filename of the log4j properties file.

Returns:

the filename of the log4j properties as String.

setLogPropertiesFilename

public void setLogPropertiesFilename(java.lang.String name)

Sets the the filename of the log4j properties file.

Parameters:

name - the filename of the log4j properties as String.

getTextProcFilename

public java.lang.String getTextProcFilename()

Returns a String representing filename of the text processing properties.

Returns:

the filename of the text processing properties as String.

setTextProcFilename

public void setTextProcFilename(java.lang.String name)

Sets the filename of the text processing properties.

getDefaultMessageProcessingPipe

public java.lang.String getDefaultMessageProcessingPipe()

Returns a String representing the name of the default message processing pipe.

Returns:

the name of the default message processing pipe as String.

setDefaultMessageProcessingPipe

public void setDefaultMessageProcessingPipe(java.lang.String name)

Returns a String representing the name of the default message processing pipe.

Returns:

the name of the default message processing pipe as String.

getViewPrefix

public java.lang.String getViewPrefix()

Returns a String representing the prefix for the views.

Returns:

the prefix for the views as String.

setViewPrefix

public void setViewPrefix(java.lang.String prefix)

Sets the prefix for the views.

Parameters:

prefix - the prefix for the views as String.

getErrorView

public java.lang.String getErrorView()

Returns a String representing the error view filename/URL ending.

Returns:

the error view filename/URL ending as String.

setErrorView

public void setErrorView(java.lang.String name)

Sets the filename/URL ending for the error view.

Parameters:

name - the error view filename/URL ending as String.

getLoginView

public java.lang.String getLoginView()

Returns a String representing the login view filename/URL ending.

Returns:

the login view filename/URL ending as String.

setLoginView

public void setLoginView(java.lang.String name)

Sets the filename/URL ending for the login view.

Parameters:

name - the login view filename/URL ending as String.

getLogoutView

public java.lang.String getLogoutView()

Returns a String representing the logout view filename/URL ending.

Returns:

the logout view filename/URL ending as String.

setLogoutView

public void setLogoutView(java.lang.String name)

Sets the filename/URL ending for the logout view.

Parameters:

name - the logout view filename/URL ending as String.

getFolderView

public java.lang.String getFolderView()

Returns a String representing the folder view filename/URL ending.

Returns:

the folder view filename/URL ending as String.

setFolderView

public void setFolderView(java.lang.String name)

Sets the filename/URL ending for the folder view.

Parameters:

name - the folder view filename/URL ending as String.

getMailboxView

public java.lang.String getMailboxView()

Returns a String representing the mailbox view filename/URL ending.

Returns:

the mailbox view filename/URL ending as String.

setMailboxView

public void setMailboxView(java.lang.String name)

Sets the filename/URL ending for the mailbox view.

Parameters:

name - the mailbox view filename/URL ending as String.

getMessageView

public java.lang.String getMessageView()

Returns a String representing the message view filename/URL ending.

Returns:

the message view filename/URL ending as String.

setMessageView

public void setMessageView(java.lang.String name)

Sets the filename/URL ending for the message view.

Parameters:

name - the message view filename/URL ending as String.

getComposeView

public java.lang.String getComposeView()

Returns a String representing the compose view filename/URL ending.

Returns:

the compose view filename/URL ending as String.

setComposeView

public void setComposeView(java.lang.String name)

Sets the filename/URL ending for the compose view.

Parameters:

name - the compose view filename/URL ending as String.

getPreferencesView

public java.lang.String getPreferencesView()

Returns a String representing the preferences view filename/URL ending.

Returns:

the preferences view filename/URL ending as String.

setPreferencesView

public void setPreferencesView(java.lang.String name)

Sets the filename/URL ending for the preferences view.

Parameters:

name - the preferences view filename/URL ending as String.

getFirsttimeView

public java.lang.String getFirsttimeView()

Returns a String representing the firsttime view filename/URL ending.

Returns:

the firsttime view filename/URL ending as String.

setFirsttimeView

public void setFirsttimeView(java.lang.String name)

Sets the filename/URL ending for the firsttime view.

Parameters:

name - the firsttime view filename/URL ending as String.

getContactsView

public java.lang.String getContactsView()

Returns a String representing the contacts view filename/URL ending.

Returns:

the contacts view filename/URL ending as String.

setContactsView

public void setContactsView(java.lang.String name)

Sets the filename/URL ending for the contacts view.

Parameters:

name - the contacts view filename/URL ending as String.

getContactView

public java.lang.String getContactView()

Returns a String representing the contact view filename/URL ending.

Returns:

the contact view filename/URL ending as String.

setContactView

public void setContactView(java.lang.String name)

Sets the filename/URL ending for the contact view.

Parameters:

name - the contact view filename/URL ending as String.

getContactEditView

public java.lang.String getContactEditView()

Returns a String representing the contact edit view filename/URL ending.

Returns:

the contact edit view filename/URL ending as String.

setContactEditView

public void setContactEditView(java.lang.String name)

Sets the filename/URL ending for the contact edit view.

Parameters:

name - the contact edit view filename/URL ending as String.

getContactGroupView

public java.lang.String getContactGroupView()

Returns a String representing the contact group view filename/URL ending.

Returns:

the contact group view filename/URL ending as String.

setContactGroupView

public void setContactGroupView(java.lang.String name)

Sets the filename/URL ending for the contact group view.

Parameters:

name - the contact group view filename/URL ending as String.

getContactGroupEditView

public java.lang.String getContactGroupEditView()

Returns a String representing the contact group edit view filename/URL ending.

Returns:

the contact group edit view filename/URL ending as String.

setContactGroupEditView

public void setContactGroupEditView(java.lang.String name)

Sets the filename/URL ending for the contact group edit view.

Parameters:

name - the contact group edit view filename/URL ending as String.

getAdminPreferencesView

public java.lang.String getAdminPreferencesView()

Returns a String representing the admin preferences view filename/URL ending.

Returns:

the admin preferences view filename/URL ending as String.

setAdminPreferencesView

public void setAdminPreferencesView(java.lang.String name)

Sets the filename/URL ending for the admin preferences view.

Parameters:

name - the preferences view filename/URL ending as String.

getAdminSettingsView

public java.lang.String getAdminSettingsView()

Returns a String representing the admin settings view filename/URL ending.

Returns:

the admin settings view filename/URL ending as String.

setAdminSettingsView

public void setAdminSettingsView(java.lang.String name)

Sets the filename/URL ending for the admin settings view.

Parameters:

name - the admin settings view filename/URL ending as String.

getAdminLoginView

public java.lang.String getAdminLoginView()

Returns a String representing the admin login view filename/URL ending.

Returns:

the admin login view filename/URL ending as String.

setAdminLoginView

public void setAdminLoginView(java.lang.String name)

Sets the filename/URL ending for the admin login view.

Parameters:

name - the admin login view filename/URL ending as String.

getAdminStatusView

public java.lang.String getAdminStatusView()

Returns a String representing the admin status view filename/URL ending.

Returns:

the admin status view filename/URL ending as String.

setAdminStatusView

public void setAdminStatusView(java.lang.String name)

Sets the filename/URL ending for the admin status view.

Parameters:

name - the admin status view filename/URL ending as String.

getAdminMenuView

public java.lang.String getAdminMenuView()

Returns a String representing the admin menu view filename/URL ending.

Returns:

the admin menu view filename/URL ending as String.

setAdminMenuView

public void setAdminMenuView(java.lang.String name)

Sets the filename/URL ending for the admin menu view.

Parameters:

name - the admin menu view filename/URL ending as String.

getAdminErrorView

public java.lang.String getAdminErrorView()

Returns a String representing the admin error view filename/URL ending.

Returns:

the admin error view filename/URL ending as String.

setAdminErrorView

public void setAdminErrorView(java.lang.String name)

Sets the filename/URL ending for the admin error view.

Parameters:

name - the admin error view filename/URL ending as String.

getSystemLanguage

public java.lang.String getSystemLanguage()

i18n related

setSystemLanguage

public void setSystemLanguage(java.lang.String language)

getLanguageList

public java.lang.String[] getLanguageList()

setLanguageList

public void setLanguageList(java.lang.String[] languages)

getPrefPersistencePluginClassName

public java.lang.String getPrefPersistencePluginClassName()

END i18n related

setPrefPersistencePluginClassName

public void setPrefPersistencePluginClassName(java.lang.String classname)

getContactManagementPluginClassName

public java.lang.String getContactManagementPluginClassName()

setContactManagementPluginClassName

public void setContactManagementPluginClassName(java.lang.String classname)

getRandomAppendPluginClassName

public java.lang.String getRandomAppendPluginClassName()

setRandomAppendPluginClassName

public void setRandomAppendPluginClassName(java.lang.String classname)

getCategories

public java.lang.String[] getCategories()

setCategories

public void setCategories(java.lang.String[] cats)

load

public void load()
          throws JwmaException

Loads the properties file containing jwma's settings.

JwmaException

save

public void save()
          throws JwmaException

Saves the properties file containing jwma's settings.

JwmaException

getPath

public java.lang.String getPath()

Returns a String representing the settings file's path.

Returns:

the settings file path as String.

getDump

public java.lang.String getDump()

Returns a String representing the settings file's path.

Returns:

the settings file path as String.

createJwmaSettings

public static JwmaSettings createJwmaSettings(java.lang.String path)
                                       throws JwmaException

Creates a JwmaSettings instance.

Requires the path to the directory where jwma's files and folders reside. For the WAR the path should represent the "WEB-INF" directory.

Parameters:

path - the path to the directory where jwma's files and folders reside.

JwmaException