com.solacesystems.jcsmp

Interface CacheEventMessage

All Superinterfaces:

BytesXMLMessage, EventMessage, XMLMessage

public interface CacheEventMessage
extends EventMessage

An event that signals the termination of a cache request.

Only the methods defined in this interface may be called. Methods inherited from BytesXMLMessage through EventMessage are not applicable to a CacheEventMessage. Such inherited methods throw an UnsupportedOperationException if called.

Nested Class Summary

Nested classes/interfaces inherited from interface com.solacesystems.jcsmp.XMLMessage

XMLMessage.MessageUserPropertyConstants, XMLMessage.Outcome

Field Summary

Fields inherited from interface com.solacesystems.jcsmp.XMLMessage

MSGDUMP_BRIEF, MSGDUMP_FULL

Method Summary

Modifier and Type	Method and Description
JCSMPException	getCacheRequestException() Returns the exception that occurred when a cache request failed.
CacheRequestResult	getCacheRequestResult() Returns the result of the cache request.
Topic	getCacheRequestTopic() Returns the topic the cache data was for.

Methods inherited from interface com.solacesystems.jcsmp.BytesXMLMessage

getBytes, readBytes, readBytes, rewindContent, writeBytes, writeBytes

Methods inherited from interface com.solacesystems.jcsmp.XMLMessage

ackMessage, clearAttachment, clearContent, dump, dump, getApplicationMessageId, getApplicationMessageType, getAppMessageID, getAppMessageType, getAttachmentByteBuffer, getAttachmentContentLength, getCacheRequestId, getConsumerIdList, getContentLength, getCorrelationId, getCorrelationKey, getCos, getDeliverToOne, getDeliveryCount, getDeliveryMode, getDestination, getDestinationTopicSuffix, getDiscardIndication, getExpiration, getHTTPContentEncoding, getHTTPContentType, getMessageId, getMessageIdLong, getMessageType, getPriority, getProperties, getReceiveTimestamp, getRedelivered, getReplicationGroupMessageId, getReplyTo, getReplyToSuffix, getSenderId, getSenderID, getSenderTimestamp, getSendTimestamp, getSequenceNumber, getTimeToLive, getTopicSequenceNumber, getUserData, hasAttachment, hasContent, hasUserData, isAckImmediately, isCacheMessage, isDMQEligible, isElidingEligible, isReadOnly, isReplyMessage, isSuspect, readAttachmentBytes, readAttachmentBytes, readAttachmentBytes, readContentBytes, readContentBytes, readContentBytes, rejectMessage, reset, rewindAttachment, setAckImmediately, setApplicationMessageId, setApplicationMessageType, setAppMessageID, setAppMessageType, setAsReplyMessage, setCorrelationId, setCorrelationKey, setCos, setDeliverToOne, setDeliveryMode, setDMQEligible, setElidingEligible, setExpiration, setHTTPContentEncoding, setHTTPContentType, setMessageType, setPriority, setProperties, setReadOnly, setReplyTo, setReplyToSuffix, setSenderId, setSenderID, setSenderTimestamp, setSendTimestamp, setSequenceNumber, setTimeToLive, settle, setUserData, writeAttachment, writeAttachment, writeAttachment, writeNewAttachment, writeNewAttachment, writeNewAttachment, writeNewAttachment

Method Detail

getCacheRequestResult

CacheRequestResult getCacheRequestResult()

Returns the result of the cache request. Null if an error occurred.

Returns:

The result of the cache request. Null if an error occurred.

getCacheRequestTopic

Topic getCacheRequestTopic()

Returns the topic the cache data was for.

Returns:

The topic the cache data was for.

getCacheRequestException

JCSMPException getCacheRequestException()

Returns the exception that occurred when a cache request failed. Null if the cache request was successful.

Returns:

The exception that occurred when a cache request failed. Null if the cache request was successful.