public final class StreamStateEvent extends com.streamscape.sdo.event.AbstractMutableEvent implements EventDatagram
Title: Structured Data Objects: Stream State Event
Description: An object that represents a Stream State Event.
Stream State Object
as it's payload, used to convey stream state.
The eventgram provides the same functionality as a DataEvent
but includes a number of methods that
are specific to stream state objects. The event's payload is a StreamState
object. This type of
event may be used by components to signal a change in the state of an event stream and is raised by
SOURCE STREAM
data collections in the Appliaction Dataspace
in response to stream
state changes (for example start or end of a stream).
Copyright: Copyright (c) 2011
Company: StreamScape Technologies
SEMANTIC_TYPE_NAME
DEFAULT_SERIAL_VERSION_ID
Modifier and Type | Method and Description |
---|---|
boolean |
equals(java.lang.Object other) |
java.lang.String |
getStateMessage()
Returns the message describing the stream state which is stored in this event.
|
long |
getStreamPosition()
Returns the current position of the stream which state is stored in this event.
|
StreamState |
getStreamState()
Returns the current state of the stream stored in this event.
|
void |
setStateMessage(java.lang.String stateMessage)
Sets the message describing the stream state which is stored in this event.
|
void |
setStreamPosition(long position)
Sets the position of the stream which state is stored in this event.
|
void |
setStreamState(StreamState streamState)
Sets the state for the stream to be stored in this event.
|
addAnnotation, clearEventProperties, protect, removeAnnotation, removeEventProperty, resetReplyTo, setCorrelationId, setCorrelationIdAsBytes, setDurable, setEventBigDecimalProperty, setEventBigDecimalProperty, setEventBooleanProperty, setEventByteProperty, setEventDoubleProperty, setEventExpiration, setEventFloatProperty, setEventGroupId, setEventIntProperty, setEventKey, setEventLongProperty, setEventObjectProperty, setEventShortProperty, setEventStringProperty, setFinal, setForwardTo, setReplyTo, setSecurityAssertionToken, setSecurityAssertionTokenAsBytes, unprotect
canConvertEventProperty, clone, existsEventProperty, getAnnotatedProperties, getAnnotation, getCorrelationId, getCorrelationIdAsBytes, getDurable, getEventBigDecimalProperty, getEventBooleanProperty, getEventByteProperty, getEventDoubleProperty, getEventExpiration, getEventFloatProperty, getEventGroupId, getEventId, getEventIntProperty, getEventKey, getEventLongProperty, getEventObjectProperty, getEventPropertyNames, getEventPropertyType, getEventShortProperty, getEventSource, getEventStringProperty, getForwardTo, getPermissions, getReadAccess, getReplyTo, getSecurityAssertionToken, getSecurityAssertionTokenAsBytes, getTimestamp, getTransmitAccess, getWriteAccess, hasAnnotatedProperties, hasSuitableAnnotationType, isProtected
getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
addAnnotation, canConvertEventProperty, clearEventProperties, existsEventProperty, getAnnotatedProperties, getAnnotation, getCorrelationId, getCorrelationIdAsBytes, getEventBigDecimalProperty, getEventBooleanProperty, getEventByteProperty, getEventDoubleProperty, getEventExpiration, getEventFloatProperty, getEventIntProperty, getEventLongProperty, getEventObjectProperty, getEventPropertyNames, getEventPropertyType, getEventShortProperty, getEventStringProperty, getForwardTo, getPermissions, getReadAccess, getReplyTo, getSecurityAssertionToken, getSecurityAssertionTokenAsBytes, getTransmitAccess, getWriteAccess, hasAnnotatedProperties, isProtected, protect, removeAnnotation, removeEventProperty, resetReplyTo, setCorrelationId, setCorrelationIdAsBytes, setDurable, setEventBigDecimalProperty, setEventBigDecimalProperty, setEventBooleanProperty, setEventByteProperty, setEventDoubleProperty, setEventExpiration, setEventFloatProperty, setEventGroupId, setEventIntProperty, setEventKey, setEventLongProperty, setEventObjectProperty, setEventShortProperty, setEventStringProperty, setFinal, setForwardTo, setReplyTo, setSecurityAssertionToken, setSecurityAssertionTokenAsBytes, unprotect
clone, getDurable, getEventGroupId, getEventId, getEventKey, getEventSource, getTimestamp
getSerialVersionUID
public long getStreamPosition() throws SecurityViolationException
SecurityViolationException
- if the event is protected from read access.public void setStreamPosition(long position) throws SecurityViolationException
position
- the position to be set for the stream.SecurityViolationException
- if the event is protected from write access.public StreamState getStreamState() throws SecurityViolationException
SecurityViolationException
- if the event is protected from read access.public void setStreamState(StreamState streamState) throws SecurityViolationException, SDOException
streamState
- the state to be set for the stream.SecurityViolationException
- if the event is protected from write access.SDOException
public java.lang.String getStateMessage() throws SecurityViolationException
SecurityViolationException
- if the event is protected from read access.public void setStateMessage(java.lang.String stateMessage) throws SecurityViolationException
stateMessage
- the message to be set for describing the stream state.SecurityViolationException
- if the event is protected from write access.public boolean equals(java.lang.Object other)
equals
in class com.streamscape.sdo.IAbstractDataEvent
Copyright © 2015-2024 StreamScape Technologies. All rights reserved.