Package com.onenetwork.platform.integ.msg

APIs for using Platform's message queuing system.

Interface Summary

Interface	Description
DynamicCsvChunker	Interface used to dynamically chunk a large integration file into smaller pieces.
InboundProcessingEvent	Interface for handling events in the lifecycle of the Message
InboundProcessor	Interface for processing inbound Messages.
Message	A message which can be stored in a Platform message queue.
MessageDestination	Interface to be used by the OutboundMessageHandler during routing to send a Message to a destination.
MessageDetailService	Each Message can contain potentially contain thousands or even millions of records.
MessageHandler	Interface for classes which will process ("dequeue") a message
MessageQueueService	Allows for the enqueuing of new Messages, and the pausing/unpausing of existing queues.
MessageTransformContext	Provides contextual information around the Transformation
ModelOutboundGenerator	Model-based outbound generator which generates outbound data based on model objects given as input.
NetChangeOutboundGenerator	NetChange-based outbound generator which generates outbound data based on a date range.
OutboundMessageService	Service for generating outbound data using outbound interfaces from studio.
OutboundProcessingEvent	Interface for handling events in the lifecycle of the Message
QueueRef	Natural Key-based reference to a Message Queue.
SysIdOutboundGenerator	SysId-based outbound generator to generate outbound data based on surrogate ids of models.

Class Summary

Class	Description
AbstractInboundProcessor	Simplified base class for implementing InboundProcessor.
BaseInboundProcessingListener	Base class which defines event handlers for the events inside the InboundProcessor; all of the methods in this class have default implementations, so a subclass only needs to implement the methods it needs.
BaseOutboundProcessingListener	Base class which defines event handlers for the events inside the outbound MessageHandler; all of the methods in this class have default implementations, so a subclass only needs to implement the methods it needs.
ContextResolver	Resolver class to resolve the context to process an inbound message.
DelimiterTransform	Use this transform to write the payload with a custom delimiter instead of the delimiter specified on the interface for outbound messages and for inbound messages, use this transform to convert the payload with a custom delimiter to the one specified on the interface.
DynamicChunkingContext	Stores the context for a DynamicCsvChunker
InboundCsvTransformer	Base class for all CsvTransformers, extending this class allows us to add more methods without breaking backward compatibility.
MessageTransform	Extend this base class to transform a message payload during enqueue or dequeue of a Message.
ModelJsonCsvTransformer	Base class for all Model based CsvTransformers, and Model based Json transformer
ModelOutboundCsvTransformer	Deprecated.
ModelOutboundInterfaceWriteRequest	Request to generate outbound data based on in-memory Model objects.
ModelOutboundProcessingContext	Processing context to generate outbound data based on in-memory Model objects.
NetChangeOutboundProcessingContext	Processing context to generate outbound data based on a net change query.
OutboundCsvTransformContext	Deprecated.
OutboundInterfaceWriteRequest	Encapsulates request parameters required to generate outbound data using a SQL Query without specific input like Model objects or surrogate ids.
OutboundProcessingContext	Base class for the context provided to outbound processors.
ReportOutboundInterfaceWriteRequest	Request to generate outbound data based on a report favorite.
SplitPayloadTransform	SplitPayloadTransform splits a large payload and enqueue the smaller chunks.
SqlDefCsvTransformer
SqlDefOutboundCsvTransformer	Deprecated. use SqlDefCsvTransformer
SysIdOutboundInterfaceWriteRequest	Request to generate outbound data based on surrogate id of models.
SysIdOutboundProcessingContext	Processing context to generate outbound data based on surrogate ids of models.

Enum Summary

Enum	Description
MessageDetailLevel	Message detail levels which can be used for processing messages according to that into message detail table

Exception Summary

Exception	Description
MessageAlreadyEnqueuedException	Thrown in the event when the message is already enqueued - in other words, there is already a Message with the same Sender and Id stored in the system.
MessageQueueServiceException	Base exception thrown when enqueue/dequeue or other messaging operations fail
MessageTransformFailedException	Exception which can be thrown when message transformation fails during dequeue and task should be failed instead of retrying.
MessageWaitException	Exception thrown when Message#await(Long, long, long) is taking more then the given wait time to finish.