Jython 2.7.4 · org.python.util.PyServlet · APIdia, the JavaDoc alternative

This servlet is used to re-serve Jython servlets. It stores bytecode for Jython servlets and re-uses it if the underlying .py file has not changed.

e.g. http://localhost:8080/test/hello.py

from javax.servlet.http import HttpServlet
class hello(HttpServlet):
    def doGet(self, req, res):
        res.setContentType("text/html");
        out = res.getOutputStream()
        print >>out, "<html>"
        print >>out, "<head><title>Hello World, How are we?</title></head>"
        print >>out, "<body>Hello World, how are we?"
        print >>out, "</body>"
        print >>out, "</html>"
        out.close()

in web.xml for the PyServlet context:

<web-app>
    <servlet>
        <servlet-name>PyServlet</servlet-name>
        <servlet-class>org.python.util.PyServlet</servlet-class>
        <init-param>
            <param-name>python.home</param-name>
            <param-value>/usr/home/jython-2.5</param-value>
        </init-param>
    </servlet>
    <servlet-mapping>
        <servlet-name>PyServlet</servlet-name>
        <url-pattern>*.py</url-pattern>
    </servlet-mapping>
</web-app>

Nested and Inner Type Summary

Modifier and Type	Class and Description
private static class	PyServlet.CacheEntry

Field Summary

Modifier and Type	Field and Description
private Map<String, PyServlet.CacheEntry>	cache
private static final Pattern	FIND_NAME
protected static final String	INIT_ATTR
private PythonInterpreter	interp
protected static final Logger	logger
public static final String	SKIP_INIT_NAME

Constructor Summary

Access	Constructor and Description
public	PyServlet()

Method Summary

Modifier and Type	Method and Description
protected static <T> T	createInstance(PythonInterpreter interp, File file, Class<T> type)
protected static PythonInterpreter	createInterpreter(ServletContext servletContext)
public void	destroy() Overrides javax.servlet.GenericServlet.destroy. Implements javax.servlet.Servlet.destroy. Called by the servlet container to indicate to a servlet that the servlet is being taken out of service.
private void	destroyCache()
protected static String	getRootPath(ServletContext context)
private synchronized HttpServlet	getServlet(String path)
public void	init() Overrides javax.servlet.GenericServlet.init. A convenience method which can be overridden so that there's no need to call `super.init(config)`.
protected static void	init(Properties props, ServletContext context) PyServlet's initialization can be performed as a ServletContextListener or as a regular servlet, and this is the shared init code.
private HttpServlet	loadServlet(String path)
public void	reset() Clears the cache of loaded servlets and makes a new PythonInterpreter to service further requests.
public void	service(ServletRequest the `HttpServletRequest` object that contains the request the client made of the servlet req, ServletResponse the `HttpServletResponse` object that contains the response the servlet returns to the client res) Overrides javax.servlet.http.HttpServlet.service. Implements javax.servlet.Servlet.service. Dispatches client requests to the protected `service` method.

Inherited from javax.servlet.http.HttpServlet:: doDelete doGet doHead doOptions doPost doPut doTrace getLastModified service

Field Detail

cache	back to summary
private Map<String, PyServlet.CacheEntry> cache

FIND_NAME	back to summary
private static final Pattern FIND_NAME

INIT_ATTR	back to summary
protected static final String INIT_ATTR

interp	back to summary
private PythonInterpreter interp

logger	back to summary
protected static final Logger logger

SKIP_INIT_NAME	back to summary
public static final String SKIP_INIT_NAME

Constructor Detail

PyServlet	back to summary
public PyServlet()

Method Detail

createInstance	back to summary
protected static <T> T createInstance(PythonInterpreter interp, File file, Class<T> type) throws ServletException

createInterpreter	back to summary
protected static PythonInterpreter createInterpreter(ServletContext servletContext)

destroy back to summary

destroy	back to summary
public void destroy() Overrides javax.servlet.GenericServlet.destroy. Implements javax.servlet.Servlet.destroy. Doc from javax.servlet.GenericServlet.destroy. Called by the servlet container to indicate to a servlet that the servlet is being taken out of service. See `Servlet#destroy`. Annotations @Override

public void destroy()

Overrides javax.servlet.GenericServlet.destroy.

Implements javax.servlet.Servlet.destroy.

Doc from javax.servlet.GenericServlet.destroy.

Called by the servlet container to indicate to a servlet that the servlet is being taken out of service. See Servlet#destroy.

Annotations

@Override

destroyCache	back to summary
private void destroyCache()

getRootPath	back to summary
protected static String getRootPath(ServletContext context)

getServlet	back to summary
private synchronized HttpServlet getServlet(String path) throws ServletException, IOException

init back to summary

init	back to summary
public void init() Overrides javax.servlet.GenericServlet.init. Doc from javax.servlet.GenericServlet.init. A convenience method which can be overridden so that there's no need to call `super.init(config)`. Instead of overriding `init(ServletConfig)`, simply override this method and it will be called by `GenericServlet.init(ServletConfig config)`. The `ServletConfig` object can still be retrieved via `getServletConfig`. Annotations @Override

public void init()

Overrides javax.servlet.GenericServlet.init.

Doc from javax.servlet.GenericServlet.init.

A convenience method which can be overridden so that there's no need to call super.init(config).

Instead of overriding init(ServletConfig), simply override this method and it will be called by GenericServlet.init(ServletConfig config). The ServletConfig object can still be retrieved via getServletConfig.

Annotations

@Override

init	back to summary
protected static void init(Properties props, ServletContext context) PyServlet's initialization can be performed as a ServletContextListener or as a regular servlet, and this is the shared init code. If both initializations are used in a single context, the system state initialization code only runs once.

loadServlet	back to summary
private HttpServlet loadServlet(String path) throws ServletException, IOException

reset	back to summary
public void reset() Clears the cache of loaded servlets and makes a new PythonInterpreter to service further requests.

service back to summary

service	back to summary
public void service(ServletRequest req, ServletResponse res) throws ServletException, IOException Overrides javax.servlet.http.HttpServlet.service. Implements javax.servlet.Servlet.service. Doc from javax.servlet.http.HttpServlet.service. Dispatches client requests to the protected `service` method. There's no need to override this method. Parameters req:ServletRequest the `HttpServletRequest` object that contains the request the client made of the servlet res:ServletResponse the `HttpServletResponse` object that contains the response the servlet returns to the client Annotations @Override Exceptions ServletException: if the HTTP request cannot be handled or if either parameter is not an instance of its respective `HttpServletRequest` or `HttpServletResponse` counterparts. IOException: if an input or output error occurs while the servlet is handling the HTTP request

public void service(ServletRequest req, ServletResponse res) throws ServletException, IOException

Overrides javax.servlet.http.HttpServlet.service.

Implements javax.servlet.Servlet.service.

Doc from javax.servlet.http.HttpServlet.service.

Dispatches client requests to the protected service method. There's no need to override this method.

Parameters

req:ServletRequest: the HttpServletRequest object that contains the request the client made of the servlet
res:ServletResponse: the HttpServletResponse object that contains the response the servlet returns to the client

Annotations

@Override

Exceptions

ServletException:: if the HTTP request cannot be handled or if either parameter is not an instance of its respective HttpServletRequest or HttpServletResponse counterparts.
IOException:: if an input or output error occurs while the servlet is handling the HTTP request

public Class PyServlet

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class PyServlet.CacheEntry

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail