com.vaadin.client.communication

Class PushConfiguration

java.lang.Object

com.vaadin.client.communication.PushConfiguration

public class PushConfiguration
extends Object

Provides the push configuration stored in the root node with an easier to use API. Additionally tracks when push is enabled/disabled and informs MessageSender.

Since:

1.0

Author:

Vaadin Ltd

Constructor Summary

Constructors

Constructor and Description
PushConfiguration(Registry registry) Creates a new instance connected to the given registry.

Method Summary

Modifier and Type	Method and Description
JsMap<String,String>	getParameters() Gets all configured push parameters.
String	getPushUrl() Gets the push URL configured on the server.
boolean	isAlwaysXhrToServer() Checks if XHR should be used for client -> server messages even though we are using a bidirectional push transport such as websockets.
boolean	isPushEnabled() Checks if push is enabled.

Methods inherited from class java.lang.Object

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

Constructor Detail

PushConfiguration

public PushConfiguration(Registry registry)

Creates a new instance connected to the given registry.

Parameters:

registry - the global registry

Method Detail

getPushUrl

public String getPushUrl()

Gets the push URL configured on the server.

Returns:

the push URL configured on the server or null if none has been configured

isAlwaysXhrToServer

public boolean isAlwaysXhrToServer()

Checks if XHR should be used for client -> server messages even though we are using a bidirectional push transport such as websockets.

Returns:

true if XHR should always be used, false otherwise

getParameters

public JsMap<String,String> getParameters()

Gets all configured push parameters. The parameters configured on the server, including transports.

Returns:

a map of all parameters configured on the server

isPushEnabled

public boolean isPushEnabled()

Checks if push is enabled.

Returns:

true if push is enabled, false otherwise