Hyperic HQ Plugin API v. 4.4.0.2

org.hyperic.hq.ui.servlet
Class NavMapImageServlet

java.lang.Object
  extended by javax.servlet.GenericServlet
      extended by javax.servlet.http.HttpServlet
          extended by org.hyperic.hq.ui.servlet.ParameterizedServlet
              extended by org.hyperic.hq.ui.servlet.ImageServlet
                  extended by org.hyperic.hq.ui.servlet.NavMapImageServlet
All Implemented Interfaces:
java.io.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
static int IMAGE_WIDTH_DEFAULT
          Default image width.
static java.lang.String TREE_VAR_PARAM
          Request parameter for the tree variable session attribute.
 
Fields inherited from class org.hyperic.hq.ui.servlet.ImageServlet
IMAGE_FORMAT_JPEG, IMAGE_FORMAT_PARAM, IMAGE_FORMAT_PNG, IMAGE_HEIGHT_DEFAULT, IMAGE_HEIGHT_PARAM, IMAGE_WIDTH_PARAM
 
Constructor Summary
NavMapImageServlet()
           
 
Method Summary
protected  java.lang.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, java.lang.Object imgObj)
          Render a JPEG version of the image into the output stream.
protected  void renderPngImage(javax.servlet.ServletOutputStream out, java.lang.Object imgObj)
          Render a PNG version of the image into the output stream.
 
Methods inherited from class org.hyperic.hq.ui.servlet.ImageServlet
doGet, getDefaultImageFormat, getDefaultImageHeight, getImageHeight, getImageWidth, init
 
Methods inherited from class org.hyperic.hq.ui.servlet.ParameterizedServlet
invalidParamErr, invalidParamErr, invalidParamWarn, invalidParamWarn, invalidParamWarn, invalidParamWarn, invalidParamWarn, parseBooleanParameter, parseDoubleParameter, 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 java.lang.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 java.lang.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,
                              java.lang.Object imgObj)
                       throws java.io.IOException
Render a PNG version of the image into the output stream.

Specified by:
renderPngImage in class ImageServlet
Parameters:
out - the output stream
Throws:
java.io.IOException

renderJpegImage

protected void renderJpegImage(javax.servlet.ServletOutputStream out,
                               java.lang.Object imgObj)
                        throws java.io.IOException
Render a JPEG version of the image into the output stream.

Specified by:
renderJpegImage in class ImageServlet
Parameters:
out - the output stream
Throws:
java.io.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.

Specified by:
parseParameters in class ImageServlet
Parameters:
request - the HTTP request object

getDefaultImageWidth

protected int getDefaultImageWidth()
Return the default imageWidth.

Overrides:
getDefaultImageWidth in class ImageServlet

Hyperic HQ Plugin API v. 4.4.0.2

Copyright © 2004-2006 Hyperic, Inc. support@hyperic.net, All Rights Reserved.