atg.dms.patchbay

Interface MessageSource

All Known Implementing Classes:

AgentMessageSource, ElectronicFulfiller, EventSender, EventSenderDroplet, FulfillerSystem, GenerateInvoiceMessage, GenerateInvoiceMessage, GSAInvalidatorService, HardgoodFulfiller, IntegrationRepositoryTools, atg.commerce.fulfillment.InventoryFulfiller, LocalizingInventoryManager, MarkerMessageSource, MessageForwardFilter, MessagePipelineMapper, MessagePipelineMapper, MessageSender, NoInventoryManager, OrderCanceller, OrderCanceller, OrderChangeHandler, OrderFulfiller, PricingTools, ProcSendApprovalCompleteMessage, ProcSendApprovalCompleteMessage, ProcSendApprovalMessage, ProcSendApprovalMessage, ProcSendApprovalRequiredMessage, ProcSendApprovalRequiredMessage, ProcSendFulfillmentMessage, ProcSendGiftPurchasedMessage, ProcSendPromotionUsedMessage, ProcSendScenarioEvent, RepositoryInventoryManager, ScheduledOrderTools, SearchEventSender, SourceSinkTemplate

public interface MessageSource

This is the interface that must be implemented by components in the patch bay configured as message sources or message filters.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASS_VERSION Class version string

Method Summary

Methods

Modifier and Type	Method and Description
void	setMessageSourceContext(MessageSourceContext pContext) This notifies the MessageSource as to what its MessageSourceContext should be.
void	startMessageSource() This is called to tell the MessageSource that it may begin sending messages.
void	stopMessageSource() This is called to tell the MessageSource that it should stop sending messages.

Field Detail

CLASS_VERSION

static final java.lang.String CLASS_VERSION

Class version string

See Also:

Constant Field Values

Method Detail

setMessageSourceContext

void setMessageSourceContext(MessageSourceContext pContext)

This notifies the MessageSource as to what its MessageSourceContext should be. The context is what the component should use to generate and send out Messages. The component should not actually start to send out Messages until startMessageSource() is called. An implementation will generally store the MessageSourceContext in a member variable.

startMessageSource

void startMessageSource()

This is called to tell the MessageSource that it may begin sending messages.

stopMessageSource

void stopMessageSource()

This is called to tell the MessageSource that it should stop sending messages.