1. jms-spec
  2. JMS_SPEC-139

Clarify scope of ClientID between JavaDoc and specification


    • Type: Improvement Improvement
    • Status: Open
    • Priority: Major Major
    • Resolution: Unresolved
    • Affects Version/s: 2.0
    • Fix Version/s: None
    • Labels:


      The JavaDoc for the javax.jms.Connection setClientID method includes the following line

      "If another connection with the same clientID is already running when this method is called, the JMS provider should detect the duplicate ID and throw an InvalidClientIDException."

      The JMS2.0 TCK does include a test that checks that if a second connection is created from a CF with a client ID set, then the second create connection fails. I do not believe that this tested existing within the 1.1 TCK.

      This line and test means that the scope of a ClientID is per active Connection (or context).

      The text (PDF) specification does not explicitly state this - it says..

      "The purpose of client identifier is to associate a connection and its objects with a state maintained on behalf of the client by a provider. By definition, the client state identified by a client identifier can be 'in use' by only one client at a time. A JMS provider must prevent concurrently executing clients from using it."

      It says "concurrently executing clients" not "concurrently executing connections". This also implies that the definition of the word 'client' is a single active connection. Again this is not stated explicitly.

      It does mean that pooling implementations have to be careful. They can not keep pools of active connections all from the same client ID. The connections in the pools must be stopped first.


        mbwhite created issue -
        Nigel Deakin made changes -
        Field Original Value New Value
        Tags jms21-forreview-minor


          • Assignee:
          • Votes:
            0 Vote for this issue
            0 Start watching this issue


            • Created: