Package co.arago.hiro.client.websocket

Class EventWebSocket.Conf<T extends EventWebSocket.Conf<T>>

java.lang.Object

co.arago.hiro.client.websocket.AuthenticatedWebSocketHandler.Conf<T>

co.arago.hiro.client.websocket.EventWebSocket.Conf<T>

Direct Known Subclasses:

EventWebSocket.Builder

Enclosing class:

EventWebSocket

public abstract static class EventWebSocket.Conf<T extends EventWebSocket.Conf<T>>
extends AuthenticatedWebSocketHandler.Conf<T>

Constructor Summary

Constructors

Constructor	Description
Conf()

Method Summary

Modifier and Type	Method	Description
T	addEventsFilter(EventsFilter eventsFilter)	Add a single filter to the map of event filters.
T	addEventsFilter(java.lang.String id, java.lang.String content)	Add a single filter to the map of event filters.
T	addEventsFilter(java.lang.String id, java.lang.String content, java.lang.String type)	Add a single filter to the map of event filters.
T	addEventsFilterMap(java.util.Map<java.lang.String,EventsFilter> eventsFilterMap)	Add filters
T	addScope(java.lang.String scope)	Add a single scope to scopes.
T	addScopes(java.util.Set<java.lang.String> scopes)	Add a list of scopes for the events.
abstract EventWebSocket	build()
java.util.Map<java.lang.String,EventsFilter>	getEventsFilterMap()
EventWebSocketListener	getEventWebSocketListener()
java.util.Set<java.lang.String>	getScopes()
T	setAllScopes(boolean allScopes)	Set query parameter "allscopes"
T	setDelta(boolean delta)	Set query parameter "delta"
T	setEventsFilterMap(java.util.Map<java.lang.String,EventsFilter> eventsFilterMap)	Set the filters
T	setEventWebSocketListener(EventWebSocketListener eventWebSocketListener)	Set eventWebSocketListener.
T	setGroupId(java.lang.String groupId)	Set query parameter "groupId"
T	setOffset(java.lang.String offset)	Set query parameter "offset"
T	setScopes(java.util.Set<java.lang.String> scopes)	Set a list of scopes for the events.

Methods inherited from class co.arago.hiro.client.websocket.AuthenticatedWebSocketHandler.Conf

getApiName, getEndpoint, getMaxRetries, getName, getProtocol, getTokenApiHandler, getWebSocketMessageTimeout, isReconnectOnFailedSend, self, setApiName, setEndpointAndProtocol, setFragment, setHeaderParam, setHeaders, setHeaders, setMaxRetries, setName, setQuery, setQuery, setQueryParam, setReconnectOnFailedSend, setTokenApiHandler, setWebSocketMessageTimeout

Methods inherited from class java.lang.Object

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

Constructor Detail

Conf

public Conf()

Method Detail

setDelta

public T setDelta(boolean delta)

Set query parameter "delta"

Parameters:

delta - Subscribe to delta events stream

Returns:

AuthenticatedWebSocketHandler.Conf.self()

See Also:

API Documentation

setGroupId

public T setGroupId(java.lang.String groupId)

Set query parameter "groupId"

Parameters:

groupId - Subscribe to specific group of events listeners

Returns:

AuthenticatedWebSocketHandler.Conf.self()

See Also:

API Documentation

setOffset

public T setOffset(java.lang.String offset)

Set query parameter "offset"

Parameters:

offset - Offset for events

Returns:

AuthenticatedWebSocketHandler.Conf.self()

See Also:

API Documentation

setAllScopes

public T setAllScopes(boolean allScopes)

Set query parameter "allscopes"

Parameters:

allScopes - Subscribe to all data scopes by default. Default is "false".

Returns:

AuthenticatedWebSocketHandler.Conf.self()

See Also:

API Documentation

getScopes

public java.util.Set<java.lang.String> getScopes()

setScopes

public T setScopes(java.util.Set<java.lang.String> scopes)

Set a list of scopes for the events.

Parameters:

scopes - List of scopes (ogit - ids of the scopes).

Returns:

AuthenticatedWebSocketHandler.Conf.self()

addScopes

public T addScopes(java.util.Set<java.lang.String> scopes)

Add a list of scopes for the events.

Parameters:

scopes - List of scopes (ogit - ids of the scopes).

Returns:

AuthenticatedWebSocketHandler.Conf.self()

addScope

public T addScope(java.lang.String scope)

Add a single scope to scopes.

Parameters:

scope - The scope to add

Returns:

AuthenticatedWebSocketHandler.Conf.self()

getEventsFilterMap

public java.util.Map<java.lang.String,EventsFilter> getEventsFilterMap()

setEventsFilterMap

public T setEventsFilterMap(java.util.Map<java.lang.String,EventsFilter> eventsFilterMap)

Set the filters

Parameters:

eventsFilterMap - A map of filters to use. The keys are the EventsFilter.id.

Returns:

AuthenticatedWebSocketHandler.Conf.self()

addEventsFilterMap

public T addEventsFilterMap(java.util.Map<java.lang.String,EventsFilter> eventsFilterMap)

Add filters

Parameters:

eventsFilterMap - A map of filters to use. The keys are the EventsFilter.id.

Returns:

AuthenticatedWebSocketHandler.Conf.self()

addEventsFilter

public T addEventsFilter(EventsFilter eventsFilter)

Add a single filter to the map of event filters.

Parameters:

eventsFilter - : The filter to add.

Returns:

AuthenticatedWebSocketHandler.Conf.self()

addEventsFilter

public T addEventsFilter(java.lang.String id,
                         java.lang.String content)

Add a single filter to the map of event filters.

Parameters:

id - ID of the filter

content - Content of the filter

Returns:

AuthenticatedWebSocketHandler.Conf.self()

addEventsFilter

public T addEventsFilter(java.lang.String id,
                         java.lang.String content,
                         java.lang.String type)

Add a single filter to the map of event filters.

Parameters:

id - ID of the filter

content - Content of the filter

type - Type of the filter (usually only "jfilter")

Returns:

AuthenticatedWebSocketHandler.Conf.self()

getEventWebSocketListener

public EventWebSocketListener getEventWebSocketListener()

setEventWebSocketListener

public T setEventWebSocketListener(EventWebSocketListener eventWebSocketListener)

Set eventWebSocketListener. This will receive incoming data.

Parameters:

eventWebSocketListener - Reference to the listener to use.

Returns:

AuthenticatedWebSocketHandler.Conf.self()

build

public abstract EventWebSocket build()

Specified by:

build in class AuthenticatedWebSocketHandler.Conf<T extends EventWebSocket.Conf<T>>