com.swfit.core.servlet
Class XHTMLBasicServlet

java.lang.Object
  |
  +--javax.servlet.GenericServlet
        |
        +--javax.servlet.http.HttpServlet
              |
              +--com.swfit.core.servlet.XHTMLBasicServlet
All Implemented Interfaces:
java.io.Serializable, javax.servlet.Servlet, javax.servlet.ServletConfig
Direct Known Subclasses:
MailList, MultiMailer, XHTMLPublishedObjectSearch, XHTMLPublishServlet, XHTMLTestServlet

public abstract class XHTMLBasicServlet
extends javax.servlet.http.HttpServlet

A XHTMLBasicServlet is the superclass of small standalone servlets, handling some common chores as storing text outside the code, generating a web interface for changing that text, sending the user to different methods if the request comes from a flash movie or a HTML document ...

Since:
SWFIT1.0
Version:
$Revision: 1.3 $ $Date: 2003/04/20 13:14:00 $
Author:
Olaf Havnes
See Also:
Serialized Form

Field Summary
static java.lang.String ANOTHER_USER_DATA_EXPLAINER
          Data needed to adapt displayed user data.
static java.lang.String COMMON_DATA_FILE
           
static java.lang.String DEFAULT_ADMIN
           
static java.lang.String DEFAULT_PASS
           
static java.lang.String DELETE_OTHR_USER_DATA_BUTTON_EXPLAINER
          The buttons needed to store user info.
static java.lang.String DELETE_USER_DATA_BUTTON
          The buttons needed to store user info.
static java.lang.String FORM_DIRECTORY
          Get the xhtml dummy to stuff the publishng forms into
static java.lang.String FORM_DUMMY
          Get the xhtml dummy to stuff the publishng forms into
static java.lang.String[] GET_DELETE_USER_DATA_BUTTON
          The buttons needed to store user info.
static java.lang.String[] GET_GOTO_APPLICATION
          The button needed to get past the user data screen.
static java.lang.String[] GET_NEW_PASSWORD_1
          The data needed to change passwords.
static java.lang.String[] GET_NEW_PASSWORD_2
          The data needed to change passwords.
static java.lang.String[] GET_NEW_USER_BUTTON
          The button needed to create a new user.
static java.lang.String[] GET_PASSWORD
          The data needed for a simple loginform.
static java.lang.String[] GET_SOS_BUTTON
          The data needed for a simple SOS login form...
static java.lang.String[] GET_SOS_USER
          The data needed for a simple SOS login form...
static java.lang.String[] GET_UPDATE_USER_DATA_BUTTON
          The buttons needed to store user info.
static java.lang.String[] GET_USERNAME
          The data needed for a simple loginform.
static java.lang.String GOTO_APPLICATION
          The button needed to get past the user data screen.
static java.lang.String GOTO_APPLICATION_EXPLAINER
          The button needed to get past the user data screen.
static java.lang.String GOTO_APPLICATION_FORM
          The button needed to get past the user data screen.
static java.lang.String LOCALE_TEXT
           
static java.lang.String LOCALE_TEXT_SUFFIX
           
static java.lang.String LOGIN_BUTTON
          The data needed for a simple loginform.
static java.lang.String LOGIN_BUTTON_EXPLAINER
          The data needed for a simple loginform.
static java.lang.String LOGIN_FORM
          The data needed for a simple loginform.
static java.lang.String LOGIN_FORM_EXPLAINER
          The data needed for a simple loginform.
static java.lang.String LOGON_STRING
          A way to render sessions & user/pass combinations from one servlet invalid on other servlets.
static int MIN_PASSWORD_LENGTH
           
static java.lang.String NEW_PASSWORD_1
          The data needed to change passwords.
static java.lang.String NEW_PASSWORD_2
          The data needed to change passwords.
static java.lang.String NEW_PASSWORD_FORM
          The data needed to change passwords.
static java.lang.String NEW_PASSWORD_FORM_EXPLAINER
          The data needed to change passwords.
static java.lang.String NEW_USER_BUTTON
          The button needed to create a new user.
