BeanShell 2.0b5 · bsh.servlet.BshServlet

Modifier and Type	Field and Description
pack-priv static String	bshVersion
pack-priv static String	exampleScript

Access	Constructor and Description
public	BshServlet()

Method Summary

Modifier and Type	Method and Description
public void	doGet(HttpServletRequest an `HttpServletRequest` object that contains the request the client has made of the servlet request, HttpServletResponse an `HttpServletResponse` object that contains the response the servlet sends to the client response) Overrides javax.servlet.http.HttpServlet.doGet. Called by the server (via the `service` method) to allow a servlet to handle a GET request.
public void	doPost(HttpServletRequest an `HttpServletRequest` object that contains the request the client has made of the servlet request, HttpServletResponse an `HttpServletResponse` object that contains the response the servlet sends to the client response) Overrides javax.servlet.http.HttpServlet.doPost. Called by the server (via the `service` method) to allow a servlet to handle a POST request.
public static String	escape(String value) Convert special characters to entities for XML output
pack-priv Object	evalScript(String script, StringBuffer scriptOutput, boolean captureOutErr, HttpServletRequest request, HttpServletResponse response)
pack-priv String	formatScriptResultHTML(String script, Object result, Exception error, StringBuffer scriptOutput)
pack-priv static String	getBshVersion()
pack-priv void	sendHTML(HttpServletRequest request, HttpServletResponse response, String script, Exception scriptError, Object scriptResult, StringBuffer scriptOutput, boolean capture)
pack-priv void	sendRaw(HttpServletRequest request, HttpServletResponse response, Exception scriptError, Object scriptResult, StringBuffer scriptOutput)
pack-priv String	showScriptContextHTML(String s, int lineNo, int context)

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

bshVersion	back to summary
pack-priv static String bshVersion

exampleScript	back to summary
pack-priv static String exampleScript

BshServlet	back to summary
public BshServlet()

Method Detail

doGet back to summary

doGet	back to summary
public void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException Overrides javax.servlet.http.HttpServlet.doGet. Doc from javax.servlet.http.HttpServlet.doGet. Called by the server (via the `service` method) to allow a servlet to handle a GET request. Overriding this method to support a GET request also automatically supports an HTTP HEAD request. A HEAD request is a GET request that returns no body in the response, only the request header fields. When overriding this method, read the request data, write the response headers, get the response's writer or output stream object, and finally, write the response data. It's best to include content type and encoding. When using a `PrintWriter` object to return the response, set the content type before accessing the `PrintWriter` object. The servlet container must write the headers before committing the response, because in HTTP the headers must be sent before the response body. Where possible, set the Content-Length header (with the `javax.servlet.ServletResponse#setContentLength` method), to allow the servlet container to use a persistent connection to return its response to the client, improving performance. The content length is automatically set if the entire response fits inside the response buffer. When using HTTP 1.1 chunked encoding (which means that the response has a Transfer-Encoding header), do not set the Content-Length header. The GET method should be safe, that is, without any side effects for which users are held responsible. For example, most form queries have no side effects. If a client request is intended to change stored data, the request should use some other HTTP method. The GET method should also be idempotent, meaning that it can be safely repeated. Sometimes making a method safe also makes it idempotent. For example, repeating queries is both safe and idempotent, but buying a product online or modifying data is neither safe nor idempotent. If the request is incorrectly formatted, `doGet` returns an HTTP "Bad Request" message. Parameters request:HttpServletRequest an `HttpServletRequest` object that contains the request the client has made of the servlet response:HttpServletResponse an `HttpServletResponse` object that contains the response the servlet sends to the client Exceptions ServletException: if the request for the GET could not be handled IOException: if an input or output error is detected when the servlet handles the GET request

public void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException

Overrides javax.servlet.http.HttpServlet.doGet.

Doc from javax.servlet.http.HttpServlet.doGet.

Called by the server (via the service method) to allow a servlet to handle a GET request.

Overriding this method to support a GET request also automatically supports an HTTP HEAD request. A HEAD request is a GET request that returns no body in the response, only the request header fields.

When overriding this method, read the request data, write the response headers, get the response's writer or output stream object, and finally, write the response data. It's best to include content type and encoding. When using a PrintWriter object to return the response, set the content type before accessing the PrintWriter object.

The servlet container must write the headers before committing the response, because in HTTP the headers must be sent before the response body.

