org.rvpf.http

Class AbstractServlet

Object

GenericServlet

HttpServlet

AbstractServlet

All Implemented Interfaces:

Serializable, Servlet, ServletConfig

Direct Known Subclasses:

EventsServlet, InfoServlet, MetadataServlet, NoticeServlet, PurgeServlet, RPNServlet, StatusServlet, TriggerServlet, UpdateServlet, ValuesServlet

@ThreadSafe
public abstract class AbstractServlet
extends HttpServlet

Abstract servlet.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AbstractServlet.BadRequestException Bad request exception.

Field Summary

Fields

Modifier and Type	Field and Description
static String	JSON_CONTENT_TYPE JSON content type.
static String	JSON_PARAMETER JSON parameter.
static String	RESPONSE_ROOT Response root element.
static String	STAMP_ATTRIBUTE Stamp attribute.
static String	XML_CONTENT_TYPE XML content type.

Constructor Summary

Constructors

Constructor and Description
AbstractServlet()

Method Summary

Modifier and Type	Method and Description
static Optional<String>	canonicalize(Optional<String> text) Canonicalizes text.
protected Logger	getThisLogger() Gets the logger.
protected XMLDocument	parseRequest(HttpServletRequest request, HttpServletResponse response) Parses the document contained in a POST request.
protected static void	sendGetResponse(HttpServletRequest request, HttpServletResponse response, XMLDocument responseDocument) Sends a response.
protected static void	sendPostResponse(HttpServletRequest request, HttpServletResponse response, XMLDocument responseDocument) Sends a response.
protected void	service(HttpServletRequest request, HttpServletResponse response) Does service processing.
protected void	setLogID(Optional<String> logID) Sets the log ID.
protected static boolean	toBoolean(Optional<String> optionalValueString) Gets a boolean value.
protected static Optional<DateTime>	toStamp(Optional<String> valueString) Gets a stamp (date-time) value.

Methods inherited from class HttpServlet

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

Methods inherited from class GenericServlet

destroy, getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletInfo, getServletName, init, init, log, log

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

JSON_CONTENT_TYPE

public static final String JSON_CONTENT_TYPE

JSON content type.

See Also:

Constant Field Values

JSON_PARAMETER

public static final String JSON_PARAMETER

JSON parameter.

See Also:

Constant Field Values

RESPONSE_ROOT

public static final String RESPONSE_ROOT

Response root element.

See Also:

Constant Field Values

STAMP_ATTRIBUTE

public static final String STAMP_ATTRIBUTE

Stamp attribute.

See Also:

Constant Field Values

XML_CONTENT_TYPE

public static final String XML_CONTENT_TYPE

XML content type.

See Also:

Constant Field Values

Constructor Detail

AbstractServlet

public AbstractServlet()

Method Detail

canonicalize

@Nonnull
 @CheckReturnValue
public static Optional<String> canonicalize(@Nonnull
                                                                          Optional<String> text)

Canonicalizes text.

Parameters:

text - The optional text.

Returns:

The canonicalized text (empty on missing text)..

sendGetResponse

protected static void sendGetResponse(@Nonnull
                                      HttpServletRequest request,
                                      @Nonnull
                                      HttpServletResponse response,
                                      @Nonnull
                                      XMLDocument responseDocument)
                               throws IOException

Sends a response.

Parameters:

request - The GET request.

response - The HTTP response.

responseDocument - The response document.

Throws:

IOException - When appropriate.

sendPostResponse

protected static void sendPostResponse(@Nonnull
                                       HttpServletRequest request,
                                       @Nonnull
                                       HttpServletResponse response,
                                       @Nonnull
                                       XMLDocument responseDocument)
                                throws IOException

Sends a response.

Parameters:

request - The POST request.

response - The HTTP response.

responseDocument - The response document.

Throws:

IOException - When appropriate.

toBoolean

@CheckReturnValue
protected static boolean toBoolean(@Nonnull
                                                      Optional<String> optionalValueString)
                                               throws AbstractServlet.BadRequestException

Gets a boolean value.

Parameters:

optionalValueString - An optional value string..

Returns:

The boolean value (false if absent).

Throws:

AbstractServlet.BadRequestException - On a bad value string.

toStamp

@Nonnull
 @CheckReturnValue
protected static Optional<DateTime> toStamp(@Nonnull
                                                                          Optional<String> valueString)
                                                                   throws AbstractServlet.BadRequestException

Gets a stamp (date-time) value.

Parameters:

valueString - An optional value string.

Returns:

The stamp value (empty if absent).

Throws:

AbstractServlet.BadRequestException - On a bad value string.

getThisLogger

@Nonnull
 @CheckReturnValue
protected final Logger getThisLogger()

Gets the logger.

Returns:

The logger.

parseRequest

@Nullable
 @CheckReturnValue
protected XMLDocument parseRequest(@Nonnull
                                                                  HttpServletRequest request,
                                                                  @Nonnull
                                                                  HttpServletResponse response)
                                                           throws IOException

Parses the document contained in a POST request.

Parameters:

request - The POST request.

response - The HTTP response.

Returns:

A XML document (null on failure).

Throws:

IOException - When appropriate.

service

protected final void service(HttpServletRequest request,
                             HttpServletResponse response)
                      throws ServletException,
                             IOException

Does service processing.

Overrides:

service in class HttpServlet

Parameters:

request - The HTTP request.

response - The HTTP response.

Throws:

ServletException - When appropriate.

IOException - When appropriate.

setLogID

protected void setLogID(Optional<String> logID)

Sets the log ID.

Parameters:

logID - The optional log ID.