Interface RemoteServers.RemoteServer.Builder
- Enclosing interface:
- RemoteServers.RemoteServer
A builder of this type may be created using
newRemoteServerBuilder
and
used to create instances of RemoteServers.RemoteServer
that can be supplied
to createRemoteServer(RemoteServer)
.
- Since:
- 6.7
-
Method Summary
Modifier and TypeMethodDescriptionconnectionOption
(RemoteServers.RemoteServer.ConnectionOption connectionOption, String value) Deprecated.Specifies a single connection option.connectionOptions
(Map<RemoteServers.RemoteServer.ConnectionOption, String> connectionOptions) Deprecated.Specifies a map ofRemoteServers.RemoteServer.ConnectionOption
settings.Deprecated.Creates a remote server object using the current values known to this builder.credentials
(Credentials credentials) Deprecated.Specifies the credentials to use when connecting to the primary server.missingTopicNotificationFilter
(String filter) Deprecated.Specifies a topic selector expression which will filter missing topic notifications propagated from secondary to primary server.Deprecated.Specifies the name of a principal used by the remote server to connect to the primary server.reset()
Deprecated.Reset the builder.
-
Method Details
-
principal
Deprecated.Specifies the name of a principal used by the remote server to connect to the primary server.The default, if not specified is the anonymous principal.
- Parameters:
principal
- principal name or a zero length string to indicate an anonymous connection- Returns:
- this builder
-
credentials
Deprecated.Specifies the credentials to use when connecting to the primary server.The default, if not specified, is
NONE
.- Parameters:
credentials
- the credentials to use- Returns:
- this builder
-
connectionOptions
RemoteServers.RemoteServer.Builder connectionOptions(Map<RemoteServers.RemoteServer.ConnectionOption, String> connectionOptions) Deprecated.Specifies a map ofRemoteServers.RemoteServer.ConnectionOption
settings.This will replace any options currently set for the builder.
Any options not supplied will take their default values.
If no connection options are specified, either using this method or
connectionOption(com.pushtechnology.diffusion.client.features.control.RemoteServers.RemoteServer.ConnectionOption, java.lang.String)
then all options will take their default value.- Parameters:
connectionOptions
- map of options- Returns:
- this builder
-
connectionOption
RemoteServers.RemoteServer.Builder connectionOption(RemoteServers.RemoteServer.ConnectionOption connectionOption, String value) Deprecated.Specifies a single connection option.This will add to the options currently specified to the builder, or replace a value if it has already been specified.
- Parameters:
connectionOption
- the connection optionvalue
- the connection option value or null to remove the option- Returns:
- this builder
-
missingTopicNotificationFilter
Deprecated.Specifies a topic selector expression which will filter missing topic notifications propagated from secondary to primary server.TopicControl.MissingTopicNotification
s are notified when a client subscribes using a topic selector that matches no existing topics. By specifying a missing topic notification filter all notifications that match the filter on the secondary server will be propagated to the primary server.A match occurs if the path prefix of the subscription selector matches the path prefix of the specified selector. If the selector is a
selector set
then the notification will be propagated if it matches any selector in the set.If no filter is specified then no missing topic notifications will be propagated.
The special selector expression "*.*" may be used to indicate that all missing topic notifications should be propagated.
Only the path prefix of the specified selector(s) is considered when matching therefore any use of regular expressions would be ignored.
- Parameters:
filter
- a topic selector expression specifying the filter to apply or null to remove any existing filter- Returns:
- this builder
-
reset
Deprecated.Reset the builder.- Returns:
- this Builder
-
create
Deprecated.Creates a remote server object using the current values known to this builder.This will always return an instance of
RemoteServers.SecondaryInitiator
.- Parameters:
name
- the name of the remote serverurl
- the URL to use to connect to the primary server- Returns:
- a new remote server instance
-
This builder is retained for backwards compatibility only. It can only be used to create a secondary initiator.
RemoteServers.SecondaryInitiator.SecondaryInitiatorBuilder
should be used in preference. This builder will be removed in a future release.