Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface SecondaryBuilder<B>

Base builder interface for SecondaryServer.

A builder of this type cannot be instantiated.

Type parameters

  • B

    the builder type.

Hierarchy

Index

Methods

connectionOption

  • connectionOption(connectionOption: ConnectionOption, value?: undefined | string): B
  • 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.

    Not all remote server types support all options. See ConnectionOption for details.

    throws

    an IllegalArgumentError if the connectionOption is invalid

    throws

    a NullValueError if the connectionOption is null

    Parameters

    • connectionOption: ConnectionOption

      the connection option

    • Optional value: undefined | string

      the connection option value or null to remove the option

    Returns B

    this builder

connectionOptions

  • Specifies a map of 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 SecondaryBuilder.connectionOption then all options will take their default value.

    Not all remote server types support all options. See ConnectionOption for details.

    throws

    an IllegalArgumentError if any of the connectionOptions are invalid

    Parameters

    Returns B

    this builder.

credentials

  • Specifies the credentials to use to authenticate the connection.

    The default, if not specified, is null.

    This is used along with the specified principal.

    Parameters

    Returns B

    this builder.

missingTopicNotificationFilter

  • missingTopicNotificationFilter(filter?: undefined | string): B
  • Specifies a topic selector expression which will filter missing topic notifications propagated from secondary to primary server.

    MissingTopicNotifications 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.

    throws

    an IllegalArgumentError if the filter is not a valid topic selector

    Parameters

    • Optional filter: undefined | string

      a topic selector expression specifying the filter to apply or null to remove any existing filter

    Returns B

    this builder

principal

  • principal(principal: string): B
  • Specifies the name of a principal to use for the connection.

    This specifies the principal for the connection to the primary server and is authenticated at the primary server.

    The default, if not specified is the anonymous principal.

    Parameters

    • principal: string

      principal name or a zero length string to indicate an anonymous connection.

    Returns B

    this builder.

reset

  • reset(): B
  • Reset the builder to its default values.

    Returns B

    this Builder