ilog.views.svg.servlet

Class IlvSVGManagerServlet

java.lang.Object

jakarta.servlet.GenericServlet

jakarta.servlet.http.HttpServlet

ilog.views.svg.servlet.IlvSVGManagerServlet

All Implemented Interfaces:

jakarta.servlet.Servlet, jakarta.servlet.ServletConfig, Serializable

public abstract class IlvSVGManagerServlet
extends jakarta.servlet.http.HttpServlet

An abstract servlet that can respond to HTTP requests to generate an SVG image from a Perforce JViews manager. This servlet can be used with the Perforce JViews SVG thin-client toolkit.
The request for the image is of the following form:

 <servletpath>?request=image
              &width =  resulting image width
              &height= resulting image height
              [&layer=layer1, layer2]
              [&viewBox=x,y,width,height]
 

This request returns an SVG image corresponding to the manager. If the layer option is used, the only generated layers are the ones specified. If the viewBox option is set, its value overrides the one set with SVGDocumentBuilderConfigurator.setViewBox(ilog.views.IlvRect) on the SVGDocumentBuilderConfigurator used to generate the SVG in the the IlvSVGManagerServlet instance.

Since:

JViews 5.5

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
IlvSVGManagerServlet(SVGDocumentBuilderConfigurator configurator) Creates a manager servlet.

Method Summary

Modifier and Type	Method and Description
void	doGet(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response) Responds to the servlet request.
void	doPost(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response) Responds to the servlet request.
protected Document	generateSVGDocument(jakarta.servlet.http.HttpServletRequest request, int width, int height, String[] requestedLayers) Generates the SVG document.
boolean	getContentLengthEnable() Returns true if the servlet support is buffered.
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.
protected boolean	handleRequest(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response) Responds to the servlet request.
void	init(jakarta.servlet.ServletConfig config) Initializes the manager servlet.
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.
protected void	prepareSession(jakarta.servlet.http.HttpServletRequest request) Prepares a session for the client.
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 jakarta.servlet.http.HttpServlet

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

Methods inherited from class jakarta.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

Constructor Detail

IlvSVGManagerServlet

public IlvSVGManagerServlet(SVGDocumentBuilderConfigurator configurator)

Creates a manager servlet.

Parameters:

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

Method Detail

init

public void init(jakarta.servlet.ServletConfig config)
          throws jakarta.servlet.ServletException

Initializes the manager servlet.

Specified by:

init in interface jakarta.servlet.Servlet

Overrides:

init in class jakarta.servlet.GenericServlet

Parameters:

config - The ServletConfig instance.

Throws:

jakarta.servlet.ServletException

setVerbose

public final void setVerbose(boolean value)

Turns the verbose mode on and off.

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)

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

generateSVGDocument

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

Generates the SVG document. 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

handleRequest

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

Responds to the servlet request. This method responds to image or capabilities requests. It returns false if the request is not a request recognized by this servlet. You may override this method to handle a new type of request, in which case you will have to call the super method.

Parameters:

request - The current HTTP request.

response - The HTTP response.

Throws:

IOException

jakarta.servlet.ServletException

prepareSession

protected void prepareSession(jakarta.servlet.http.HttpServletRequest request)

Prepares a session for the client. This method is called at every request before any other method to allow the user to prepare a session for its servlet. The actual implementation is empty, but if your servlet needs to create a session, you can override the method to do it.

Parameters:

request - The current request.

doGet

public void doGet(jakarta.servlet.http.HttpServletRequest request,
                  jakarta.servlet.http.HttpServletResponse response)
           throws IOException,
                  jakarta.servlet.ServletException

Responds to the servlet request. This method simply calls prepareSession(jakarta.servlet.http.HttpServletRequest) then handleRequest(jakarta.servlet.http.HttpServletRequest, jakarta.servlet.http.HttpServletResponse). You normally do not need to override this method. To add a new type of request, you can override the method handleRequest.

Overrides:

doGet in class jakarta.servlet.http.HttpServlet

Parameters:

request - The current HTTP request.

response - The HTTP response.

Throws:

IOException

jakarta.servlet.ServletException

doPost

public void doPost(jakarta.servlet.http.HttpServletRequest request,
                   jakarta.servlet.http.HttpServletResponse response)
            throws IOException,
                   jakarta.servlet.ServletException

Responds to the servlet request. The default implementation simply calls doGet.

Overrides:

doPost in class jakarta.servlet.http.HttpServlet

Parameters:

request - The current HTTP request.

response - The HTTP response.

Throws:

IOException

jakarta.servlet.ServletException

See Also:

doGet(jakarta.servlet.http.HttpServletRequest, jakarta.servlet.http.HttpServletResponse)