com.bea.wli.reporting
Interface ReportingDataHandler

public interface ReportingDataHandler

A reporting handler takes reporting data stream and processes it. The handler could process and/or store this stream in relational database, file, JMS queue, etc. The implementation of this interface is typically called a reporting provider.

Example:

 import com.bea.wli.reporting.ReportingDataHandler;
 import org.apache.xmlbeans.XmlObject;
 import org.apache.xmlbeans.XmlTokenSource;
 import java.io.InputStream;
 

 public class MyReportingDataHandler implements ReportingDataHandler
 {
    public void handle(XmlObject metadata, InputStream is)
          throws Exception
    {
       ...
    }

    //... other handler method implementations
 }
 

See Also:

ReportingDataManager

Method Summary

void	close() Close this ReportingDataHandler and free all associated resources.
void	flush() Flush any reporting data if it was buffered.
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.

Method Detail

handle

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 data types defined in several reporting schemas under namespace http://www.bea.com/wli/reporting. These could be MessageReporting.xsd, AlertReporting.xsd, etc.

s - reporting data

Throws:

Exception - in case of failure to handle this reporting event

See Also:

org.apache.xmlbeans.XmlObject

handle

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

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

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

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

close

void close()

Close this ReportingDataHandler and free all associated resources. The close method could perform a flush. After close has been called this ReportingDataHandler should no longer be used. This operation would be called while removing handler from ReportingDataManager too.

See Also:

ReportingDataManager.removeHandler(com.bea.wli.reporting.ReportingDataHandler)

flush

void flush()

Flush any reporting data if it was buffered.