Class OutboundEvent.Builder
- All Implemented Interfaces:
OutboundSseEvent.Builder
- Enclosing class:
- OutboundEvent
OutboundEvent
instances.-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuild()
BuildOutboundEvent
.Set comment string associated with the event.data
(GenericType type, Object data) Set event data and a generic java type of event data.Set event data and java type of event data.Set event data and java type of event data.Set event id.Set themedia type
of the event data.Set event name.reconnectDelay
(long milliseconds) Set reconnection delay (in milliseconds) that indicates how long the event receiver should wait before attempting to reconnect in case a connection to SSE event source is lost.
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
name
Set event name.Will be send as a value of the SSE
"event"
field. This field is optional.- Specified by:
name
in interfaceOutboundSseEvent.Builder
- Parameters:
name
- event name.- Returns:
- updated builder instance.
-
id
Set event id.Will be send as a value of the SSE
"id"
field. This field is optional.- Specified by:
id
in interfaceOutboundSseEvent.Builder
- Parameters:
id
- event id.- Returns:
- updated builder instance.
-
reconnectDelay
Set reconnection delay (in milliseconds) that indicates how long the event receiver should wait before attempting to reconnect in case a connection to SSE event source is lost.Will be send as a value of the SSE
"retry"
field. This field is optional.Absence of a value of this field in an
OutboundEvent
instance is indicated bySseFeature.RECONNECT_NOT_SET
value returned fromOutboundEvent.getReconnectDelay()
.- Specified by:
reconnectDelay
in interfaceOutboundSseEvent.Builder
- Parameters:
milliseconds
- reconnection delay in milliseconds. Negative values un-set the reconnection delay.- Returns:
- updated builder instance.
- Since:
- 2.3
-
mediaType
Set themedia type
of the event data.This information is mandatory. The default value is
MediaType.TEXT_PLAIN
.- Specified by:
mediaType
in interfaceOutboundSseEvent.Builder
- Parameters:
mediaType
-MediaType
of event data. Must not benull
.- Returns:
- updated builder instance.
- Throws:
NullPointerException
- in case themediaType
parameter isnull
.
-
comment
Set comment string associated with the event. The comment will be serialized with the event, before event data are serialized. If the event does not contain any data, a separate "event" that contains only the comment will be sent. This information is optional, provided the event data are set.Note that multiple invocations of this method result in a previous comment being replaced with a new one. To achieve multi-line comments, a multi-line comment string has to be used.
- Specified by:
comment
in interfaceOutboundSseEvent.Builder
- Parameters:
comment
- comment string.- Returns:
- updated builder instance.
-
data
Set event data and java type of event data. Type information will be used forMessageBodyWriter
lookup.Note that multiple invocations of this method result in previous even data being replaced with new one.
- Specified by:
data
in interfaceOutboundSseEvent.Builder
- Parameters:
type
- java type of supplied data. Must not benull
.data
- event data. Must not benull
.- Returns:
- updated builder instance.
- Throws:
NullPointerException
- in case eithertype
ordata
parameter isnull
.
-
data
Set event data and a generic java type of event data. Type information will be used forMessageBodyWriter
lookup.Note that multiple invocations of this method result in previous even data being replaced with new one.
- Specified by:
data
in interfaceOutboundSseEvent.Builder
- Parameters:
type
- generic type of supplied data. Must not benull
.data
- event data. Must not benull
.- Returns:
- updated builder instance.
- Throws:
NullPointerException
- in case eithertype
ordata
parameter isnull
.- Since:
- 2.3
-
data
Set event data and java type of event data. This is a convenience method that derives the event data type information from the runtime type of the event data. The supplied event data may be represented asGenericEntity
.Note that multiple invocations of this method result in previous even data being replaced with new one.
- Specified by:
data
in interfaceOutboundSseEvent.Builder
- Parameters:
data
- event data. Must not benull
.- Returns:
- updated builder instance.
- Throws:
NullPointerException
- in case thedata
parameter isnull
.- Since:
- 2.3
-
build
BuildOutboundEvent
.There are two valid configurations:
- if a
comment
is set, all other parameters are optional. If eventdata
andmedia type
is set, event data will be serialized after the comment. - if a
comment
is not set, at least the eventdata
must be set. All other parameters are optional.
- Specified by:
build
in interfaceOutboundSseEvent.Builder
- Returns:
- new
OutboundEvent
instance. - Throws:
IllegalStateException
- when called with invalid configuration (neither a comment nor event data are set).
- if a
-