org.alltimeflashdreamer.mailwebform
Interface MailWebFormConstants

All Known Implementing Classes:
AbstractMailWebFormServlet, GlobalProperties, GlobalPropertiesFileWriter, IndividualPropertiesFileWriter, JSPBean, MailFormProvider

public interface MailWebFormConstants

Title: MailWebFormConstants
Description: "Storage" for all the constants used in the MailWebForm application. This list is designed to be implementable for classes accessing those constants frequently.

Version:
0.9
Author:
Copyright (c) 2001-2004 Florian Steinsiepe, Adrian Zaugg

Field Summary
static String ADMIN
          key for the administrator's password file properties
static String ADMINSERVLET
          name of the deployed AdminServlet
static String APPNAME
          value used for the self-identification
static String COOKIENAME
          name of the cookie that is written after successful login
static String CURRENTUSER
          name of the session variable that stores the name of the currently logged in user
static String ERROR_URL
          key for the property specifying the redirect address after an unsuccessful mail sending
static String FILESEPARATOR
          stores an easy accessible copy of the system's file separator string
static String JSPBEAN
          key for accessing the JSPBean instance in the session
static String MAILFORMPROVIDER
          key start for provider-specific properties
static String MAILFORMPROVIDERLIST
          key for the list of currently active providers property
static String MAILWEBFORM
          often used app name (version independent)
static String MAILWEBFORMSERVLET
          name of the deployed MailWebFormServlet
static String NEWLINE
          stores an easy accessible copy of the system's line separator string
static String PARAM_ADD
           
static String PARAM_APPLYGLOBAL
           
static String PARAM_APPLYINDIVIDUAL
           
static String PARAM_CANCEL
           
static String PARAM_CHANGE_CREDENTIALS
           
static String PARAM_CONFIGFILE
           
static String PARAM_CREDENTIALS_ADMIN
           
static String PARAM_EDIT
           
static String PARAM_ERRORURL
           
static String PARAM_FROMEMAIL
           
static String PARAM_FROMNAME
           
static String PARAM_LOGIN
           
static String PARAM_LOGOUT
           
static String PARAM_OVERWRITE
           
static String PARAM_PASSWORD
           
static String PARAM_PASSWORD_PROVIDER
           
static String PARAM_PROVIDER
           
static String PARAM_PROVIDERDIRECTORY
           
static String PARAM_REMOVE
           
static String PARAM_SMTPHOST
           
static String PARAM_SMTPPORT
           
static String PARAM_SPAMURL
           
static String PARAM_STORE
           
static String PARAM_SUBJECT
           
static String PARAM_SUCCESSURL
           
static String PARAM_TEMPLATE
           
static String PARAM_TEXT
           
static String PARAM_TOADDRESS
           
static String PARAM_TONAME
           
static String PARAM_USERNAME
           
static String PASSWORD
          key for the password file's password properties
static String PASSWORDFILE
          the name of the user credentials file which must reside in the app's config directory
static String PLACEHOLDER_END
          end of a placeholder entry within a template file
static String PLACEHOLDER_START
          beginning of a placeholder entry within a template file
static String PROPERTY_CONFIGDIR
          name of the Java System Property pointing to the app's config directory
static String PROPERTY_SUFFIX
          suffix of the individual property files within the config or the provider directory
static String PROVIDERDIRECTORY
          key of the property for the location of the provider's own property file and/or mail template
static String RESOURCENAME
          the name of the global properties file which must reside in the app's config directory
static String SITE_CHANGE_CREDENTIALS
          name of the change admin credentials or provider password JSP site
static String SITE_DEFAULTFORM
          name of the JSP site showing the default (mail web) form
static String SITE_EDIT
          name of the add-or-edit provider JSP site
static String SITE_ERROR
          name of the error-showing JSP site
static String SITE_FOOTER
          name of the included footer HTML site
static String SITE_HEADER
          name of the included header HTML site
static String SITE_LOGIN
          name of the login JSP site
static String SITE_MAIN
          name of the app's main JSP site
static String SITE_PROVIDER
          name of the edit provider JSP site (individual version)
static String SMTP_ALLOWOVERWRITE
          key for provider's is-allowed-to-overwrite-the-smtp-server property
static String SMTP_HOST
          key for the SMTP host name property
static String SMTP_PORT
          key for the SMTP port number property
static String SPAMERROR_URL
          key for the property specifying the redirect address after a detected spam error
static String SUCCESS_URL
          key for the property specifying the redirect address after a successful mail sending
