com.vaadin.flow.internal.nodefeature.

java.lang.Object
- com.vaadin.flow.internal.nodefeature.NodeFeature
- - com.vaadin.flow.internal.nodefeature.NodeMap
  - - com.vaadin.flow.internal.nodefeature.PushConfigurationMap

All Implemented Interfaces:

PushConfiguration, Serializable
```
public class PushConfigurationMap
extends NodeMap
implements PushConfiguration
```
Map for storing the push configuration for a UI.
For internal use only. May be renamed or removed in a future release.

Since:

1.0

Author:

Vaadin Ltd

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class PushConfigurationMap.PushConfigurationParametersMap
Map for storing push parameters.

Field Summary

Fields
Modifier and Type	Field	Description
`static String`	`ALWAYS_USE_XHR_TO_SERVER`
`static String`	`FALLBACK_TRANSPORT_KEY`
`static String`	`PARAMETERS_KEY`
`static String`	`PUSH_URL_KEY`
`static String`	`PUSHMODE_KEY`
`static String`	`TRANSPORT_KEY`

Constructor Summary

Constructors
Constructor Description

PushConfigurationMap(StateNode node)
Creates a new map for the given node.

Method Summary

All Methods
Modifier and Type	Method	Description
`Transport`	`getFallbackTransport()`	Returns the fallback transport type for push.
`String`	`getParameter(String key)`	Returns the given parameter, if set.
`Collection<String>`	`getParameterNames()`	Returns the parameters which have been defined.
`PushMode`	`getPushMode()`	Returns the mode of bidirectional ("push") communication that is used.
`String`	`getPushUrl()`	Returns the URL to use for push requests.
`Transport`	`getTransport()`	Returns the primary transport type for push.
`void`	`setFallbackTransport(Transport fallbackTransport)`	Sets the fallback transport type for push.
`void`	`setParameter(String key, String value)`	Sets the given parameter.
`void`	`setPushConnectionFactory(PushConnectionFactory factory)`	Sets the factory that will be used to create new instances of `PushConnection`.
`void`	`setPushMode(PushMode pushMode)`	Sets the mode of bidirectional ("push") communication that should be used.
`void`	`setPushUrl(String pushUrl)`	Sets the URL to use for push requests.
`void`	`setTransport(Transport transport)`	Sets the primary transport type for push.

Methods inherited from class com.vaadin.flow.internal.nodefeature.NodeMap
clear, collectChanges, contains, forEachChild, generateChangesFromEmpty, get, getOrDefault, getOrDefault, getOrDefault, keySet, mayUpdateFromClient, producePutChange, put, put, remove, updateFromClient

Methods inherited from class com.vaadin.flow.internal.nodefeature.NodeFeature
allowsChanges, attachPotentialChild, detatchPotentialChild, getNode, onAttach, onDetach

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - TRANSPORT_KEY
```
public static final String TRANSPORT_KEY
```
    See Also:
    
    Constant Field Values
  - FALLBACK_TRANSPORT_KEY
```
public static final String FALLBACK_TRANSPORT_KEY
```
    See Also:
    
    Constant Field Values
  - PUSHMODE_KEY
```
public static final String PUSHMODE_KEY
```
    See Also:
    
    Constant Field Values
  - ALWAYS_USE_XHR_TO_SERVER
```
public static final String ALWAYS_USE_XHR_TO_SERVER
```
    See Also:
    
    Constant Field Values
  - PUSH_URL_KEY
```
public static final String PUSH_URL_KEY
```
    See Also:
    
    Constant Field Values
  - PARAMETERS_KEY
