activemq-issues mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Max-Julian Pogner (JIRA)" <j...@apache.org>
Subject [jira] [Updated] (AMQ-6939) misleading error message in TcpTransportFactory.java
Date Tue, 27 Mar 2018 09:41:00 GMT

     [ https://issues.apache.org/jira/browse/AMQ-6939?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]

Max-Julian Pogner updated AMQ-6939:
-----------------------------------
    Description: 
A configuration error by the reporter of this issue could have been assisted better by a different
error message and different website documentation.

This issue proposed two changes:

1) Fix the Format-String in the error-message and also enhance the error message with the
path (patch attached).
Note: A related discussion / change was previously held here: AMQ-2256

2) amend the website documentation. as i am newbyly unsure how to produce a patch for the
website, i resort to a pseudo-patch manually written:

 
{code:java}
File: http://activemq.apache.org/tcp-transport-reference.html
In section "Configuration Syntax"
Starting from first line in the section:

- tcp://hostname:port?key=value
+ tcp://«hostname»:«port»[/«bindhostaddress»:«bindhostport»][?key1=value1&key2=value2]
+
+ beside the mandatory hostname and port of the server,
+ the optional path specifies the local address and port to bind the tcp socket to. Note:
the path containing only "/" is invalid (use empty string as path instead), and
+ the optional query string sets one or more of the transport options below.{code}
I am unsure whether the «port» should be documented as optional or mandatory.

  was:
A configuration error by the reporter of this issue could have been assisted better by a different
error message and different website documentation.

This issue proposed two changes:

1) Fix the Format-String in the error-message and also enhance the error message with the
path (patch attached)

2) amend the website documentation. as i am newbyly unsure how to produce a patch for the
website, i resort to a pseudo-patch manually written:

 
{code:java}
File: http://activemq.apache.org/tcp-transport-reference.html
In section "Configuration Syntax"
Starting from first line in the section:

- tcp://hostname:port?key=value
+ tcp://«hostname»:«port»[/«bindhostaddress»:«bindhostport»][?key1=value1&key2=value2]
+
+ beside the mandatory hostname and port of the server,
+ the optional path specifies the local address and port to bind the tcp socket to. Note:
the path containing only "/" is invalid (use empty string as path instead), and
+ the optional query string sets one or more of the transport options below.{code}
I am unsure whether the «port» should be documented as optional or mandatory.


> misleading error message in TcpTransportFactory.java
> ----------------------------------------------------
>
>                 Key: AMQ-6939
>                 URL: https://issues.apache.org/jira/browse/AMQ-6939
>             Project: ActiveMQ
>          Issue Type: Improvement
>          Components: JMS client
>    Affects Versions: 5.15.3
>            Reporter: Max-Julian Pogner
>            Priority: Minor
>              Labels: newbie, pull-request-available
>         Attachments: 0001-TcpTransportFactory-fix-format-in-error-message.patch
>
>
> A configuration error by the reporter of this issue could have been assisted better by
a different error message and different website documentation.
> This issue proposed two changes:
> 1) Fix the Format-String in the error-message and also enhance the error message with
the path (patch attached).
> Note: A related discussion / change was previously held here: AMQ-2256
> 2) amend the website documentation. as i am newbyly unsure how to produce a patch for
the website, i resort to a pseudo-patch manually written:
>  
> {code:java}
> File: http://activemq.apache.org/tcp-transport-reference.html
> In section "Configuration Syntax"
> Starting from first line in the section:
> - tcp://hostname:port?key=value
> + tcp://«hostname»:«port»[/«bindhostaddress»:«bindhostport»][?key1=value1&key2=value2]
> +
> + beside the mandatory hostname and port of the server,
> + the optional path specifies the local address and port to bind the tcp socket to. Note:
the path containing only "/" is invalid (use empty string as path instead), and
> + the optional query string sets one or more of the transport options below.{code}
> I am unsure whether the «port» should be documented as optional or mandatory.



--
This message was sent by Atlassian JIRA
(v7.6.3#76005)

Mime
View raw message