| java.lang.Object
 net.wastl.webmail.server.Storage
All known Subclasses: net.wastl.webmail.storage.FileStorage,
| Method Summary | |
| abstract public XMLUserData | createUserData(String user, String domain, String password)
| | public WebMailVirtualDomain | createVirtualDomain(String name)
| | public XMLAdminModel | createXMLAdminModel()
| | public XMLGenericModel | createXMLGenericModel()
Return a generic XML model that only contains some state and system information. | | public XMLUserModel | createXMLUserModel(XMLUserData data)
| | abstract public void | deleteUserData(String user, String domain)
| | public void | deleteUserData(String user)
| | public void | deleteVirtualDomain(String name)
| | abstract public Authenticator | getAuthenticator()
Return this Storage's Authenticator. | | public String | getBasePath(Locale locale, String theme)
| | abstract public byte[] | getBinaryFile(String name, Locale locale, String theme)
Get a binary file (most likely an image) for the specified locale and theme. | | public String | getConfig(String key)
Fetch the configuration associated with the specified key. | | public Enumeration | getConfigKeys()
Fetch all keys of the current configuration. | | public boolean | getDebug()
| | public String | getMimeType(String name)
| | abstract public String | getStringResource(String key, Locale locale)
Get the String for key and the specified locale. | | abstract public Templates | getStylesheet(String name, Locale locale, String theme)
Get a xsl stylesheet for the specified locale and theme. | | public XMLSystemData | getSystemData()
| | public XMLUserData | getUserData(String user, String domain, String passwd)
Get the userdata for the specified user. | | abstract public XMLUserData | getUserData(String user, String domain, String password, boolean authenticate)
get the userdata for the specified user. | | abstract public Enumeration | getUsers(String domain)
Return userlist for a given domain. | | public Enumeration | getUsers()
| | public WebMailVirtualDomain | getVirtualDomain(String name)
| | public Enumeration | getVirtualDomains()
| | public void | initConfigKeys()
| | abstract protected void | loadXMLSysData()
| | abstract public void | log(int level, String message)
Send a message to the logging facility. | | abstract public void | log(int level, Exception ex)
Send an exception to the logging facility. | | public void | save()
| | abstract public void | saveUserData(String user, String domain)
Save the userdata for the given user. | | abstract protected void | saveXMLSysData()
| | public void | setConfig(String key, String value)
Set a configuration "key" to the specified value. | | public void | setDebug(boolean b)
| | public void | setUserData(String user, UserData userdata)
Set the userdata for the specified user. | | public void | setVirtualDomain(String name, WebMailVirtualDomain v)
| | abstract public void | shutdown()
|
| LOG_CRIT | | final public static int LOG_CRIT(Code) | | |
| LOG_DEBUG | | final public static int LOG_DEBUG(Code) | | |
| LOG_ERR | | final public static int LOG_ERR(Code) | | |
| LOG_INFO | | final public static int LOG_INFO(Code) | | |
| LOG_WARN | | final public static int LOG_WARN(Code) | | |
| debug | | protected static boolean debug(Code) | | |
| createXMLAdminModel | | public XMLAdminModel createXMLAdminModel() throws WebMailException(Code) | | Return a XML model that contains state and system information for administrator use
|
| createXMLGenericModel | | public XMLGenericModel createXMLGenericModel() throws WebMailException(Code) | | Return a generic XML model that only contains some state and system information.
This cannot be changed by a single session.
|
| deleteUserData | | abstract public void deleteUserData(String user, String domain)(Code) | | Delete a WebMail user
Parameters:
user - Name of the user to delete
Parameters:
domain - Domain of that user |
| deleteUserData | | public void deleteUserData(String user)(Code) | | Delete a WebMail user
Parameters:
user - Name of the user to delete |
| deleteVirtualDomain | | public void deleteVirtualDomain(String name)(Code) | | Delete a WebMail virtual domain
|
| getAuthenticator | | abstract public Authenticator getAuthenticator()(Code) | | Return this Storage's Authenticator.
This is necessary for changing passwords or re-checking authentication.
|
| getBasePath | | public String getBasePath(Locale locale, String theme)(Code) | | Calculate the document base path for a given locale and theme
|
| getBinaryFile | | abstract public byte[] getBinaryFile(String name, Locale locale, String theme) throws BinaryNotFoundException(Code) | | Get a binary file (most likely an image) for the specified locale and theme.
Parameters:
key - Identifier for the String
Parameters:
locale - locale of the String to fetch
Parameters:
theme - theme where to look for the file |
| getConfig | | public String getConfig(String key)(Code) | | Fetch the configuration associated with the specified key.
Parameters:
key - Identifier for the configuration |
| getConfigKeys | | public Enumeration getConfigKeys()(Code) | | Fetch all keys of the current configuration.
|
| getDebug | | public boolean getDebug()(Code) | | |
| getStringResource | | abstract public String getStringResource(String key, Locale locale)(Code) | | Get the String for key and the specified locale.
Parameters:
key - Identifier for the String
Parameters:
locale - locale of the String to fetch |
| getStylesheet | | abstract public Templates getStylesheet(String name, Locale locale, String theme) throws WebMailException(Code) | | Get a xsl stylesheet for the specified locale and theme.
Parameters:
key - Identifier for the String
Parameters:
locale - locale of the String to fetch
Parameters:
theme - theme where to look for the file |
| getUserData | | public XMLUserData getUserData(String user, String domain, String passwd) throws UserDataException, InvalidPasswordException(Code) | | Get the userdata for the specified user.
Parameters:
user - Name of the user
Parameters:
domain - Virtual Domain name of the user
Parameters:
passwd - Password that the user provideddevink 7/15/2000 - deprecated, but left in for backwards compat.devink 9/24/2000 - not deprecated any moreXXX should passwd be a parameter? |
| getUserData | | abstract public XMLUserData getUserData(String user, String domain, String password, boolean authenticate) throws UserDataException, InvalidPasswordException(Code) | | get the userdata for the specified user.
Should do some sort of authentication if authentication is set. See
Authenticator class for example.
devink 7/15/2000 - depreciated, and is no longer abstract, so there is
no requirement to implement it.
devink 9/24/2000 - not depreciated, and is now abstract
|
| getVirtualDomains | | public Enumeration getVirtualDomains()(Code) | | Return a list of virtual domains
|
| initConfigKeys | | public void initConfigKeys()(Code) | | |
| loadXMLSysData | | abstract protected void loadXMLSysData()(Code) | | |
| log | | abstract public void log(int level, String message)(Code) | | Send a message to the logging facility.
Parameters:
level - severity level of the message
Parameters:
message - the message |
| log | | abstract public void log(int level, Exception ex)(Code) | | Send an exception to the logging facility.
Parameters:
level - severity level of the message
Parameters:
message - the message |
| saveUserData | | abstract public void saveUserData(String user, String domain)(Code) | | Save the userdata for the given user.
Parameters:
user - Username of this user
Parameters:
domain - Domain of this user |
| saveXMLSysData | | abstract protected void saveXMLSysData()(Code) | | |
| setConfig | | public void setConfig(String key, String value) throws IllegalArgumentException(Code) | | Set a configuration "key" to the specified value.
Parameters:
key - Identifier for the configuration
Parameters:
value - value to set |
| setDebug | | public void setDebug(boolean b)(Code) | | |
| setUserData | | public void setUserData(String user, UserData userdata)(Code) | | Set the userdata for the specified user.
Parameters:
user - Name of the user
Parameters:
userdata - Data to store |
| shutdown | | abstract public void shutdown()(Code) | | |
|
|