ch.ralscha.extdirectspring.bean

Class SSEvent

java.lang.Object

ch.ralscha.extdirectspring.bean.SSEvent

public class SSEvent
extends Object

Class represents a response in a Server-Sent Event roundtrip. A SSE method can either return a String or an instance of this class.

The library maps every property to the corresponding keyword in a Server-Sent Event response. If a property in this class is null it will be ignored.

See Server-Sent Specification

Constructor Summary

Constructors

Constructor and Description
SSEvent()

Method Summary

Methods

Modifier and Type	Method and Description
String	getComment()
String	getData()
String	getEvent()
String	getId()
Integer	getRetry()
void	setComment(String comment) Adds a comment to this event.
void	setData(Object data) Sets the data part of the Server-Sent Event response.
void	setData(String data) Sets the data part of the Server-Sent Event response.
void	setEvent(String event) Name of the event.
void	setId(String id) Sets the event source's last event ID.
void	setRetry(Integer retry) Sets the retry value.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SSEvent

public SSEvent()

Method Detail

getId

public String getId()

setId

public void setId(String id)

Sets the event source's last event ID. Next time the client reconnects to the server it will send a HTTP Header Last-Event-ID with the current last event ID. This value does not have to be a number it can be any string.

Parameters:

id - new event source's last event id

getData

public String getData()

setData

public void setData(String data)

Sets the data part of the Server-Sent Event response.

Parameters:

data - the actual payload of the response

setData

public void setData(Object data)

Sets the data part of the Server-Sent Event response.

Parameters:

data - the actual payload of the response. Converted to a String by calling the object's toString() method. If null data is set to null.

getRetry

public Integer getRetry()

setRetry

public void setRetry(Integer retry)

Sets the retry value. This specifies how long the client is waiting after a disconnect before he tries to open a new connection to the server.

Default value is 3000 (3 seconds).

Parameters:

retry - the new retry value in milliseconds

getEvent

public String getEvent()

setEvent

public void setEvent(String event)

Name of the event. On the client side the corresponding event is fired after receiving this response. If empty the default event 'message' will be fired

Parameters:

event - the new name of the event

getComment

public String getComment()

setComment

public void setComment(String comment)

Adds a comment to this event. In the response this is a line starting with : (colon) following by the text from this property. Comments will be ignored by the client but may be useful for debugging.

Parameters:

comment - the new comment for this event