com.extrememessaging.ResponseMaster.dispositions

Interface IDisposition

All Known Subinterfaces:

IPoolableDisposition, IResettableDisposition

All Known Implementing Classes:

CDispositionCopyToIMAPFolder, CDispositionDoNothing, CDispositionFilterAndForward, CDispositionForward, CDispositionHttpRequest, CDispositionMoveToSubfolder, CDispositionPool, CDispositionRunSQL, CDispositionWriteAttachmentsToDB, CDispositionWriteAttachmentsToFile, CDispositionWriteRFC822File, CDispositionWriteToDB, CDispositionWriteToFile

public interface IDisposition

The interface that disposition objects must implement.

Method Summary

Modifier and Type	Method and Description
void	Close() Cleanup any resources you allocated during construction or ReadFromFile Note: Close may be called more than once on the same object, but once it is called, Dispose will not be called again.
void	Dispose(CMessage oMessage) Do whatever the disposition type does with the message.
void	ReadFromFile(java.lang.String sFileName) Read the settings for this disposition from a file.

Method Detail

ReadFromFile

void ReadFromFile(java.lang.String sFileName)
           throws ResponseMasterException

Read the settings for this disposition from a file. The sFileName parameter is blank if the DetailedDispositionFile setting is set to 0 for the disposition type in dispositionTypes.xml

Parameters:

sFileName - The name of the file to read

Throws:

ResponseMasterException - if there is a problem

Dispose

void Dispose(CMessage oMessage)
      throws ResponseMasterException

Do whatever the disposition type does with the message. The message should be modified or deleted.

Parameters:

oMessage - The message to process

Throws:

ResponseMasterException - if there is a problem

Close

void Close()

Cleanup any resources you allocated during construction or ReadFromFile Note: Close may be called more than once on the same object, but once it is called, Dispose will not be called again.