Interface CachedMessageFactory
-
public interface CachedMessageFactory
A message factory is used to create cached DataSource messages that can be published to other DataSources.
You do not have to implement this interface yourself. An implementation is provided, and can be retrieved from any
CachingPublisher
by calling theCachingPublisher.getCachedMessageFactory()
method.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description ContainerMessage
createContainerMessage(String subject)
Creates a message that defines a container.GenericMessage
createGenericMessage(String subject)
Creates an empty Generic message to which structured data can be added.JsonMessage
createJsonMessage(String subject, Object userObject)
Creates a JSON message for the given subject.RecordType1Message
createRecordType1Message(String subject)
Creates a Record message to which Type 1 structured data can be added.SubjectErrorEvent
createSubjectErrorEvent(String subject, SubjectError error, SubjectError.Flags... flags)
Creates a subject error event.SubjectStatusEvent
createSubjectStatusEvent(String subject, SubjectStatus status, String message)
Creates a subject status event.
-
-
-
Method Detail
-
createJsonMessage
JsonMessage createJsonMessage(String subject, Object userObject)
Creates a JSON message for the given subject.- Parameters:
subject
- The subject of the message.userObject
- A Java object to be serialized using the installed JsonHandler.- Returns:
- A new JSON message.
-
createRecordType1Message
RecordType1Message createRecordType1Message(String subject)
Creates a Record message to which Type 1 structured data can be added.
The returned message contains no data. To populate the message with data, use the appropriate methods of
RecordType1Message
.- Parameters:
subject
- The subject of the Record.- Returns:
- A new Type 1 Record message.
-
createGenericMessage
GenericMessage createGenericMessage(String subject)
Creates an empty Generic message to which structured data can be added.
Generic messages can be used without specifying field mappings in a separate adapter configuration file. This may be useful when receiving updates from a provider which supplies a variable or unknown number of fields. The returned message contains no data. To populate the message with data, use the appropriate methods of
GenericMessage
.- Parameters:
subject
- The subject of the Record.- Returns:
- A new Generic Type message.
-
createContainerMessage
ContainerMessage createContainerMessage(String subject)
Creates a message that defines a container. The name of the container is the given subject.
- Parameters:
subject
- The subject defining the name of the container.- Returns:
- A message defining the container.
-
createSubjectErrorEvent
SubjectErrorEvent createSubjectErrorEvent(String subject, SubjectError error, SubjectError.Flags... flags)
Creates a subject error event.- Parameters:
subject
- The subject to which the error relates.error
- The error.flags
- Additional flags to be set on the nodata- Returns:
- A subject error event.
-
createSubjectStatusEvent
SubjectStatusEvent createSubjectStatusEvent(String subject, SubjectStatus status, String message)
Creates a subject status event.- Parameters:
subject
- The subject to which the status relates.status
- The status.message
- A free form textual message indicating the reason for the status message being raised.- Returns:
- A subject status event.
-
-