com.businessobjects.publisher.dynamicrecipients
Interface IDataProvider

All Superinterfaces:

java.io.Serializable

public interface IDataProvider
extends java.io.Serializable

This interface must be implemented by dynamic recipient data provider publication extensions. It is used to retrieve recipients from an external data source.

Method Summary

void	close() This method must be implemented clean up any resources that were used during the retrieval of dynamic recipients.
java.sql.ResultSet	getRecipients(IDataProviderContext context) This method is invoked when the publishing engine builds the list of recipients for the publication.
java.util.List	getSources(IDataProviderContext context) For internal use only.
boolean	keepAlive() Returns whether the connection to the data source is still alive.

Method Detail

getRecipients

java.sql.ResultSet getRecipients(IDataProviderContext context)
                                 throws java.sql.SQLException,
                                        java.lang.Exception

This method is invoked when the publishing engine builds the list of recipients for the publication. It must be implement to retrieve the recipients from a data source and return then in a ResultSet object.

Parameters:

context - An object containing contextual information

Returns:

A JDBC ResultSet containing the dynamic recipients to be subscribed to the publication.

Throws:

java.sql.SQLException

java.lang.Exception

getSources

java.util.List getSources(IDataProviderContext context)
                          throws java.sql.SQLException,
                                 java.lang.Exception

For internal use only.

Throws:

java.sql.SQLException

java.lang.Exception

keepAlive

boolean keepAlive()
                  throws java.sql.SQLException,
                         java.lang.Exception

Returns whether the connection to the data source is still alive. This method must be implemented to ping the data source to keep the connection alive (if required.)

Returns:

true if the connection is still alive, otherwise false.

Throws:

java.sql.SQLException

java.lang.Exception

close

void close()
           throws java.sql.SQLException,
                  java.lang.Exception

This method must be implemented clean up any resources that were used during the retrieval of dynamic recipients.

Throws:

java.sql.SQLException

java.lang.Exception