static String SYSTEMPROVIDER
          name of the system provider, i.e. the built-in one
static String TEMPLATE
          key for provider's template property
static String TEMPLATE_SUFFIX
          suffix of the template files within the config directory or the provider directory
static String TOADDRESS
          key for provider's to-address property
static String TONAME
          key for provider's to-name property
static String USERNAME
          key for the password file's user name properties
 

Field Detail

MAILWEBFORM

public static final String MAILWEBFORM
often used app name (version independent)

See Also:
Constant Field Values

APPNAME

public static final String APPNAME
value used for the self-identification

See Also:
Constant Field Values

PROPERTY_CONFIGDIR

public static final String PROPERTY_CONFIGDIR
name of the Java System Property pointing to the app's config directory


PROPERTY_SUFFIX

public static final String PROPERTY_SUFFIX
suffix of the individual property files within the config or the provider directory

See Also:
Constant Field Values

TEMPLATE_SUFFIX

public static final String TEMPLATE_SUFFIX
suffix of the template files within the config directory or the provider directory

See Also:
Constant Field Values

PLACEHOLDER_START

public static final String PLACEHOLDER_START
beginning of a placeholder entry within a template file

See Also:
Constant Field Values

PLACEHOLDER_END

public static final String PLACEHOLDER_END
end of a placeholder entry within a template file

See Also:
Constant Field Values

RESOURCENAME

public static final String RESOURCENAME
the name of the global properties file which must reside in the app's config directory


PASSWORDFILE

public static final String PASSWORDFILE
the name of the user credentials file which must reside in the app's config directory


COOKIENAME

public static final String COOKIENAME
name of the cookie that is written after successful login


SYSTEMPROVIDER

public static final String SYSTEMPROVIDER
name of the system provider, i.e. the built-in one

See Also:
Constant Field Values

CURRENTUSER

public static final String CURRENTUSER
name of the session variable that stores the name of the currently logged in user

See Also:
Constant Field Values

NEWLINE

public static final String NEWLINE
stores an easy accessible copy of the system's line separator string


FILESEPARATOR

public static final String FILESEPARATOR
stores an easy accessible copy of the system's file separator string


SMTP_HOST

public static final String SMTP_HOST
key for the SMTP host name property

See Also:
Constant Field Values

SMTP_PORT

public static final String SMTP_PORT
key for the SMTP port number property

See Also:
Constant Field Values

SUCCESS_URL

public static final String SUCCESS_URL
key for the property specifying the redirect address after a successful mail sending

See Also:
Constant Field Values

ERROR_URL

public static final String ERROR_URL
key for the property specifying the redirect address after an unsuccessful mail sending

See Also:
Constant Field Values

SPAMERROR_URL

public static final String SPAMERROR_URL
key for the property specifying the redirect address after a detected spam error

See Also:
Constant Field Values

ADMIN

public static final String ADMIN
key for the administrator's password file properties

See Also:
Constant Field Values

USERNAME

public static final String USERNAME
key for the password file's user name properties

See Also:
Constant Field Values

PASSWORD

public static final String PASSWORD
key for the password file's password properties

See Also:
Constant Field Values

MAILFORMPROVIDER

public static final String MAILFORMPROVIDER
key start for provider-specific properties

See Also:
Constant Field Values

MAILFORMPROVIDERLIST

public static final String MAILFORMPROVIDERLIST
key for the list of currently active providers property

See Also:
Constant Field Values

PROVIDERDIRECTORY

public static final String PROVIDERDIRECTORY
key of the property for the location of the provider's own property file and/or mail template

See Also:
Constant Field Values

TONAME

public static final String TONAME
key for provider's to-name property

See Also:
Constant Field Values

TOADDRESS

public static final String TOADDRESS
key for provider's to-address property

See Also:
Constant Field Values

TEMPLATE

public static final String TEMPLATE
key for provider's template property

See Also:
Constant Field Values

SMTP_ALLOWOVERWRITE

public static final String SMTP_ALLOWOVERWRITE
key for provider's is-allowed-to-overwrite-the-smtp-server property

See Also:
Constant Field Values

JSPBEAN

public static final String JSPBEAN
key for accessing the JSPBean instance in the session

See Also:
Constant Field Values

MAILWEBFORMSERVLET

public static final String MAILWEBFORMSERVLET
name of the deployed MailWebFormServlet


ADMINSERVLET

public static final String ADMINSERVLET
name of the deployed AdminServlet


