Class PushConfigurationMap
- All Implemented Interfaces:
PushConfiguration
,Serializable
For internal use only. May be renamed or removed in a future release.
- Since:
- 1.0
- Author:
- Vaadin Ltd
- See Also:
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic class
Map for storing push parameters. -
Field Summary
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionReturns the fallback transport type for push.getParameter
(String key) Returns the given parameter, if set.Returns the parameters which have been defined.Returns the mode of bidirectional ("push") communication that is used.Returns the servlet mapping to use for push requests.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
Sets the factory that will be used to create new instances ofPushConnection
.void
setPushMode
(PushMode pushMode) Sets the mode of bidirectional ("push") communication that should be used.void
setPushServletMapping
(String pushServletMapping) Sets the servlet mapping 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
-
Field Details
-
TRANSPORT_KEY
- See Also:
-
FALLBACK_TRANSPORT_KEY
- See Also:
-
PUSH_SERVLET_MAPPING_KEY
- See Also:
-
PUSHMODE_KEY
- See Also:
-
ALWAYS_USE_XHR_TO_SERVER
- See Also:
-
PARAMETERS_KEY
- See Also:
-
-
Constructor Details
-
PushConfigurationMap
Creates a new map for the given node.- Parameters:
node
- the node that the map belongs to
-
-
Method Details
-
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 byTransport
.- Specified by:
getTransport
in interfacePushConfiguration
- Returns:
- The primary transport type
-
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 byTransport
.- Specified by:
getFallbackTransport
in interfacePushConfiguration
- Returns:
- The fallback transport type
-
setPushServletMapping
Description copied from interface:PushConfiguration
Sets the servlet mapping to use for push requests.This is only used when overriding the servlet mapping to use. Setting this to null (the default) will use the default URL.
- Specified by:
setPushServletMapping
in interfacePushConfiguration
- Parameters:
pushServletMapping
- The servlet mapping to use for push
-
getPushServletMapping
Description copied from interface:PushConfiguration
Returns the servlet mapping to use for push requests.This is only used when overriding the servlet mapping to use. Returns null (the default) when the default URL is used.
- Specified by:
getPushServletMapping
in interfacePushConfiguration
- Returns:
- the servlet mapping to use for push requests, or null to use to default
-
getPushMode
Description copied from interface:PushConfiguration
Returns the mode of bidirectional ("push") communication that is used.- Specified by:
getPushMode
in interfacePushConfiguration
- Returns:
- The push mode.
-
getParameter
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 interfacePushConfiguration
- Parameters:
key
- The parameter name- Returns:
- The parameter value or null if not set
-
setParameter
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 interfacePushConfiguration
- Parameters:
key
- The parameter namevalue
- The value
-
getParameterNames
Description copied from interface:PushConfiguration
Returns the parameters which have been defined.- Specified by:
getParameterNames
in interfacePushConfiguration
- Returns:
- A collection of parameter names
-
setPushConnectionFactory
Description copied from interface:PushConfiguration
Sets the factory that will be used to create new instances ofPushConnection
.- Specified by:
setPushConnectionFactory
in interfacePushConfiguration
- Parameters:
factory
- the factory that will be used to create new instances ofPushConnection