com.inet.report

Class Listener

java.lang.Object

com.inet.report.Listener

All Implemented Interfaces:

PropertiesChecker

public class Listener
extends java.lang.Object
implements PropertiesChecker

This class is the main start point of the standalone server. Since version 15.0 you does not need this class anymore in your code. The server start automatically if you access the API, for example with new Engine(). If you need a web server then you need the webserver.zip plugin.

Constructor Summary

Constructors

Constructor and Description
Listener() Creates a new listener web server and binds it to the local port number specified in the i-net Clear Reports configuration or to the default port number 9000.
Listener(boolean autodetectPort) Creates a new listener web server and binds it to the local port number specified in the i-net Clear Reports configuration or to the default port number 9000.
Listener(boolean autodetectPort, java.lang.String bindAddress) Creates a new listener web server and binds it to the local port number specified in the i-net Clear Reports configuration or to the default port number 9000.
Listener(int port) Creates a new listener web server and binds it to the local port number specified as port parameter.
Listener(boolean autodetectPort, int port) Creates a new listener web server and binds it to the local port number specified as port parameter.

Method Summary

Modifier and Type	Method and Description
void	checkHtmlPageProperties(java.util.Properties props) Deprecated. As of i-net Clear Reports 14.1 use the configuration to set a PropertyChecker
void	checkProperties(java.util.Properties props) Deprecated. As of i-net Clear Reports 14.1 use the configuration to set a PropertyChecker
void	checkProperties(java.util.Properties props, java.lang.Object req) Deprecated. As of i-net Clear Reports 14.1 use the configuration to set a PropertyChecker
void	checkProperties(Engine engine, java.util.Properties prop) Deprecated. As of i-net Clear Reports 14.1 use the configuration to set a PropertyChecker
void	checkProperties(Engine engine, java.util.Properties prop, java.lang.Object req) Deprecated. As of i-net Clear Reports 14.1 use the configuration to set a PropertyChecker
int	getPort() Returns TCP/IP port number where the i-net Clear Reports application is listening for report requests.
java.lang.String	getUrlString() Returns the hostname and the tcp/ip port number where the i-net Clear Reports application is listening for report requests.
boolean	isRunning() Returns whether the listener is currently running.
static void	main(java.lang.String[] argv) Starts the i-net Clear Reports server standalone.
void	stop() Stops the Listener web server and closes all connectors.

Constructor Detail

Listener

public Listener()
         throws java.io.IOException

Creates a new listener web server and binds it to the local port number specified in the i-net Clear Reports configuration or to the default port number 9000. The server is started automatically and will be available for requests.

Throws:

java.io.IOException - in case of IO error (e.g. port already in use)

Since:

14.0

Listener

public Listener(boolean autodetectPort)
         throws java.io.IOException

Creates a new listener web server and binds it to the local port number specified in the i-net Clear Reports configuration or to the default port number 9000. The server is started automatically and will be available for requests.

Parameters:

autodetectPort - if set to true and the port number that is specified in the i-net Clear Reports configuration is currently in use then the listener is automatically listening on the next free port number. If set to false you'll need to set a valid free port number in the i-net Clear Reports configuration for the listener to start.

Throws:

java.io.IOException - in case of IO error (e.g. port already in use)

Since:

14.0

Listener

public Listener(boolean autodetectPort,
                java.lang.String bindAddress)
         throws java.io.IOException

Creates a new listener web server and binds it to the local port number specified in the i-net Clear Reports configuration or to the default port number 9000. The server is started automatically and will be available for requests.

Parameters:

autodetectPort - if set to true and the port number that is specified in the i-net Clear Reports configuration is currently in use then the listener is automatically listening on the next free port number. If set to false you'll need to set a valid free port number in the i-net Clear Reports configuration for the listener to start.

bindAddress - the IP address to bind the connector to. E.g. 127.0.0.1 to allow local access only. null if the connector should listen on every available IP. only has an impact if loadFromConfiguration is set to true

