Jetty Plus :: Plus 7.0.0.pre5 · org.mortbay.jetty.plus.annotation.PojoServlet

Modifier and Type	Field and Description
private static final Class<T>[]	__params
private Method	_deleteMethod
private String	_deleteMethodName
private Method	_getMethod
private String	_getMethodName
private Method	_headMethod
private String	_headMethodName
private Object	_pojo
private Method	_postMethod
private String	_postMethodName
private Method	_putMethod
private String	_putMethodName

Access	Constructor and Description
public	PojoServlet(Object pojo)

Method Summary

Modifier and Type	Method and Description
protected void	doDelete(HttpServletRequest the `HttpServletRequest` object that contains the request the client made of the servlet req, HttpServletResponse the `HttpServletResponse` object that contains the response the servlet returns to the client resp) Overrides javax.servlet.http.HttpServlet.doDelete. Called by the server (via the `service` method) to allow a servlet to handle a DELETE request.
protected void	doGet(HttpServletRequest an `HttpServletRequest` object that contains the request the client has made of the servlet req, HttpServletResponse an `HttpServletResponse` object that contains the response the servlet sends to the client resp) Overrides javax.servlet.http.HttpServlet.doGet. Called by the server (via the `service` method) to allow a servlet to handle a GET request.
protected void	doHead(HttpServletRequest the request object that is passed to the servlet req, HttpServletResponse the response object that the servlet uses to return the headers to the clien resp) Overrides javax.servlet.http.HttpServlet.doHead. Receives an HTTP HEAD request from the protected `service` method and handles the request.
protected void	doPost(HttpServletRequest an `HttpServletRequest` object that contains the request the client has made of the servlet req, HttpServletResponse an `HttpServletResponse` object that contains the response the servlet sends to the client resp) Overrides javax.servlet.http.HttpServlet.doPost. Called by the server (via the `service` method) to allow a servlet to handle a POST request.
protected void	doPut(HttpServletRequest the `HttpServletRequest` object that contains the request the client made of the servlet req, HttpServletResponse the `HttpServletResponse` object that contains the response the servlet returns to the client resp) Overrides javax.servlet.http.HttpServlet.doPut. Called by the server (via the `service` method) to allow a servlet to handle a PUT request.
public String	getDeleteMethodName()
public String	getGetMethodName()
public String	getHeadMethodName()
public Object	getPojo() Implements org.mortbay.jetty.plus.annotation.PojoWrapper.getPojo.
public String	getPostMethodName()
public String	getPutMethodName()
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)`.
private void	invoke(Method method, HttpServletRequest req, HttpServletResponse resp)
public void	setDeleteMethodName(String name)
public void	setGetMethodName(String name)
public void	setHeadMethodName(String name)
public void	setPostMethodName(String name)
public void	setPutMethodName(String name)

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

__params	back to summary
private static final Class<T>[] __params

_deleteMethod	back to summary
private Method _deleteMethod

_deleteMethodName	back to summary
private String _deleteMethodName

_getMethod	back to summary
private Method _getMethod

_getMethodName	back to summary
private String _getMethodName

_headMethod	back to summary
private Method _headMethod

_headMethodName	back to summary
private String _headMethodName

_pojo	back to summary
private Object _pojo

_postMethod	back to summary
private Method _postMethod

_postMethodName	back to summary
private String _postMethodName

_putMethod	back to summary
private Method _putMethod

_putMethodName	back to summary
private String _putMethodName

PojoServlet	back to summary
public PojoServlet(Object pojo)

Method Detail

doDelete back to summary

doDelete	back to summary
protected void doDelete(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException Overrides javax.servlet.http.HttpServlet.doDelete. Doc from javax.servlet.http.HttpServlet.doDelete. Called by the server (via the `service` method) to allow a servlet to handle a DELETE request. The DELETE operation allows a client to remove a document or Web page from the server. This method does not need to be either safe or idempotent. Operations requested through DELETE can have side effects for which users can be held accountable. When using this method, it may be useful to save a copy of the affected URL in temporary storage. If the HTTP DELETE request is incorrectly formatted, `doDelete` returns an HTTP "Bad Request" message. Parameters req:HttpServletRequest the `HttpServletRequest` object that contains the request the client made of the servlet resp:HttpServletResponse the `HttpServletResponse` object that contains the response the servlet returns to the client Exceptions ServletException: if the request for the DELETE cannot be handled IOException: if an input or output error occurs while the servlet is handling the DELETE request

protected void doDelete(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException

Overrides javax.servlet.http.HttpServlet.doDelete.

Doc from javax.servlet.http.HttpServlet.doDelete.

Called by the server (via the service method) to allow a servlet to handle a DELETE request. The DELETE operation allows a client to remove a document or Web page from the server.

This method does not need to be either safe or idempotent. Operations requested through DELETE can have side effects for which users can be held accountable. When using this method, it may be useful to save a copy of the affected URL in temporary storage.

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

Parameters

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

Exceptions

ServletException:: if the request for the DELETE cannot be handled
IOException:: if an input or output error occurs while the servlet is handling the DELETE request

doGet back to summary

doGet	back to summary
protected void doGet(HttpServletRequest req, HttpServletResponse resp) 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 req:HttpServletRequest an `HttpServletRequest` object that contains the request the client has made of the servlet resp: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

protected void doGet(HttpServletRequest req, HttpServletResponse resp) 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

req:HttpServletRequest: an HttpServletRequest object that contains the request the client has made of the servlet
resp: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

doHead back to summary

doHead	back to summary
protected void doHead(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException Overrides javax.servlet.http.HttpServlet.doHead. Doc from javax.servlet.http.HttpServlet.doHead. Receives an HTTP HEAD request from the protected `service` method and handles the request. The client sends a HEAD request when it wants to see only the headers of a response, such as Content-Type or Content-Length. The HTTP HEAD method counts the output bytes in the response to set the Content-Length header accurately. If you override this method, you can avoid computing the response body and just set the response headers directly to improve performance. Make sure that the `doHead` method you write is both safe and idempotent (that is, protects itself from being called multiple times for one HTTP HEAD request). If the HTTP HEAD request is incorrectly formatted, `doHead` returns an HTTP "Bad Request" message. Parameters req:HttpServletRequest the request object that is passed to the servlet resp:HttpServletResponse the response object that the servlet uses to return the headers to the clien Exceptions ServletException: if the request for the HEAD could not be handled IOException: if an input or output error occurs

protected void doHead(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException

Overrides javax.servlet.http.HttpServlet.doHead.

Doc from javax.servlet.http.HttpServlet.doHead.

Receives an HTTP HEAD request from the protected service method and handles the request. The client sends a HEAD request when it wants to see only the headers of a response, such as Content-Type or Content-Length. The HTTP HEAD method counts the output bytes in the response to set the Content-Length header accurately.

If you override this method, you can avoid computing the response body and just set the response headers directly to improve performance. Make sure that the doHead method you write is both safe and idempotent (that is, protects itself from being called multiple times for one HTTP HEAD request).

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

Parameters

req:HttpServletRequest: the request object that is passed to the servlet
resp:HttpServletResponse: the response object that the servlet uses to return the headers to the clien

Exceptions

ServletException:: if the request for the HEAD could not be handled
IOException:: if an input or output error occurs

doPost back to summary

doPost	back to summary
protected void doPost(HttpServletRequest req, HttpServletResponse resp) 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 req:HttpServletRequest an `HttpServletRequest` object that contains the request the client has made of the servlet resp: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

protected void doPost(HttpServletRequest req, HttpServletResponse resp) 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

req:HttpServletRequest: an HttpServletRequest object that contains the request the client has made of the servlet
resp: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

doPut back to summary

doPut	back to summary
protected void doPut(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException Overrides javax.servlet.http.HttpServlet.doPut. Doc from javax.servlet.http.HttpServlet.doPut. Called by the server (via the `service` method) to allow a servlet to handle a PUT request. The PUT operation allows a client to place a file on the server and is similar to sending a file by FTP. When overriding this method, leave intact any content headers sent with the request (including Content-Length, Content-Type, Content-Transfer-Encoding, Content-Encoding, Content-Base, Content-Language, Content-Location, Content-MD5, and Content-Range). If your method cannot handle a content header, it must issue an error message (HTTP 501 - Not Implemented) and discard the request. For more information on HTTP 1.1, see RFC 2616 . This method does not need to be either safe or idempotent. Operations that `doPut` performs can have side effects for which the user can be held accountable. When using this method, it may be useful to save a copy of the affected URL in temporary storage. If the HTTP PUT request is incorrectly formatted, `doPut` returns an HTTP "Bad Request" message. Parameters req:HttpServletRequest the `HttpServletRequest` object that contains the request the client made of the servlet resp:HttpServletResponse the `HttpServletResponse` object that contains the response the servlet returns to the client Exceptions ServletException: if the request for the PUT cannot be handled IOException: if an input or output error occurs while the servlet is handling the PUT request

protected void doPut(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException

Overrides javax.servlet.http.HttpServlet.doPut.

Doc from javax.servlet.http.HttpServlet.doPut.

Called by the server (via the service method) to allow a servlet to handle a PUT request. The PUT operation allows a client to place a file on the server and is similar to sending a file by FTP.

When overriding this method, leave intact any content headers sent with the request (including Content-Length, Content-Type, Content-Transfer-Encoding, Content-Encoding, Content-Base, Content-Language, Content-Location, Content-MD5, and Content-Range). If your method cannot handle a content header, it must issue an error message (HTTP 501 - Not Implemented) and discard the request. For more information on HTTP 1.1, see RFC 2616 .

This method does not need to be either safe or idempotent. Operations that doPut performs can have side effects for which the user can be held accountable. When using this method, it may be useful to save a copy of the affected URL in temporary storage.

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

Parameters

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

Exceptions

ServletException:: if the request for the PUT cannot be handled
IOException:: if an input or output error occurs while the servlet is handling the PUT request

getDeleteMethodName	back to summary
public String getDeleteMethodName()

getGetMethodName	back to summary
public String getGetMethodName()

getHeadMethodName	back to summary
public String getHeadMethodName()

getPojo	back to summary
public Object getPojo() Implements org.mortbay.jetty.plus.annotation.PojoWrapper.getPojo.

getPostMethodName	back to summary
public String getPostMethodName()

getPutMethodName	back to summary
public String getPutMethodName()

init back to summary

init	back to summary
public void init() throws ServletException 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`. Exceptions ServletException: if an exception occurs that interrupts the servlet's normal operation

public void init() throws ServletException

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.

Exceptions

ServletException:: if an exception occurs that interrupts the servlet's normal operation

invoke	back to summary
private void invoke(Method method, HttpServletRequest req, HttpServletResponse resp) throws ServletException

setDeleteMethodName	back to summary
public void setDeleteMethodName(String name)

setGetMethodName	back to summary
public void setGetMethodName(String name)

setHeadMethodName	back to summary
public void setHeadMethodName(String name)

setPostMethodName	back to summary
public void setPostMethodName(String name)

setPutMethodName	back to summary
public void setPutMethodName(String name)

public Class PojoServlet

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail