| de.schlund.pfixxml.ServletManager
 de.schlund.pfixxml.AbstractXMLServlet
All known Subclasses: de.schlund.pfixxml.ContextXMLServlet,
| AbstractXMLServlet | | abstract public class AbstractXMLServlet extends ServletManager (Code) | | This class is at the top of the XML/XSLT System.
It serves as an abstract parent class for all servlets
needing access to the XML/XSL cache system povided by
de.schlund.pfixxml.TargetGenerator.
Servlets inheriting from this class need to implement
getDom(HttpServletRequest req, HttpServletResponse res)
which returns a SPDocument.
|
| Inner Class :public class RegisterFrameHelper | |
| Method Summary | |
| abstract protected AbstractXMLServletConfig | getAbstractXMLServletConfig()
| | abstract protected SPDocument | getDom(PfixServletRequest preq)
A child of AbstractXMLServlet must implement this method. | | protected ServletManagerConfig | getServletManagerConfig()
| | protected void | handleDocument(PfixServletRequest preq, HttpServletResponse res, SPDocument spdoc, Properties params, boolean doreuse)
| | protected void | hookAfterRender(PfixServletRequest preq, SPDocument spdoc, TreeMap<String, Object> paramhash, String stylesheet)
Called after the XML result tree is rendered. | | protected void | hookBeforeRender(PfixServletRequest preq, SPDocument spdoc, TreeMap<String, Object> paramhash, String stylesheet)
Called before the XML result tree is rendered. | | public void | init(ServletConfig config)
Init method of all servlets inheriting from AbstractXMLServlets.
It calls super.init(Config) as a first step.
Parameters:
ContextXMLServletConfig - config. | | protected void | process(PfixServletRequest preq, HttpServletResponse res)
This is the method that is called for any servlet that inherits from ServletManager. | | protected boolean | tryReloadProperties(PfixServletRequest preq)
|
| DEF_PROP_TMPDIR | | final public static String DEF_PROP_TMPDIR(Code) | | |
| PARAM_XMLONLY_FONTIFY | | final public static String PARAM_XMLONLY_FONTIFY(Code) | | |
| PARAM_XMLONLY_XMLONLY | | final public static String PARAM_XMLONLY_XMLONLY(Code) | | |
| PROP_ADD_TRAIL_INFO | | final protected static String PROP_ADD_TRAIL_INFO(Code) | | |
| PROP_CLEANER_TO | | final protected static String PROP_CLEANER_TO(Code) | | |
| PROP_MAX_STORED_DOMS | | final protected static String PROP_MAX_STORED_DOMS(Code) | | |
| PROP_PROHIBITDEBUG | | final protected static String PROP_PROHIBITDEBUG(Code) | | |
| PROP_PROHIBITINFO | | final protected static String PROP_PROHIBITINFO(Code) | | |
| PROP_RENDER_EXT | | final protected static String PROP_RENDER_EXT(Code) | | |
| PROP_SKIP_GETMODTIME_MU | | final protected static String PROP_SKIP_GETMODTIME_MU(Code) | | |
| SESS_CLEANUP_FLAG_STAGE1 | | final public static String SESS_CLEANUP_FLAG_STAGE1(Code) | | |
| SESS_CLEANUP_FLAG_STAGE2 | | final public static String SESS_CLEANUP_FLAG_STAGE2(Code) | | |
| generator | | protected TargetGenerator generator(Code) | | Holds the TargetGenerator which is the XML/XSL Cache for this
class of servlets.
|
| servletname | | protected String servletname(Code) | | The unique Name of this servlet, needed to create a Namespace in
the HttpSession Session.
|
| hookAfterRender | | protected void hookAfterRender(PfixServletRequest preq, SPDocument spdoc, TreeMap<String, Object> paramhash, String stylesheet)(Code) | | Called after the XML result tree is rendered. This method can
be overidden in sub-implementations to do de-initializiation stuff.
This method is guaranteed to be always called, when the corresponding
before method has been called - even if an error occurs.
Parameters:
preq - current servlet request
Parameters:
spdoc - XML document going to be rendered
Parameters:
paramhash - parameters supplied to XSLT code
Parameters:
stylesheet - name of the stylesheet being used |
| hookBeforeRender | | protected void hookBeforeRender(PfixServletRequest preq, SPDocument spdoc, TreeMap<String, Object> paramhash, String stylesheet)(Code) | | Called before the XML result tree is rendered. This method can
be overidden in sub-implementations to do initializiation stuff,
which might be needed for XSLT callback methods.
Parameters:
preq - current servlet request
Parameters:
spdoc - XML document going to be rendered
Parameters:
paramhash - parameters supplied to XSLT code
Parameters:
stylesheet - name of the stylesheet being used |
| init | | public void init(ServletConfig config) throws ServletException(Code) | | Init method of all servlets inheriting from AbstractXMLServlets.
It calls super.init(Config) as a first step.
Parameters:
ContextXMLServletConfig - config. Passed in from the servlet container. void
exception:
ServletException - thrown when the initialisation goes havoc somehow |
| process | | protected void process(PfixServletRequest preq, HttpServletResponse res) throws Exception(Code) | | This is the method that is called for any servlet that inherits from ServletManager.
It calls getDom(req, res) to get the SPDocument doc.
This SPDocument is stored in the HttpSession so it can be reused if
the request parameter __reuse is set to a timestamp matching the timestamp of the saved SPDocument.
In other words, if the request parameter __reuse is
there and it is set to a matching timestamp, getDom(req,res)
will not be called, instead the saved Dom tree from the previous request
to this servlet will be used.
Request parameters that are put into the gen_params Hash:
__frame
__uri
__sessid
__editmode
__reusestamp
lang
Parameters:
PfixServletRequest - req
Parameters:
HttpServletResponse - res
exception:
Exception - |
|
|