static java.lang.String NEW_USER_BUTTON_EXPLAINER
          The button needed to create a new user.
static java.lang.String NEW_USER_BUTTON_FORM
          The button needed to create a new user.
static java.lang.String PASSWORD
          The data needed for a simple loginform.
static java.lang.String PASSWORD_EXPLAINER
          The data needed for a simple loginform.
static java.lang.String PASSWORD_HIDDEN
           
static java.lang.String RECEIPT_BUTTON
          Render a quick servlet reciept with a back button
static java.lang.String RECEIPT_BUTTON_EXPLAINER
          Render a quick servlet reciept with a back button
static java.lang.String RECEIPT_FORM
          Render a quick servlet reciept with a back button
static java.lang.String RECEIPT_FORM_EXPLAINER
          Render a quick servlet reciept with a back button
static java.lang.String RECEIPT_TRANSCRIPT
          Render a quick servlet reciept with a back button
static java.lang.String SERVLET_CODE
          A way to render sessions & user/pass combinations from one servlet invalid on other servlets.
static java.lang.String SOS_BUTTON
          The data needed for a simple SOS login form...
static java.lang.String SOS_BUTTON_EXPLAINER
          The data needed for a simple SOS login form...
static java.lang.String SOS_FORM
          The data needed for a simple SOS login form...
static java.lang.String SOS_FORM_EXPLAINER
          The data needed for a simple SOS login form...
static java.lang.String SOS_USER
          The data needed for a simple SOS login form...
static java.lang.String SOS_USER_EXPLAINER
          The data needed for a simple SOS login form...
static java.lang.String TRANSCRIPT_EXPLAINER
          Render a quick servlet reciept with a back button
static java.lang.String UPDATE_OTHR_USER_DATA_BUTTON_EXPLAINER
          The buttons needed to store user info.
static java.lang.String UPDATE_USER_DATA_BUTTON
          The buttons needed to store user info.
static java.lang.String UPDATE_YOUR_USER_DATA_BUTTON_EXPLAINER
          The buttons needed to store user info.
static java.lang.String USER_ADMIN_TITLE
           
static java.lang.String USER_DATA_BUTTON_FORM
          The buttons needed to store user info.
static java.lang.String USER_DATA_FORM
          Data needed to adapt displayed user data.
static java.lang.String USER_PASS_FILE
           
static java.lang.String USERNAME
          The data needed for a simple loginform.
static java.lang.String USERNAME_EXPLAINER
          The data needed for a simple loginform.
static java.lang.String YOUR_USER_DATA_EXPLAINER
          Data needed to adapt displayed user data.
 
Constructor Summary
XHTMLBasicServlet()
           
 
Method Summary
 java.lang.String bounceParameter(java.lang.String name)
          We make the assumtion that the parameter name will have some kind of meaning and return that if the real value is null
 java.lang.String[] bounceParameters(java.lang.String[] names)
           
protected  XHTMLDocument formDummy()
           
 XHTMLFieldCollection gotoAppForm()
           
abstract  void HTML(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, XHTMLFormParser parser, com.oreilly.servlet.MultipartRequest multipart_request, BasicSearchObject user)
          The main servlet method.
 void init(javax.servlet.ServletConfig config)
          If the ServletConfig handed to us is not an instance of MultiServletConfig, create one, and init the superclass.
 java.lang.String localeText(int text)
          We make the assumtion that the parameter name will have some kind of meaning and return that if the real value is null
abstract  java.lang.String[] localeTextNames()
          An array with the names of the strings containing the localized text.
 XHTMLFieldCollection loginForm()
           
 XHTMLFieldCollection newUserButtonForm()
           
 XHTMLFieldCollection passForm()
           
 int publishLocale()
           
 void sendPublishedReciept(javax.servlet.http.HttpServletResponse response, java.lang.String transcript)
           
 void sendReciept(javax.servlet.http.HttpServletResponse response, java.lang.String transcript, XHTMLDocument doc)
           
 void sendSystemReciept(javax.servlet.http.HttpServletResponse response, java.lang.String transcript)
           
 void service(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          The main servlet method, which handles all the common tasks.
 XHTMLFieldCollection sosForm()
           
 void SSI(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, XHTMLFormParser parser)
          Requests from Apache (through the Server Side Include directive) are usually much more simple (and will not contain any file uploads).
 void SWF(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, XHTMLFormParser parser)
          Requests from a flash movie needs to be handled differently, and as of yet (...), it will not contain any file uploads.
 XHTMLFieldCollection userDataButtonForm(boolean other)
           
 
Methods inherited from class javax.servlet.http.HttpServlet
doDelete, doGet, doOptions, doPost, doPut, doTrace, getLastModified, service
 
Methods inherited from class javax.servlet.GenericServlet
destroy, getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletInfo, getServletName, init, log, log
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

MIN_PASSWORD_LENGTH

public static final int MIN_PASSWORD_LENGTH

LOCALE_TEXT

public static final java.lang.String LOCALE_TEXT

COMMON_DATA_FILE

public static final java.lang.String COMMON_DATA_FILE

USER_PASS_FILE

public static final java.lang.String USER_PASS_FILE

LOCALE_TEXT_SUFFIX

public static final java.lang.String LOCALE_TEXT_SUFFIX

DEFAULT_ADMIN

public static final java.lang.String DEFAULT_ADMIN

DEFAULT_PASS

public static final java.lang.String DEFAULT_PASS

USER_ADMIN_TITLE

public static final java.lang.String USER_ADMIN_TITLE

PASSWORD_HIDDEN

public static final java.lang.String PASSWORD_HIDDEN

FORM_DIRECTORY

public static final java.lang.String FORM_DIRECTORY
Get the xhtml dummy to stuff the publishng forms into

FORM_DUMMY

public static final java.lang.String FORM_DUMMY
Get the xhtml dummy to stuff the publishng forms into

RECEIPT_FORM

public static final java.lang.String RECEIPT_FORM
Render a quick servlet reciept with a back button

RECEIPT_TRANSCRIPT

public static final java.lang.String RECEIPT_TRANSCRIPT
Render a quick servlet reciept with a back button

RECEIPT_BUTTON

public static final java.lang.String RECEIPT_BUTTON
Render a quick servlet reciept with a back button

RECEIPT_FORM_EXPLAINER

public static final java.lang.String RECEIPT_FORM_EXPLAINER
Render a quick servlet reciept with a back button

TRANSCRIPT_EXPLAINER

public static final java.lang.String TRANSCRIPT_EXPLAINER
Render a quick servlet reciept with a back button

RECEIPT_BUTTON_EXPLAINER

public static final java.lang.String RECEIPT_BUTTON_EXPLAINER
Render a quick servlet reciept with a back button

LOGIN_FORM

public static final java.lang.String LOGIN_FORM
The data needed for a simple loginform.

USERNAME

public static final java.lang.String USERNAME
The data needed for a simple loginform.

PASSWORD

public static final java.lang.String PASSWORD
The data needed for a simple loginform.

LOGIN_BUTTON

public static final java.lang.String LOGIN_BUTTON
The data needed for a simple loginform.

LOGIN_FORM_EXPLAINER

public static final java.lang.String LOGIN_FORM_EXPLAINER
The data needed for a simple loginform.

USERNAME_EXPLAINER

public static final java.lang.String USERNAME_EXPLAINER
The data needed for a simple loginform.

PASSWORD_EXPLAINER

public static final java.lang.String PASSWORD_EXPLAINER
The data needed for a simple loginform.

LOGIN_BUTTON_EXPLAINER

public static final java.lang.String LOGIN_BUTTON_EXPLAINER
The data needed for a simple loginform.

GET_USERNAME

public static final java.lang.String[] GET_USERNAME
The data needed for a simple loginform.

GET_PASSWORD

public static final java.lang.String[] GET_PASSWORD
The data needed for a simple loginform.

SOS_FORM

public static final java.lang.String SOS_FORM
The data needed for a simple SOS login form...

SOS_USER

public static final java.lang.String SOS_USER
The data needed for a simple SOS login form...

SOS_BUTTON

public static final java.lang.String SOS_BUTTON
The data needed for a simple SOS login form...

SOS_FORM_EXPLAINER

public static final java.lang.String SOS_FORM_EXPLAINER
The data needed for a simple SOS login form...

SOS_USER_EXPLAINER

public static final java.lang.String SOS_USER_EXPLAINER
The data needed for a simple SOS login form...

SOS_BUTTON_EXPLAINER

public static final java.lang.String SOS_BUTTON_EXPLAINER
The data needed for a simple SOS login form...

GET_SOS_USER

public static final java.lang.String[] GET_SOS_USER
The data needed for a simple SOS login form...

GET_SOS_BUTTON

public static final java.lang.String[] GET_SOS_BUTTON
The data needed for a simple SOS login form...

NEW_PASSWORD_FORM

public static final java.lang.String NEW_PASSWORD_FORM
The data needed to change passwords.

NEW_PASSWORD_1

public static final java.lang.String NEW_PASSWORD_1
The data needed to change passwords.

NEW_PASSWORD_2

public static final java.lang.String NEW_PASSWORD_2
The data needed to change passwords.

NEW_PASSWORD_FORM_EXPLAINER

public static final java.lang.String NEW_PASSWORD_FORM_EXPLAINER
The data needed to change passwords.

GET_NEW_PASSWORD_1

public static final java.lang.String[] GET_NEW_PASSWORD_1
The data needed to change passwords.

GET_NEW_PASSWORD_2

public static final java.lang.String[] GET_NEW_PASSWORD_2
The data needed to change passwords.

GOTO_APPLICATION_FORM

public static final java.lang.String GOTO_APPLICATION_FORM
The button needed to get past the user data screen.

GOTO_APPLICATION

public static final java.lang.String GOTO_APPLICATION
The button needed to get past the user data screen.

GOTO_APPLICATION_EXPLAINER

public static final java.lang.String GOTO_APPLICATION_EXPLAINER
The button needed to get past the user data screen.

GET_GOTO_APPLICATION

public static final java.lang.String[] GET_GOTO_APPLICATION
The button needed to get past the user data screen.

USER_DATA_BUTTON_FORM

public static final java.lang.String USER_DATA_BUTTON_FORM
The buttons needed to store user info.

UPDATE_USER_DATA_BUTTON

public static final java.lang.String UPDATE_USER_DATA_BUTTON
The buttons needed to store user info.

DELETE_USER_DATA_BUTTON

public static final java.lang.String DELETE_USER_DATA_BUTTON
The buttons needed to store user info.

UPDATE_YOUR_USER_DATA_BUTTON_EXPLAINER

public static final java.lang.String UPDATE_YOUR_USER_DATA_BUTTON_EXPLAINER
The buttons needed to store user info.

UPDATE_OTHR_USER_DATA_BUTTON_EXPLAINER

public static final java.lang.String UPDATE_OTHR_USER_DATA_BUTTON_EXPLAINER
The buttons needed to store user info.

DELETE_OTHR_USER_DATA_BUTTON_EXPLAINER

public static final java.lang.String DELETE_OTHR_USER_DATA_BUTTON_EXPLAINER
The buttons needed to store user info.

GET_UPDATE_USER_DATA_BUTTON

public static final java.lang.String[] GET_UPDATE_USER_DATA_BUTTON
The buttons needed to store user info.

GET_DELETE_USER_DATA_BUTTON

public static final java.lang.String[] GET_DELETE_USER_DATA_BUTTON
The buttons needed to store user info.

NEW_USER_BUTTON_FORM

public static final java.lang.String NEW_USER_BUTTON_FORM
The button needed to create a new user.

NEW_USER_BUTTON

public static final java.lang.String NEW_USER_BUTTON
The button needed to create a new user.

NEW_USER_BUTTON_EXPLAINER

public static final java.lang.String NEW_USER_BUTTON_EXPLAINER
The button needed to create a new user.

GET_NEW_USER_BUTTON

public static final java.lang.String[] GET_NEW_USER_BUTTON
The button needed to create a new user.

USER_DATA_FORM

public static final java.lang.String USER_DATA_FORM
Data needed to adapt displayed user data.

YOUR_USER_DATA_EXPLAINER

public static final java.lang.String YOUR_USER_DATA_EXPLAINER
Data needed to adapt displayed user data.

ANOTHER_USER_DATA_EXPLAINER

public static final java.lang.String ANOTHER_USER_DATA_EXPLAINER
Data needed to adapt displayed user data.

LOGON_STRING

public static final java.lang.String LOGON_STRING
A way to render sessions & user/pass combinations from one servlet invalid on other servlets. Just put a unique parameter named "servlet_code" in the web.xml file.

SERVLET_CODE

public static final java.lang.String SERVLET_CODE
A way to render sessions & user/pass combinations from one servlet invalid on other servlets. Just put a unique parameter named "servlet_code" in the web.xml file.
Constructor Detail

XHTMLBasicServlet

public XHTMLBasicServlet()
Method Detail

localeTextNames

public abstract java.lang.String[] localeTextNames()
An array with the names of the strings containing the localized text. Subclasses must implement this method.

localeText

public java.lang.String localeText(int text)
We make the assumtion that the parameter name will have some kind of meaning and return that if the real value is null

publishLocale

public int publishLocale()

bounceParameter

public java.lang.String bounceParameter(java.lang.String name)
We make the assumtion that the parameter name will have some kind of meaning and return that if the real value is null

bounceParameters

public java.lang.String[] bounceParameters(java.lang.String[] names)

formDummy

protected final XHTMLDocument formDummy()

HTML

public abstract void HTML(javax.servlet.http.HttpServletRequest request,
                          javax.servlet.http.HttpServletResponse response,
                          XHTMLFormParser parser,
                          com.oreilly.servlet.MultipartRequest multipart_request,
                          BasicSearchObject user)
                   throws java.io.IOException,
                          javax.servlet.ServletException
The main servlet method.

SWF

public void SWF(javax.servlet.http.HttpServletRequest request,
                javax.servlet.http.HttpServletResponse response,
                XHTMLFormParser parser)
         throws java.io.IOException,
                javax.servlet.ServletException
Requests from a flash movie needs to be handled differently, and as of yet (...), it will not contain any file uploads.

SSI

public void SSI(javax.servlet.http.HttpServletRequest request,
                javax.servlet.http.HttpServletResponse response,
                XHTMLFormParser parser)
         throws java.io.IOException,
                javax.servlet.ServletException
Requests from Apache (through the Server Side Include directive) are usually much more simple (and will not contain any file uploads).

init

public void init(javax.servlet.ServletConfig config)
          throws javax.servlet.ServletException
If the ServletConfig handed to us is not an instance of MultiServletConfig, create one, and init the superclass.
Overrides:
init in class javax.servlet.GenericServlet

service

public void service(javax.servlet.http.HttpServletRequest request,
                    javax.servlet.http.HttpServletResponse response)
             throws java.io.IOException,
                    javax.servlet.ServletException
The main servlet method, which handles all the common tasks.
Overrides:
service in class javax.servlet.http.HttpServlet

sendPublishedReciept

public final void sendPublishedReciept(javax.servlet.http.HttpServletResponse response,
                                       java.lang.String transcript)
                                throws java.io.IOException

sendSystemReciept

public final void sendSystemReciept(javax.servlet.http.HttpServletResponse response,
                                    java.lang.String transcript)
                             throws java.io.IOException

sendReciept

public final void sendReciept(javax.servlet.http.HttpServletResponse response,
                              java.lang.String transcript,
                              XHTMLDocument doc)
                       throws java.io.IOException

loginForm

public final XHTMLFieldCollection loginForm()

sosForm

public final XHTMLFieldCollection sosForm()

passForm

public final XHTMLFieldCollection passForm()

gotoAppForm

public final XHTMLFieldCollection gotoAppForm()

userDataButtonForm

public final XHTMLFieldCollection userDataButtonForm(boolean other)

newUserButtonForm

public final XHTMLFieldCollection newUserButtonForm()


Swfit developer homepage
Copyright © 2003 Orgdot AS. All Rights Reserved.