SITE_LOGIN

public static final String SITE_LOGIN
name of the login JSP site

See Also:
Constant Field Values

SITE_MAIN

public static final String SITE_MAIN
name of the app's main JSP site

See Also:
Constant Field Values

SITE_ERROR

public static final String SITE_ERROR
name of the error-showing JSP site

See Also:
Constant Field Values

SITE_EDIT

public static final String SITE_EDIT
name of the add-or-edit provider JSP site

See Also:
Constant Field Values

SITE_DEFAULTFORM

public static final String SITE_DEFAULTFORM
name of the JSP site showing the default (mail web) form

See Also:
Constant Field Values

SITE_PROVIDER

public static final String SITE_PROVIDER
name of the edit provider JSP site (individual version)

See Also:
Constant Field Values

SITE_CHANGE_CREDENTIALS

public static final String SITE_CHANGE_CREDENTIALS
name of the change admin credentials or provider password JSP site

See Also:
Constant Field Values

SITE_HEADER

public static final String SITE_HEADER
name of the included header HTML site

See Also:
Constant Field Values

SITE_FOOTER

public static final String SITE_FOOTER
name of the included footer HTML site

See Also:
Constant Field Values

PARAM_ADD

public static final String PARAM_ADD
See Also:
Constant Field Values

PARAM_APPLYGLOBAL

public static final String PARAM_APPLYGLOBAL
See Also:
Constant Field Values

PARAM_APPLYINDIVIDUAL

public static final String PARAM_APPLYINDIVIDUAL
See Also:
Constant Field Values

PARAM_CANCEL

public static final String PARAM_CANCEL
See Also:
Constant Field Values

PARAM_CHANGE_CREDENTIALS

public static final String PARAM_CHANGE_CREDENTIALS
See Also:
Constant Field Values

PARAM_CREDENTIALS_ADMIN

public static final String PARAM_CREDENTIALS_ADMIN
See Also:
Constant Field Values

PARAM_PASSWORD_PROVIDER

public static final String PARAM_PASSWORD_PROVIDER
See Also:
Constant Field Values

PARAM_CONFIGFILE

public static final String PARAM_CONFIGFILE
See Also:
Constant Field Values

PARAM_EDIT

public static final String PARAM_EDIT
See Also:
Constant Field Values

PARAM_ERRORURL

public static final String PARAM_ERRORURL
See Also:
Constant Field Values

PARAM_FROMEMAIL

public static final String PARAM_FROMEMAIL
See Also:
Constant Field Values

PARAM_FROMNAME

public static final String PARAM_FROMNAME
See Also:
Constant Field Values

PARAM_PROVIDERDIRECTORY

public static final String PARAM_PROVIDERDIRECTORY
See Also:
Constant Field Values

PARAM_LOGIN

public static final String PARAM_LOGIN
See Also:
Constant Field Values

PARAM_LOGOUT

public static final String PARAM_LOGOUT
See Also:
Constant Field Values

PARAM_OVERWRITE

public static final String PARAM_OVERWRITE
See Also:
Constant Field Values

PARAM_PASSWORD

public static final String PARAM_PASSWORD
See Also:
Constant Field Values

PARAM_PROVIDER

public static final String PARAM_PROVIDER
See Also:
Constant Field Values

PARAM_REMOVE

public static final String PARAM_REMOVE
See Also:
Constant Field Values

PARAM_SMTPHOST

public static final String PARAM_SMTPHOST
See Also:
Constant Field Values

PARAM_SMTPPORT

public static final String PARAM_SMTPPORT
See Also:
Constant Field Values

PARAM_SPAMURL

public static final String PARAM_SPAMURL
See Also:
Constant Field Values

PARAM_STORE

public static final String PARAM_STORE
See Also:
Constant Field Values

PARAM_SUBJECT

public static final String PARAM_SUBJECT
See Also:
Constant Field Values

PARAM_SUCCESSURL

public static final String PARAM_SUCCESSURL
See Also:
Constant Field Values

PARAM_TEMPLATE

public static final String PARAM_TEMPLATE
See Also:
Constant Field Values

PARAM_TEXT

public static final String PARAM_TEXT
See Also:
Constant Field Values

PARAM_TOADDRESS

public static final String PARAM_TOADDRESS
See Also:
Constant Field Values

PARAM_TONAME

public static final String PARAM_TONAME
See Also:
Constant Field Values

PARAM_USERNAME

public static final String PARAM_USERNAME
See Also:
Constant Field Values