Top Description Fields Constructors Methods
waffle.servlet

public Class WaffleInfoServlet

extends HttpServlet
Class Inheritance
Imports
java.io.IOException, java.security.Principal, java.util.Collections, .List, javax.servlet.http.HttpServlet, .HttpServletRequest, .HttpServletResponse, javax.xml.XMLConstants, javax.xml.parsers.ParserConfigurationException, javax.xml.transform.OutputKeys, .Transformer, .TransformerException, .TransformerFactory, javax.xml.transform.dom.DOMSource, javax.xml.transform.stream.StreamResult, org.slf4j.Logger, .LoggerFactory, org.w3c.dom.Document, .Element, waffle.util.WaffleInfo

A servlet that returns WaffleInfo as XML.

Field Summary

Modifier and TypeField and Description
private static final Logger
logger

The Constant Logger.

private static final long
serialVersionUID

The Constant serialVersionUID.

Constructor Summary

AccessConstructor and Description
public

Method Summary

Modifier and TypeMethod and Description
public void
doGet(final HttpServletRequest
an HttpServletRequest object that contains the request the client has made of the servlet
request
,
final 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(final HttpServletRequest
an HttpServletRequest object that contains the request the client has made of the servlet
request
,
final 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.
private Element

Returns:

the request info
getRequestInfo
(final Document
the doc
doc
,
final HttpServletRequest
the request
request
)

Gets the request info.

public void
getWaffleInfoResponse(final HttpServletRequest
the request
request
,
final HttpServletResponse
the response
response
)

Gets the waffle info response.

Inherited from javax.servlet.http.HttpServlet:
doDeletedoHeaddoOptionsdoPutdoTracegetLastModifiedserviceservice

Field Detail

loggerback to summary
private static final Logger logger

The Constant Logger.

serialVersionUIDback to summary
private static final long serialVersionUID

The Constant serialVersionUID.

Constructor Detail

WaffleInfoServletback to summary
public WaffleInfoServlet()

Method Detail

doGetback to summary
public void doGet(final HttpServletRequest request, final HttpServletResponse response)

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

Annotations
@Override
doPostback to summary
public void doPost(final HttpServletRequest request, final HttpServletResponse response)

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

Annotations
@Override
getRequestInfoback to summary
private Element getRequestInfo(final Document doc, final HttpServletRequest request)

Gets the request info.

Parameters
doc:Document

the doc

request:HttpServletRequest

the request

Returns:Element

the request info

getWaffleInfoResponseback to summary
public void getWaffleInfoResponse(final HttpServletRequest request, final HttpServletResponse response)

Gets the waffle info response.

Parameters
request:HttpServletRequest

the request

response:HttpServletResponse

the response