com.inet.report

Class ReportServlet

java.lang.Object

javax.servlet.GenericServlet

javax.servlet.http.HttpServlet

com.inet.http.PluginDispatcherServlet

com.inet.report.ReportServlet

All Implemented Interfaces:

PropertiesChecker, java.io.Serializable, javax.servlet.FilterChain, javax.servlet.Servlet, javax.servlet.ServletConfig

Deprecated.

As of i-net Clear Reports 15.0, replaced by PropertiesChecker and EngineFactory instead.

@Deprecated
public class ReportServlet
extends com.inet.http.PluginDispatcherServlet
implements PropertiesChecker

This class implements all communications between the clients and server. Because of the great complexity of the communication it is not recommended to extends this class. This class is only used in the web.xml.

See Also:

Serialized Form

Method Summary

Modifier and Type	Method and Description
void	checkHtmlPageProperties(java.util.Properties props) Deprecated. As of i-net Clear Reports 15.0 use the configuration to set a PropertyChecker.
void	checkProperties(java.util.Properties props, java.lang.Object req) Deprecated. As of i-net Clear Reports 15.0 use the configuration to set a PropertyChecker.
void	checkProperties(java.util.Properties props) Deprecated. As of i-net Clear Reports 15.0 use the configuration to set a PropertyChecker.
void	checkProperties(Engine engine, java.util.Properties immutableProperties, java.lang.Object req) Deprecated. As of i-net Clear Reports 15.0 use the configuration to set a PropertyChecker.
void	checkProperties(Engine engine, java.util.Properties immutableProperties) Deprecated. As of i-net Clear Reports 15.0 use the configuration to set a PropertyChecker.

Method Detail

checkProperties

@Deprecated
public void checkProperties(java.util.Properties props,
                                         java.lang.Object req)
                                  throws ReportException

Deprecated. As of i-net Clear Reports 15.0 use the configuration to set a PropertyChecker.

This callback is called right before the engine examines the report file. The properties object contains the values that the viewer has passed to the report server.
If you override this method, you can change or examine the user properties.
Example
if(...) props.put("report", "file:///c:/my-report.rpt");
Please note: The property "report" is initialized with the full qualified report name if the report has been found on the disc (via file:// or file:///context/) or via http://. If not, then the property will contain the original value.

Specified by:

checkProperties in interface PropertiesChecker

Parameters:

props - The user properties. All keys are lowercase.

req - The javax.servlet.http.HttpServletRequest or null if not in a server.

Throws:

ReportException - If an error occurred during checking the supplied properties with the current PropertiesChecker. The ReportException will be send to the client and displayed in the Java viewer.

See Also:

PropertiesChecker.checkProperties(Engine engine, Properties prop, Object req)

checkProperties

@Deprecated
public void checkProperties(java.util.Properties props)
                                  throws ReportException

Deprecated. As of i-net Clear Reports 15.0 use the configuration to set a PropertyChecker.

This method is called by checkProperties(Properties, Object) and is equivalent to checkProperties(props, null).

Parameters:

props - The user properties.

Throws:

ReportException - If an error occurred during checking the supplied properties with the current PropertiesChecker. The ReportException will be send to the client and displayed in the Java viewer.

Since:

6.0

See Also:

checkProperties(Properties, Object)

checkProperties

@Deprecated
public void checkProperties(Engine engine,
                                         java.util.Properties immutableProperties,
                                         java.lang.Object req)
                                  throws ReportException

Deprecated. As of i-net Clear Reports 15.0 use the configuration to set a PropertyChecker.

This callback is called right after the engine has examined the report file. The properties object still contains only the user properties, but you can use the engine API to examine and change the properties red from the report file.
If you override this method, you can change or examine the properties from the report file.

Example:
engine.setSchema(...);
engine.setProperty(...);

Specified by:

checkProperties in interface PropertiesChecker

Parameters:

engine - The initialized engine that have parsed the rpt file already.

immutableProperties - The user properties. All keys are lowercase.

req - The javax.servlet.http.HttpServletRequest or null if not in a server.

Throws:

ReportException - If an error occurred during checking the supplied properties with the current PropertiesChecker. The ReportException will be send to the client and displayed in the Java viewer.

See Also:




checkProperties

@Deprecated
public void checkProperties(Engine engine,
                                         java.util.Properties immutableProperties)
                                  throws ReportException

Deprecated. As of i-net Clear Reports 15.0 use the configuration to set a PropertyChecker.

This method is called by checkProperties(Engine, Properties, Object) and is equivalent to checkProperties(engine, prop, null).
This implementation will also initialize the database connections of the report.

Parameters:

engine - The initialized engine that have parsed the rpt file already.

immutableProperties - The user properties.

Throws:

ReportException - If an error occurred during checking the supplied properties with the current PropertiesChecker. The ReportException will be send to the client and displayed in the Java viewer.

Since:

6.0

See Also:

checkProperties(Engine, Properties, Object)

checkHtmlPageProperties

@Deprecated
public void checkHtmlPageProperties(java.util.Properties props)
                                          throws ReportException

Deprecated. As of i-net Clear Reports 15.0 use the configuration to set a PropertyChecker.

This callback is called before the report server creates and sends back a HTML page with the viewer embedded. The properties object contains the default properties for the HTML page.
If you override this method, you can change or examine the default HTML page properties.

Specified by:

checkHtmlPageProperties in interface PropertiesChecker

Parameters:

props - The properties of the html page. Any change to this properties object itself has absolutely no effect. All keys are lowercase. See Example MyReportServlet_withMyHTMLProperties.java.

Throws:

ReportException - If an error occurred during checking the supplied properties with the current PropertiesChecker.

See Also:

PropertiesChecker.checkProperties(Engine engine, Properties prop, Object req), PropertiesChecker.checkProperties(Properties prop, Object req)