Where possible, set the Content-Length header (with the javax.servlet.ServletResponse#setContentLength method), to allow the servlet container to use a persistent connection to return its response to the client, improving performance. The content length is automatically set if the entire response fits inside the response buffer.

When using HTTP 1.1 chunked encoding (which means that the response has a Transfer-Encoding header), do not set the Content-Length header.

The GET method should be safe, that is, without any side effects for which users are held responsible. For example, most form queries have no side effects. If a client request is intended to change stored data, the request should use some other HTTP method.

The GET method should also be idempotent, meaning that it can be safely repeated. Sometimes making a method safe also makes it idempotent. For example, repeating queries is both safe and idempotent, but buying a product online or modifying data is neither safe nor idempotent.

If the request is incorrectly formatted, doGet returns an HTTP "Bad Request" message.

Parameters

request:HttpServletRequest: an HttpServletRequest object that contains the request the client has made of the servlet
response:HttpServletResponse: an HttpServletResponse object that contains the response the servlet sends to the client

Exceptions

ServletException:: if the request for the GET could not be handled
IOException:: if an input or output error is detected when the servlet handles the GET request

doPost back to summary

doPost	back to summary
public void doPost(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException Overrides javax.servlet.http.HttpServlet.doPost. Doc from javax.servlet.http.HttpServlet.doPost. Called by the server (via the `service` method) to allow a servlet to handle a POST request. The HTTP POST method allows the client to send data of unlimited length to the Web server a single time and is useful when posting information such as credit card numbers. When overriding this method, read the request data, write the response headers, get the response's writer or output stream object, and finally, write the response data. It's best to include content type and encoding. When using a `PrintWriter` object to return the response, set the content type before accessing the `PrintWriter` object. The servlet container must write the headers before committing the response, because in HTTP the headers must be sent before the response body. Where possible, set the Content-Length header (with the `javax.servlet.ServletResponse#setContentLength` method), to allow the servlet container to use a persistent connection to return its response to the client, improving performance. The content length is automatically set if the entire response fits inside the response buffer. When using HTTP 1.1 chunked encoding (which means that the response has a Transfer-Encoding header), do not set the Content-Length header. This method does not need to be either safe or idempotent. Operations requested through POST can have side effects for which the user can be held accountable, for example, updating stored data or buying items online. If the HTTP POST request is incorrectly formatted, `doPost` returns an HTTP "Bad Request" message. Parameters request:HttpServletRequest an `HttpServletRequest` object that contains the request the client has made of the servlet response:HttpServletResponse an `HttpServletResponse` object that contains the response the servlet sends to the client Exceptions ServletException: if the request for the POST could not be handled IOException: if an input or output error is detected when the servlet handles the request

public void doPost(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException

Overrides javax.servlet.http.HttpServlet.doPost.

Doc from javax.servlet.http.HttpServlet.doPost.

Called by the server (via the service method) to allow a servlet to handle a POST request. The HTTP POST method allows the client to send data of unlimited length to the Web server a single time and is useful when posting information such as credit card numbers.

The servlet container must write the headers before committing the response, because in HTTP the headers must be sent before the response body.

When using HTTP 1.1 chunked encoding (which means that the response has a Transfer-Encoding header), do not set the Content-Length header.

This method does not need to be either safe or idempotent. Operations requested through POST can have side effects for which the user can be held accountable, for example, updating stored data or buying items online.

If the HTTP POST request is incorrectly formatted, doPost returns an HTTP "Bad Request" message.

Parameters

request:HttpServletRequest: an HttpServletRequest object that contains the request the client has made of the servlet
response:HttpServletResponse: an HttpServletResponse object that contains the response the servlet sends to the client

Exceptions

ServletException:: if the request for the POST could not be handled
IOException:: if an input or output error is detected when the servlet handles the request

escape	back to summary
public static String escape(String value) Convert special characters to entities for XML output

evalScript	back to summary
pack-priv Object evalScript(String script, StringBuffer scriptOutput, boolean captureOutErr, HttpServletRequest request, HttpServletResponse response) throws EvalError

formatScriptResultHTML	back to summary
pack-priv String formatScriptResultHTML(String script, Object result, Exception error, StringBuffer scriptOutput) throws IOException

getBshVersion	back to summary
pack-priv static String getBshVersion()

sendHTML	back to summary
pack-priv void sendHTML(HttpServletRequest request, HttpServletResponse response, String script, Exception scriptError, Object scriptResult, StringBuffer scriptOutput, boolean capture) throws IOException

sendRaw	back to summary
pack-priv void sendRaw(HttpServletRequest request, HttpServletResponse response, Exception scriptError, Object scriptResult, StringBuffer scriptOutput) throws IOException

showScriptContextHTML	back to summary
pack-priv String showScriptContextHTML(String s, int lineNo, int context)

public Class BshServlet

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail