ilog.views.svg.servlet

Class IlvSVGManagerServletSupport

java.lang.Object

ilog.views.svg.servlet.IlvSVGManagerServletSupport

public abstract class IlvSVGManagerServletSupport
extends Object

A class that can respond to HTTP requests to generate an SVG image from a Perforce JViews manager. This class can be used inside a servlet to answer HTTP requests.

Since:

JViews 5.5

Constructor Summary

Constructors

Constructor and Description
IlvSVGManagerServletSupport(SVGDocumentBuilderConfigurator configurator, jakarta.servlet.ServletContext context) Creates a manager servlet support.

Method Summary

Modifier and Type	Method and Description
protected Document	generateSVGDocument(jakarta.servlet.http.HttpServletRequest request, int width, int height, String[] requestedLayers) Generates the image.
boolean	getContentLengthEnable() Returns true if the servlet support is buffered.
protected jakarta.servlet.ServletContext	getContext() Returns the ServletContext in which this IlvSVGManagerServletSupport runs.
protected IlvManagerLayer[]	getLayers(jakarta.servlet.http.HttpServletRequest request, IlvManager manager) Returns the list of layers that are allowed to be rendered.
protected Object	getLock(jakarta.servlet.http.HttpServletRequest request) Returns a locking object that is used to lock the contents of the manager while it is being rendered.
abstract IlvManager	getManager(jakarta.servlet.http.HttpServletRequest request) Returns the IlvManager used for the specified request.
boolean	handleRequest(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response) Responds to HTTP requests.
boolean	isVerbose() Returns true if the servlet is in verbose mode.
protected void	prepareManager(jakarta.servlet.http.HttpServletRequest request, IlvManager manager) Allows you to prepare the manager view content before the image is generated or the capabilities are computed.
void	setContentLengthEnable(boolean value) Sets the flag that switches the servlet support in a buffered mode.
void	setVerbose(boolean value) Turns the verbose mode on and off.

Methods inherited from class java.lang.Object

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

Constructor Detail

IlvSVGManagerServletSupport

public IlvSVGManagerServletSupport(SVGDocumentBuilderConfigurator configurator,
                                   jakarta.servlet.ServletContext context)

Creates a manager servlet support.

Parameters:

configurator - The configurator that will be used to generate SVG.

context - The Servlet context.

Method Detail

getContext

protected final jakarta.servlet.ServletContext getContext()

Returns the ServletContext in which this IlvSVGManagerServletSupport runs.

setVerbose

public final void setVerbose(boolean value)

Turns the verbose mode on and off.

Parameters:

value - The new value for verbose.

See Also:

isVerbose()

isVerbose

public final boolean isVerbose()

Returns true if the servlet is in verbose mode.

See Also:

setVerbose(boolean)

setContentLengthEnable

public final void setContentLengthEnable(boolean value)

Sets the flag that switches the servlet support in a buffered mode. When the servlet support buffers the images, the contents' length of the response is set.

Parameters:

value - The buffered flag.

See Also:

getContentLengthEnable()

getContentLengthEnable

public final boolean getContentLengthEnable()

Returns true if the servlet support is buffered. The default value is false.

See Also:

setContentLengthEnable(boolean)

getManager

public abstract IlvManager getManager(jakarta.servlet.http.HttpServletRequest request)
                               throws jakarta.servlet.ServletException

Returns the IlvManager used for the specified request. You can return the same manager every time, or return a manager for each request session if the content of the manager depends on the session.

Parameters:

request - The current HTTP request.

Throws:

jakarta.servlet.ServletException

getLayers

protected IlvManagerLayer[] getLayers(jakarta.servlet.http.HttpServletRequest request,
                                      IlvManager manager)
                               throws jakarta.servlet.ServletException

Returns the list of layers that are allowed to be rendered. The default implementation returns an array containing all the layers of the manager.

Parameters:

request - The current HTTP request.

manager - The manager (returned by getManager).

Throws:

jakarta.servlet.ServletException

getLock

protected Object getLock(jakarta.servlet.http.HttpServletRequest request)

Returns a locking object that is used to lock the contents of the manager while it is being rendered. The default implementation always returns a new object, which means no locking.

Parameters:

request - The current HTTP request.

See Also:

getManager(jakarta.servlet.http.HttpServletRequest)

generateSVGDocument

protected Document generateSVGDocument(jakarta.servlet.http.HttpServletRequest request,
                                       int width,
                                       int height,
                                       String[] requestedLayers)
                                throws jakarta.servlet.ServletException

Generates the image. You may override this method to add additional information on the generated image.

Parameters:

request - The current HTTP request.

width - The width of the image.

height - The height of the image.

requestedLayers - An array of layer names to draw, the array may be empty if all layers have to be drawn.

Throws:

jakarta.servlet.ServletException

prepareManager

protected void prepareManager(jakarta.servlet.http.HttpServletRequest request,
                              IlvManager manager)
                       throws jakarta.servlet.ServletException

Allows you to prepare the manager view content before the image is generated or the capabilities are computed. The current implementation does nothing.

Parameters:

request - The current HTTP request.

manager - The manager returned by getManager.

Throws:

jakarta.servlet.ServletException

handleRequest

public boolean handleRequest(jakarta.servlet.http.HttpServletRequest request,
                             jakarta.servlet.http.HttpServletResponse response)
                      throws IOException,
                             jakarta.servlet.ServletException

Responds to HTTP requests. This method responds to image or capabilities requests. It returns false if the request is not a request recognized by this servlet.

Parameters:

request - The current HTTP request.

response - The HTTP response.

Throws:

IOException

jakarta.servlet.ServletException