```
public static final String PARAMETERS_KEY
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - PushConfigurationMap
```
public PushConfigurationMap(StateNode node)
```
    Creates a new map for the given node.
    
    Parameters:
    
    node - the node that the map belongs to
- Method Detail
  - setTransport
```
public void setTransport(Transport transport)
```
    Description copied from interface: PushConfiguration
    
    Sets the primary transport type for push.
    Note that the new transport type will not be used until the push channel is disconnected and reconnected if already active.
    
    Specified by:
    
    setTransport in interface PushConfiguration
    
    Parameters:
    
    transport - The primary transport type
  - getTransport
```
public Transport getTransport()
```
    Description copied from interface: PushConfiguration
    
    Returns the primary transport type for push.
    Note that if you set the transport type using PushConfiguration.setParameter(String, String) to an unsupported type this method will return null. Supported types are defined by Transport.
    
    Specified by:
    
    getTransport in interface PushConfiguration
    
    Returns:
    
    The primary transport type
  - setFallbackTransport
```
public void setFallbackTransport(Transport fallbackTransport)
```
    Description copied from interface: PushConfiguration
    
    Sets the fallback transport type for push.
    Note that the new transport type will not be used until the push channel is disconnected and reconnected if already active.
    
    Specified by:
    
    setFallbackTransport in interface PushConfiguration
    
    Parameters:
    
    fallbackTransport - The fallback transport type
  - getFallbackTransport
```
public Transport getFallbackTransport()
```
    Description copied from interface: PushConfiguration
    
    Returns the fallback transport type for push.
    Note that if you set the transport type using PushConfiguration.setParameter(String, String) to an unsupported type this method will return null. Supported types are defined by Transport.
    
    Specified by:
    
    getFallbackTransport in interface PushConfiguration
    
    Returns:
    
    The fallback transport type
  - setPushMode
```
public void setPushMode(PushMode pushMode)
```
    Description copied from interface: PushConfiguration
    
    Sets the mode of bidirectional ("push") communication that should be used.
    Add-on developers should note that this method is only meant for the application developer. An add-on should not set the push mode directly, rather instruct the user to set it.
    
    Specified by:
    
    setPushMode in interface PushConfiguration
    
    Parameters:
    
    pushMode - The push mode to use.
  - getPushMode
```
public PushMode getPushMode()
```
    Description copied from interface: PushConfiguration
    
    Returns the mode of bidirectional ("push") communication that is used.
    
    Specified by:
    
    getPushMode in interface PushConfiguration
    
    Returns:
    
    The push mode.
  - setPushUrl
```
public void setPushUrl(String pushUrl)
```
    Description copied from interface: PushConfiguration
    
    Sets the URL to use for push requests.
    This is only used when overriding the URL to use. Setting this to null (the default) will use the default URL.
    
    Specified by:
    
    setPushUrl in interface PushConfiguration
    
    Parameters:
    
    pushUrl - The push URL to use
  - getPushUrl
```
public String getPushUrl()
```
    Description copied from interface: PushConfiguration
    
    Returns the URL to use for push requests.
    This is only used when overriding the URL to use. Returns null (the default) when the default URL is used.
    
    Specified by:
    
    getPushUrl in interface PushConfiguration
    
    Returns:
    
    the URL to use for push requests, or null to use to default
  - getParameter
```
public String getParameter(String key)
```
    Description copied from interface: PushConfiguration
    
    Returns the given parameter, if set.
    This method provides low level access to push parameters and is typically not needed for normal application development.
    
    Specified by:
    
    getParameter in interface PushConfiguration
    
    Parameters:
    
    key - The parameter name
    
    Returns:
    
    The parameter value or null if not set
  - setParameter
```
public void setParameter(String key,
                         String value)
```
    Description copied from interface: PushConfiguration
    
    Sets the given parameter.
    This method provides low level access to push parameters and is typically not needed for normal application development.
    
    Specified by:
    
    setParameter in interface PushConfiguration
    
    Parameters:
    
    key - The parameter name
    
    value - The value
  - getParameterNames
```
public Collection<String> getParameterNames()
```
    Description copied from interface: PushConfiguration
    
    Returns the parameters which have been defined.
    
    Specified by:
    
    getParameterNames in interface PushConfiguration
    
    Returns:
    
    A collection of parameter names
  - setPushConnectionFactory
```
public void setPushConnectionFactory(PushConnectionFactory factory)
```
    Description copied from interface: PushConfiguration
    
    Sets the factory that will be used to create new instances of PushConnection.
    
    Specified by:
    
    setPushConnectionFactory in interface PushConfiguration
    
    Parameters:
    
    factory - the factory that will be used to create new instances of PushConnection

com.vaadin.flow.internal.nodefeature.

Class PushConfigurationMap

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class com.vaadin.flow.internal.nodefeature.NodeMap

Methods inherited from class com.vaadin.flow.internal.nodefeature.NodeFeature

Methods inherited from class java.lang.Object

Field Detail

TRANSPORT_KEY

FALLBACK_TRANSPORT_KEY

PUSHMODE_KEY

ALWAYS_USE_XHR_TO_SERVER

PUSH_URL_KEY

PARAMETERS_KEY

Constructor Detail

PushConfigurationMap

Method Detail

setTransport

getTransport

setFallbackTransport

getFallbackTransport

setPushMode

getPushMode

setPushUrl

getPushUrl

getParameter

setParameter

getParameterNames

setPushConnectionFactory