Throws:

java.io.IOException - in case of IO error (e.g. port already in use)

Since:

15.0

Listener

public Listener(int port)
         throws java.io.IOException

Creates a new listener web server and binds it to the local port number specified as port parameter. The server is started automatically and will be available for requests.

Parameters:

port - the default port of the server socket, if 0 then the port specified in i-net Clear Reports configuration or the default value 9000 will be used.

Throws:

java.io.IOException - in case of IO error (e.g. port already in use)

Since:

14.0

Listener

public Listener(boolean autodetectPort,
                int port)
         throws java.io.IOException

Creates a new listener web server and binds it to the local port number specified as port parameter. The server is started automatically and will be available for requests.

Parameters:

autodetectPort - if set to true and the port number that is specified in the i-net Clear Reports configuration is currently in use then the listener is automatically listening on the next free port number. If set to false you'll need to set a valid free port number in the i-net Clear Reports configuration for the listener to start.

port - the default port of the web server, if it is 0 then the port specified in the i-net Clear Reports configuration or the default value 9000 will be used.

Throws:

java.io.IOException - in case of IO error (e.g. port already in use)

Since:

14.0

Method Detail

main

public static void main(java.lang.String[] argv)

Starts the i-net Clear Reports server standalone.

Parameters:

argv - Command line arguments are currently not supported. Use system properties with prefix 'cc:' instead.

Since:

6.0

getUrlString

public java.lang.String getUrlString()

Returns the hostname and the tcp/ip port number where the i-net Clear Reports application is listening for report requests. If the listener has several connectors, the URL for the first connector will be returned.

Returns:

http://hostname:portnumber as string

Throws:

java.lang.IllegalStateException - if no connector was specified

Since:

6.0

getPort

public int getPort()

Returns TCP/IP port number where the i-net Clear Reports application is listening for report requests. If the listener has several connectors, the port of the first connector will be returned.

Returns:

port number, if 0 there was an error during ServerSocket creation

Throws:

java.lang.IllegalStateException - if no connector was specified

Since:

6.0

checkProperties

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

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

This method is called by checkProperties(Properties, Object) and is equivalent to checkProperties(props, null) if i-net Clear Reports does not run as servlet.

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(java.util.Properties props,
                                         java.lang.Object req)
                                  throws ReportException

Deprecated. As of i-net Clear Reports 14.1 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(Engine engine,
                                         java.util.Properties prop)
                                  throws ReportException

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

This method is called by checkProperties(Engine, Properties, Object) and is equivalent to checkProperties(engine, prop, null).
You should do the following to register your own PropertiesChecker with that you can check the created engine:

• write a java class extending from EngineFactoryImpl(recommended) or implement EngineFactory
• set your EngineFactory to be the default by calling:

  
   EngineFactory yourFactory;
   Cache.setEngineFactory(yourFactory);
   

• Now you can check the properties in the methods of your EngineFactory:
  EngineFactory.getKey(Properties)
EngineFactory.createEngine(Properties)
  

Parameters:

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

prop - 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:

EngineFactory, EngineFactoryImpl, Cache.setEngineFactory(EngineFactory), checkProperties(Engine, Properties, Object)

checkProperties

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

Deprecated. As of i-net Clear Reports 14.1 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.

prop - 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:




checkHtmlPageProperties

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

Deprecated. As of i-net Clear Reports 14.1 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)

stop

public void stop()
          throws java.io.IOException

Stops the Listener web server and closes all connectors.

Throws:

java.io.IOException - if an I/O error occurs when closing the connectors.

Since:

6.0

See Also:

Engine.stop(), Engine.stop(String), Engine.stopAll()

isRunning

public boolean isRunning()

Returns whether the listener is currently running. May return false if the listener could not be started due to an already used port.

Returns:

true if the listener is running, false if starting failed or the listener was stopped explicitly

Since:

13.1