Package ch.colabproject.colab.api.controller

Class SubscriptionRequest

java.lang.Object

ch.colabproject.colab.api.controller.SubscriptionRequest

All Implemented Interfaces:

Serializable

public class SubscriptionRequest
extends Object
implements Serializable

Subscription request to be propagated through the cluster to reach the instance which is responsible for the given wsSessionId

Author:

maxence

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	SubscriptionRequest.ChannelType	One-to-one mapping to EffectiveChannels
static enum	SubscriptionRequest.SubscriptionType	Subscript or unsubscribe

Constructor Summary

Constructors

Constructor	Description
SubscriptionRequest()

Method Summary

Modifier and Type	Method	Description
static SubscriptionRequest	build(SubscriptionRequest.SubscriptionType type, SubscriptionRequest.ChannelType channelType, Long channelId, String wsSessionId, Long httpSessionId)	Build a request message
Long	getChannelId()	Get id channel
SubscriptionRequest.ChannelType	getChannelType()	get channel type.
Long	getColabSessionId()	Get http session id
SubscriptionRequest.SubscriptionType	getType()	Get the type of request
String	getWsSessionId()	Get the ws session id
void	setChannelId(Long channelId)	Set id of the channel
void	setChannelType(SubscriptionRequest.ChannelType channelType)	Set the type of channel
void	setColabSessionId(Long colabSessionId)	Set HTTP session id
void	setType(SubscriptionRequest.SubscriptionType type)	Set type of request
void	setWsSessionId(String wsSessionId)	Set the websocket session id
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

SubscriptionRequest

public SubscriptionRequest()

Method Details

getType

public SubscriptionRequest.SubscriptionType getType()

Get the type of request

Returns:

request type

setType

public void setType(SubscriptionRequest.SubscriptionType type)

Set type of request

Parameters:

type - subscript or unsubscribe

getWsSessionId

public String getWsSessionId()

Get the ws session id

Returns:

the ws session id

setWsSessionId

public void setWsSessionId(String wsSessionId)

Set the websocket session id

Parameters:

wsSessionId - ws session id

getColabSessionId

public Long getColabSessionId()

Get http session id

Returns:

http session id

setColabSessionId

public void setColabSessionId(Long colabSessionId)

Set HTTP session id

Parameters:

colabSessionId - id of the HTTP session

getChannelType

public SubscriptionRequest.ChannelType getChannelType()

get channel type.

Returns:

the type

setChannelType

public void setChannelType(SubscriptionRequest.ChannelType channelType)

Set the type of channel

Parameters:

channelType - new channel type

getChannelId

public Long getChannelId()

Get id channel

Returns:

id of the channel

setChannelId

public void setChannelId(Long channelId)

Set id of the channel

Parameters:

channelId - new id

toString

public String toString()

Overrides:

toString in class Object

build

public static SubscriptionRequest build(SubscriptionRequest.SubscriptionType type,
 SubscriptionRequest.ChannelType channelType,
 Long channelId,
 String wsSessionId,
 Long httpSessionId)

Build a request message

Parameters:

type - type of the request

channelType - channel type

channelId - channel id

wsSessionId - ws id

httpSessionId - http id

Returns:

the request