org.kuali.kfs.gl.batch.service
Interface EnterpriseFeederNotificationService

All Known Implementing Classes:

EnterpriseFeederNotificationServiceImpl

public interface EnterpriseFeederNotificationService

A service that is used to provide notification about the status of an enterprise feed. The implementation may use a variety of other services to perform notification, ranging from simply logging data to sending emails, etc.

Method Summary

String	getFileFeedStatusMessage(String feederProcessName, EnterpriseFeederStatus status, File doneFile, File dataFile, File reconFile, List<Message> errorMessages) Generates the status message that would be generated by a call to notifyFileFeedStatus with the same parameters.
String	getFileFeedStatusMessage(String feederProcessName, EnterpriseFeederStatus status, String doneFileDescription, InputStream doneFileContents, String dataFileDescription, InputStream dataFileContents, String reconFileDescription, InputStream reconFileContents, List<Message> errorMessages) Generates the status message that would be generated by a call to notifyFileFeedStatus with the same parameters.
void	notifyFileFeedStatus(String feederProcessName, EnterpriseFeederStatus status, File doneFile, File dataFile, File reconFile, List<Message> errorMessages) Performs notification about the status of the upload (i.e.
void	notifyFileFeedStatus(String feederProcessName, EnterpriseFeederStatus status, String doneFileDescription, InputStream doneFileContents, String dataFileDescription, InputStream dataFileContents, String reconFileDescription, InputStream reconFileContents, List<Message> errorMessages) Performs notification about the status of the upload (i.e.

Method Detail

notifyFileFeedStatus

void notifyFileFeedStatus(String feederProcessName,
                          EnterpriseFeederStatus status,
                          File doneFile,
                          File dataFile,
                          File reconFile,
                          List<Message> errorMessages)

Performs notification about the status of the upload (i.e. feeding) of a single file set (i.e. done file, data file, and recon file).

Parameters:

feederProcessName - The name of the feeder process; this may correspond to the name of the Spring definition of the feeder step, but each implementation may define how to use the value of this parameter and/or restrictions on its value.

event - The event/status of the upload of the file set

doneFile - The done file

dataFile - The data file

reconFile - The recon file

errorMessages - Any error messages for which to provide notification

notifyFileFeedStatus

void notifyFileFeedStatus(String feederProcessName,
                          EnterpriseFeederStatus status,
                          String doneFileDescription,
                          InputStream doneFileContents,
                          String dataFileDescription,
                          InputStream dataFileContents,
                          String reconFileDescription,
                          InputStream reconFileContents,
                          List<Message> errorMessages)

Performs notification about the status of the upload (i.e. feeding) of a single file set (i.e. done file, data file, and recon file). This method is useful when the file sets are not NOTE: the CALLER MUST CLOSE all of the input streams that are passed in. In addition, the input streams may be used by implementations of this method, and no assumption about the state of the input streams should be made after this method returns.

Parameters:

feederProcessName - The name of the feeder process; this may correspond to the name of the Spring definition of the feeder step, but each implementation may define how to use the value of this parameter and/or restrictions on its value.

event - The event/status of the upload of the file set

doneFileDescription - The description of the done file to be output during notification

doneFileContents - An input stream for the contents of the done file. If the implementation does not require the contents of the file, then null may be passed in.

dataFileDescription - The description of the done file to be output during notification

dataFileContents - An input stream for the contents of the data file. If the implementation does not require the contents of the file, then null may be passed in.

reconFileDescription - The description of the done file to be output during notification

reconFileContents - An input stream for the contents of the recon file. If the implementation does not require the contents of the file, then null may be passed in.

errorMessages - Any error messages for which to provide notification

getFileFeedStatusMessage

String getFileFeedStatusMessage(String feederProcessName,
                                EnterpriseFeederStatus status,
                                File doneFile,
                                File dataFile,
                                File reconFile,
                                List<Message> errorMessages)

Generates the status message that would be generated by a call to notifyFileFeedStatus with the same parameters.

Parameters:

feederProcessName - The name of the feeder process; this may correspond to the name of the Spring definition of the feeder step, but each implementation may define how to use the value of this parameter and/or restrictions on its value.

event - The event/status of the upload of the file set

doneFile - The done file

dataFile - The data file

reconFile - The recon file

errorMessages - Any error messages for which to provide notification

getFileFeedStatusMessage

String getFileFeedStatusMessage(String feederProcessName,
                                EnterpriseFeederStatus status,
                                String doneFileDescription,
                                InputStream doneFileContents,
                                String dataFileDescription,
                                InputStream dataFileContents,
                                String reconFileDescription,
                                InputStream reconFileContents,
                                List<Message> errorMessages)

Generates the status message that would be generated by a call to notifyFileFeedStatus with the same parameters. NOTE: the CALLER MUST CLOSE all of the input streams that are passed in. In addition, the input streams may be used by implementations of this method, and no assumption about the state of the input streams should be made after this method returns.

Parameters:

feederProcessName - The name of the feeder process; this may correspond to the name of the Spring definition of the feeder step, but each implementation may define how to use the value of this parameter and/or restrictions on its value.

event - The event/status of the upload of the file set

doneFileDescription - The description of the done file to be output during notification

doneFileContents - An input stream for the contents of the done file. If the implementation does not require the contents of the file, then null may be passed in.

dataFileDescription - The description of the done file to be output during notification

dataFileContents - An input stream for the contents of the data file. If the implementation does not require the contents of the file, then null may be passed in.

reconFileDescription - The description of the done file to be output during notification

reconFileContents - An input stream for the contents of the recon file. If the implementation does not require the contents of the file, then null may be passed in.

errorMessages - Any error messages for which to provide notification