org.rhq.enterprise.gui.common.servlet

Class NavMapImageServlet

java.lang.Object

javax.servlet.GenericServlet

javax.servlet.http.HttpServlet

org.rhq.enterprise.gui.common.servlet.ParameterizedServlet

org.rhq.enterprise.gui.common.servlet.ImageServlet

org.rhq.enterprise.gui.common.servlet.NavMapImageServlet

All Implemented Interfaces:

Serializable, javax.servlet.Servlet, javax.servlet.ServletConfig

public class NavMapImageServlet
extends ImageServlet

This servlet returns a response that contains the binary data of an image (JPEG or PNG) that can be viewed in a web browser.

The navigation map servlet takes the following parameters (any applicable defaults are in bold and required parameters are in italics):

key	value
treeVar	<string>

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	IMAGE_WIDTH_DEFAULT Default image width.
static String	TREE_VAR_PARAM Request parameter for the tree variable session attribute.

Fields inherited from class org.rhq.enterprise.gui.common.servlet.ImageServlet

IMAGE_FORMAT_JPEG, IMAGE_FORMAT_PARAM, IMAGE_FORMAT_PNG, IMAGE_HEIGHT_DEFAULT, IMAGE_HEIGHT_PARAM, IMAGE_WIDTH_PARAM

Constructor Summary

Constructors

Constructor and Description
NavMapImageServlet()

Method Summary

Methods

Modifier and Type	Method and Description
protected Object	createImage(javax.servlet.http.HttpServletRequest request) Create the image being rendered.
protected int	getDefaultImageWidth() Return the default imageWidth.
protected void	parseParameters(javax.servlet.http.HttpServletRequest request) This method will be called automatically by the ChartServlet.
protected void	renderJpegImage(javax.servlet.ServletOutputStream out, Object imgObj) Render a JPEG version of the image into the output stream.
protected void	renderPngImage(javax.servlet.ServletOutputStream out, Object imgObj) Render a PNG version of the image into the output stream.

Methods inherited from class org.rhq.enterprise.gui.common.servlet.ImageServlet

doGet, getDefaultImageFormat, getDefaultImageHeight, getImageFormat, getImageHeight, getImageWidth, init

Methods inherited from class org.rhq.enterprise.gui.common.servlet.ParameterizedServlet

invalidParamErr, invalidParamErr, invalidParamWarn, invalidParamWarn, invalidParamWarn, invalidParamWarn, invalidParamWarn, parseBooleanParameter, parseDoubleParameter, parseEnumParameter, parseIntParameter, parseLongParameter, parseRequiredBooleanParameter, parseRequiredDoubleParameter, parseRequiredIntParameter, parseRequiredLongParameter, parseRequiredStringParameter, parseRequiredStringParameter, parseStringParameter, parseStringParameter, requiredParamErr

Methods inherited from class javax.servlet.http.HttpServlet

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

Methods inherited from class javax.servlet.GenericServlet

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

Methods inherited from class java.lang.Object

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

Field Detail

TREE_VAR_PARAM

public static final String TREE_VAR_PARAM

Request parameter for the tree variable session attribute.

See Also:

Constant Field Values

IMAGE_WIDTH_DEFAULT

public static final int IMAGE_WIDTH_DEFAULT

Default image width.

See Also:

Constant Field Values

Constructor Detail

NavMapImageServlet

public NavMapImageServlet()

Method Detail

createImage

protected Object createImage(javax.servlet.http.HttpServletRequest request)
                      throws javax.servlet.ServletException

Create the image being rendered.

Specified by:

createImage in class ImageServlet

Parameters:

request - the servlet request

Throws:

javax.servlet.ServletException

renderPngImage

protected void renderPngImage(javax.servlet.ServletOutputStream out,
                  Object imgObj)
                       throws IOException

Render a PNG version of the image into the output stream.

Specified by:

renderPngImage in class ImageServlet

Parameters:

out - the output stream

Throws:

IOException

renderJpegImage

protected void renderJpegImage(javax.servlet.ServletOutputStream out,
                   Object imgObj)
                        throws IOException

Render a JPEG version of the image into the output stream.

Specified by:

renderJpegImage in class ImageServlet

Parameters:

out - the output stream

Throws:

IOException

parseParameters

protected void parseParameters(javax.servlet.http.HttpServletRequest request)

This method will be called automatically by the ChartServlet. It should handle the parsing and error-checking of any specific parameters for the chart being rendered.

Overrides:

parseParameters in class ImageServlet

Parameters:

request - the HTTP request object

getDefaultImageWidth

protected int getDefaultImageWidth()

Return the default imageWidth.

Overrides:

getDefaultImageWidth in class ImageServlet