com.bea.wli.reporting
Class ReportingDataManager

java.lang.Object
  com.bea.wli.reporting.ReportingDataManager

public class ReportingDataManager
extends Object

ReportingDataManager is a server-local singleton object that keeps registry of reporting providers (a reporting provider implements ReportingDataHandler). It provides operations to add and remove reporting data handlers in addition to operation to export/handle reporting data stream.

Example:

Registering a reporting provider ...

 import com.bea.wli.reporting.*;
 ...

 ReportingDataManager rmgr = ReportingDataManager.getManager();
 MyReportingDataHandler myH = new MyReportingDataHandler();
 rmgr.addHandler(myH);
 

 

Unregistering a reporting provider...

 rmgr.removeHandler(myH);
 

If the provider is deployed in the form of a J2EE Application, addHandler and removeHandler methods could be called in postStart and preStop operations respectively of an implementation of weblogic.application.ApplicationLifeCycleListener in the application.

Deployment Order: If J2EE application is used to package the provider then such an application should be deployed after the WebLogic Integration Common components (wlicommon.ear) are deployed.

See Also:

ReportingDataHandler

Method Summary

void	addHandler(ReportingDataHandler handler) Add a reporting data handler to receive reporting data.
ReportingDataHandler[]	getHandlers() Get all handlers registered.
static ReportingDataManager	getManager() Get server-local singleton reporting data manager
void	handle(org.apache.xmlbeans.XmlObject metadata, InputStream is) The handle operation takes reporting data in the form of InputStream and processes and/or stores in appropriate data store.
void	handle(org.apache.xmlbeans.XmlObject metadata, Serializable data) The handle operation takes reporting data stream in the form of Serializable object and processes and/or stores in appropriate data store.
void	handle(org.apache.xmlbeans.XmlObject metadata, String s) The handle operation takes reporting data in the form of String and processes and/or stores in appropriate data store.
void	handle(org.apache.xmlbeans.XmlObject metadata, org.apache.xmlbeans.XmlObject data) The handle operation takes reporting data stream in the form of XmlObject and processes and/or stores in appropriate data store.
void	handle(org.apache.xmlbeans.XmlObject metadata, org.apache.xmlbeans.XmlTokenSource data) The handle operation takes reporting data stream in the form of XmlTokenSource and processes and/or stores in appropriate data store.
void	removeHandler(ReportingDataHandler handler) Remove the specified reporting data handler.
void	shutdown() Shutdown removes and closes all Handlers

Methods inherited from class java.lang.Object

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

Method Detail

getManager

public static ReportingDataManager getManager()

Get server-local singleton reporting data manager

Returns:

ReportingDataManager server-local singleton

shutdown

public void shutdown()

Shutdown removes and closes all Handlers

addHandler

public void addHandler(ReportingDataHandler handler)

Add a reporting data handler to receive reporting data. If there are more than one handlers added, the reporting data would be sent to handlers in the same sequence in which handlers are registered. An implementation of ReportingDataHandler is typically called a provider.

Parameters:

handler - reporting data handler to add

See Also:

ReportingDataHandler

removeHandler

public void removeHandler(ReportingDataHandler handler)

Remove the specified reporting data handler. Returns silently if the given handler is not found or is null.

Parameters:

handler - reporting data handler to remove

See Also:

ReportingDataHandler

getHandlers

public ReportingDataHandler[] getHandlers()

Get all handlers registered. The handlers are returned in the same sequence in which they are registered using the addHandler method.

Returns:

an array of reporting data handler

See Also:

ReportingDataHandler

handle

public void handle(org.apache.xmlbeans.XmlObject metadata,
                   String s)
            throws Exception

The handle operation takes reporting data in the form of String and processes and/or stores in appropriate data store. This is operation supports transaction semantics similar to SUPPORTS attribute of Enterprise Java Beans.

Parameters:

metadata - meta-data for reporting data stream in the form of types defined in http://www.bea.com/wli/reporting.xsd

s - reporting data

Throws:

Exception - in case of failure to handle this reporting event

See Also:

org.apache.xmlbeans.XmlObject

handle

public void handle(org.apache.xmlbeans.XmlObject metadata,
                   InputStream is)
            throws Exception

The handle operation takes reporting data in the form of InputStream and processes and/or stores in appropriate data store. This is operation supports transaction semantics similar to SUPPORTS attribute of Enterprise Java Beans.

Parameters:

metadata - meta-data for reporting data stream in the form of types defined in http://www.bea.com/wli/reporting.xsd

is - reporting data stream

Throws:

Exception - in case of failure to handle this reporting event

See Also:

org.apache.xmlbeans.XmlObject

handle

public void handle(org.apache.xmlbeans.XmlObject metadata,
                   org.apache.xmlbeans.XmlObject data)
            throws Exception

The handle operation takes reporting data stream in the form of XmlObject and processes and/or stores in appropriate data store. This is operation supports transaction semantics similar to SUPPORTS attribute of Enterprise Java Beans.

Parameters:

metadata - meta-data for reporting data stream in the form of types defined in http://www.bea.com/wli/reporting.xsd

data - reporting data stream in the form of XmlObject

Throws:

Exception - in case of failure to handle this reporting event

See Also:

org.apache.xmlbeans.XmlObject

handle

public void handle(org.apache.xmlbeans.XmlObject metadata,
                   org.apache.xmlbeans.XmlTokenSource data)
            throws Exception

The handle operation takes reporting data stream in the form of XmlTokenSource and processes and/or stores in appropriate data store. This is operation supports transaction semantics similar to SUPPORTS attribute of Enterprise Java Beans.

Parameters:

metadata - meta-data for reporting data stream in the form of types defined in http://www.bea.com/wli/reporting.xsd

data - reporting data stream in the form of XmlTokenSource

Throws:

Exception - in case of failure to handle this reporting event

See Also:

org.apache.xmlbeans.XmlTokenSource , org.apache.xmlbeans.XmlObject

handle

public void handle(org.apache.xmlbeans.XmlObject metadata,
                   Serializable data)
            throws Exception

The handle operation takes reporting data stream in the form of Serializable object and processes and/or stores in appropriate data store. This is operation supports transaction semantics similar to SUPPORTS attribute of Enterprise Java Beans.

Parameters:

metadata - meta-data for reporting data stream in the form of types defined in http://www.bea.com/wli/reporting.xsd

data - reporting data stream in the form of Java Serializable object

Throws:

Exception - in case of failure to handle this reporting event

See Also:

org.apache.xmlbeans.XmlObject