Package io.vertx.ext.stomp

Class StompClientOptions

    • Constructor Detail

      • StompClientOptions

        public StompClientOptions()
        Default constructor.

      • StompClientOptions

        public StompClientOptions​(JsonObject json)
        Creates an instance from a JsonObject.
        Parameters:
        json - the JsonObject to create it from

    • Method Detail

      • getHost

        public String getHost()
        Gets the STOMP server host.
        Returns:
        the STOMP server host

      • getLogin

        public String getLogin()
        Gets the configured login.
        Returns:
        the login

      • getPasscode

        public String getPasscode()
        Gets the configured passcode.
        Returns:
        the passcode

      • getPort

        public int getPort()
        Gets the STOMP server port.
        Returns:
        the port

      • getAcceptedVersions

        public List<String> getAcceptedVersions()
        Gets the list of STOMP protocol versions accepted by the client.
        Returns:
        the list of accepted version

      • setAcceptedVersions

        public StompClientOptions setAcceptedVersions​(List<String> acceptedVersions)
        Sets the list of STOMP protocol versions accepted by the client. The list must be ordered from the lowest version to the highest. By default the following list is used: 1.0, 1.1, 1.2
        Parameters:
        acceptedVersions - the order list of accepted versions
        Returns:
        the current StompClientOptions

      • isAutoComputeContentLength

        public boolean isAutoComputeContentLength()
        Whether or not the automatic computation of the content-length header is enabled.
        Returns:
        whether or not the option is enabled

      • setAutoComputeContentLength

        public StompClientOptions setAutoComputeContentLength​(boolean autoComputeContentLength)
        Sets whether or not the automatic computation of the content-length header is enabled. If enabled, the content-length header is set in all frame with a body that do not explicitly set the header. The option is enabled by default.
        Parameters:
        autoComputeContentLength - true to enable the option, false to disable it.
        Returns:
        the current StompClientOptions

      • isUseStompFrame

        public boolean isUseStompFrame()
        Checks whether or not the connection is made using the STOMP command instead of the CONNECT command. The STOMP command has been introduced in the 1.2 version of the protocol to ease the network analysis (as CONNECT is also used by HTTP. To be compliant with server not implementing the 1.2 specification, this option should be disabled.
        Returns:
        whether or not the option is enabled

      • setUseStompFrame

        public StompClientOptions setUseStompFrame​(boolean useStompFrame)
        Sets whether or not the connection is made using the STOMP command instead of the CONNECT command. The STOMP command has been introduced in the 1.2 version of the protocol to ease the network analysis (as CONNECT is also used by HTTP. To be compliant with server not implementing the 1.2 specification, this option should be disabled. This option is disabled by default.
        Parameters:
        useStompFrame - true to enable the option, false to disable it.
        Returns:
        the current StompClientOptions

      • setSsl

        public StompClientOptions setSsl​(boolean ssl)
        Description copied from class: TCPSSLOptions
        Set whether SSL/TLS is enabled
        Overrides:
        setSsl in class NetClientOptions
        Parameters:
        ssl - true if enabled
        Returns:
        a reference to this, so the API can be used fluently

      • isBypassHostHeader

        public boolean isBypassHostHeader()
        Checks whether or not the host header must be dropped from the CONNECT/STOMP frame. Server may be picky about this header (such as RabbitMQ that does not support it).
        Returns:
        whether or not the option is enabled

      • setBypassHostHeader

        public StompClientOptions setBypassHostHeader​(boolean bypassHostHeader)
        Sets whether or not the host header must be dropped from the CONNECT/STOMP frame. Server may be picky about this header (such as RabbitMQ that does not support it). Options disabled by default.
        Parameters:
        bypassHostHeader - true to enable the option, false to disable it.
        Returns:
        the current StompClientOptions

      • getHeartbeat

        public JsonObject getHeartbeat()
        Gets the heartbeat configuration.
        Returns:
        the heartbeat configuration
        See Also:
        Frame.Heartbeat

      • getVirtualHost

        public String getVirtualHost()
        Gets the virtual host that would be use a "host" header value in the `CONNECT` frame. This option is useful for Cloud AMQP.
        Returns:
        the virtual host

      • setVirtualHost

        public StompClientOptions setVirtualHost​(String virtualHost)
        Sets the virtual host that will be used as "host" header value in the `CONNECT` frame.
        Parameters:
        virtualHost - the virtual host
        Returns:
        the current StompClientOptions

      • isTrailingLine

        public boolean isTrailingLine()
        Gets whether or not an empty line should be appended to the written STOMP frame. This option is disabled by default. This option is not compliant with the STOMP specification, and so is not documented on purpose.
        Returns:
        whether or not an empty line should be appended to the written STOMP frame.

      • setTrailingLine

        public StompClientOptions setTrailingLine​(boolean trailingLine)
        Sets whether or not an empty line should be appended to the written STOMP frame. This option is disabled by default. This option is not compliant with the STOMP specification, and so is not documented on purpose.
        Parameters:
        trailingLine - true to add an empty line, false otherwise
        Returns:
        the current StompClientOptions