com.xhaus.modjy

Class ModjyJServlet

java.lang.Object

javax.servlet.GenericServlet

javax.servlet.http.HttpServlet

com.xhaus.modjy.ModjyJServlet

All Implemented Interfaces:

java.io.Serializable, javax.servlet.Servlet, javax.servlet.ServletConfig

public class ModjyJServlet
extends javax.servlet.http.HttpServlet

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected PythonInterpreter	interp
protected static java.lang.String	LIB_PYTHON
protected static java.lang.String	LOAD_SITE_PACKAGES_PARAM
protected static java.lang.String	MODJY_PYTHON_CLASSNAME
protected javax.servlet.http.HttpServlet	modjyServlet
protected static java.lang.String	PTH_FILE_EXTENSION
protected static java.lang.String	PYTHON_HOME_PARAM

Constructor Summary

Constructors

Constructor and Description
ModjyJServlet()

Method Summary

Modifier and Type	Method and Description
protected void	checkSitePackages(java.util.Properties props) Check if the user has requested to initialise the jython installation "site-packages".
void	destroy() Close down the modjy servlet.
void	init() Initialise the modjy servlet.
protected void	processPthFile(PythonInterpreter interp, PySystemState systemState, java.lang.String pythonLibPath, java.lang.String pthFilename) Process an individual file .pth file in the lib-python directory
protected void	processPythonLib(PythonInterpreter interp, PySystemState systemState) Do all processing in relation to the lib-python subdirectory of WEB-INF
protected java.util.Properties	readConfiguration() Read configuration 1.
void	service(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse resp) Actually service the incoming request.
protected void	setupEnvironment(PythonInterpreter interp, java.util.Properties props, PySystemState systemState) Setup the modjy environment, i.e.

Methods inherited from class javax.servlet.http.HttpServlet

doDelete, doGet, doHead, doOptions, doPost, doPut, doTrace, getLastModified, service

Methods inherited from class javax.servlet.GenericServlet

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

MODJY_PYTHON_CLASSNAME

protected static final java.lang.String MODJY_PYTHON_CLASSNAME

See Also:

Constant Field Values

LIB_PYTHON

protected static final java.lang.String LIB_PYTHON

See Also:

Constant Field Values

PTH_FILE_EXTENSION

protected static final java.lang.String PTH_FILE_EXTENSION

See Also:

Constant Field Values

LOAD_SITE_PACKAGES_PARAM

protected static final java.lang.String LOAD_SITE_PACKAGES_PARAM

See Also:

Constant Field Values

PYTHON_HOME_PARAM

protected static final java.lang.String PYTHON_HOME_PARAM

See Also:

Constant Field Values

interp

protected PythonInterpreter interp

modjyServlet

protected javax.servlet.http.HttpServlet modjyServlet

Constructor Detail

ModjyJServlet

public ModjyJServlet()

Method Detail

readConfiguration

protected java.util.Properties readConfiguration()

Read configuration 1. Both context and servlet parameters are included in the set, so that the definition of some parameters (e.g python.*) can be shared between multiple WSGI servlets. 2. servlet params take precedence over context parameters

init

public void init()
          throws javax.servlet.ServletException

Initialise the modjy servlet. 1. Read the configuration 2. Initialise the jython runtime 3. Setup, in relation to the J2EE servlet environment 4. Create the jython-implemented servlet 5. Initialise the jython-implemented servlet

Overrides:

init in class javax.servlet.GenericServlet

Throws:

javax.servlet.ServletException

service

public void service(javax.servlet.http.HttpServletRequest req,
                    javax.servlet.http.HttpServletResponse resp)
             throws javax.servlet.ServletException,
                    java.io.IOException

Actually service the incoming request. Simply delegate to the jython servlet.

Overrides:

service in class javax.servlet.http.HttpServlet

Parameters:

req - - The incoming HttpServletRequest

resp - - The outgoing HttpServletResponse

Throws:

javax.servlet.ServletException

java.io.IOException

destroy

public void destroy()

Close down the modjy servlet.

Specified by:

destroy in interface javax.servlet.Servlet

Overrides:

destroy in class javax.servlet.GenericServlet

setupEnvironment

protected void setupEnvironment(PythonInterpreter interp,
                                java.util.Properties props,
                                PySystemState systemState)
                         throws PyException

Setup the modjy environment, i.e. 1. Find the location of the modjy.jar file and add it to sys.path 2. Process the WEB-INF/lib-python directory, if it exists

Parameters:

interp - - The PythonInterpreter used to service requests

props - - The properties from which config options are found

systemState - - The PySystemState corresponding to the interpreter servicing requests

Throws:

PyException

checkSitePackages

protected void checkSitePackages(java.util.Properties props)
                          throws PyException

Check if the user has requested to initialise the jython installation "site-packages". The value defaults to true, i.e. load site packages

Parameters:

props - - The properties from which config options are found

Throws:

PyException

processPythonLib

protected void processPythonLib(PythonInterpreter interp,
                                PySystemState systemState)

Do all processing in relation to the lib-python subdirectory of WEB-INF

Parameters:

interp - - The PythonInterpreter used to service requests

systemState - - The PySystemState whose path should be updated

processPthFile

protected void processPthFile(PythonInterpreter interp,
                              PySystemState systemState,
                              java.lang.String pythonLibPath,
                              java.lang.String pthFilename)

Process an individual file .pth file in the lib-python directory

Parameters:

interp - - The PythonInterpreter which will execute imports

systemState - - The PySystemState whose path should be updated

pythonLibPath - - The actual path to the lib-python directory

pthFilename - - The PySystemState whose path should be updated