glassfish
  1. glassfish
  2. GLASSFISH-16567

[UB]Release note should mention ports used by JMS and other services

    Details

    • Type: Bug Bug
    • Status: Resolved
    • Priority: Major Major
    • Resolution: Fixed
    • Affects Version/s: 3.1
    • Fix Version/s: 3.1.1
    • Component/s: docs
    • Labels:
      None

      Description

      In Oracle GlassFish Server 3.1 Release Notes at
      http://download.oracle.com/docs/cd/E18930_01/html/821-2434/abpaj.html#ggpoq
      the section "Required free ports" lists the ports opened by a GlassFish instance.
      There may be other ports that are not described.

      It would also help if this section contained some information (perhaps a cross-reference) on how the user can modify the various ports, particularly if they are not using the installer. It might also mention that the port numbers listed may be be different if the GlassFish instance is clustered.

      This list is also incomplete because it does not mention the ports opened by the embedded MQ broker, some of which are dynamically-allocated. Although there is a cross-reference to the MQ admin guide it is difficult to find the required information there. Here is a short summary for JMS:

      There's the main "JMS port", which may be configured using the GlassFish admin console, which is by default 7676 in a standalone broker. This port is opened when the GlassFish instance starts.

      In addition, iff the application uses MQ, two other ports are opened which correspond to the MQ "tcp" and "admin" connection services. These ports are allocated dynamically by the OS.

      These are described in the Message Queue Administration Guide here:
      http://download.oracle.com/docs/cd/E18930_01/html/821-2438/aeocn.html

      The page above also describes how those dynamic ports can be configured to be static if required (e.g. to pass through a firewall).

        Activity

        Hide
        Paul Davies added a comment -

        From the email discussion of this issue, I get the impression that what is required is a section about port usage by GlassFish Server. This section should provide the following information:

        • A list of all the GlassFish Server entities that open a port, for example, MQ brokers, GMS, the Administration Console and so forth
        • For each item in the list, the default port number that GlassFish Server assigns or, if no default is defined, as statement of how the port number is assigned, for example, "Any free port from in the range between 9090-9200".
        Show
        Paul Davies added a comment - From the email discussion of this issue, I get the impression that what is required is a section about port usage by GlassFish Server. This section should provide the following information: A list of all the GlassFish Server entities that open a port, for example, MQ brokers, GMS, the Administration Console and so forth For each item in the list, the default port number that GlassFish Server assigns or, if no default is defined, as statement of how the port number is assigned, for example, "Any free port from in the range between 9090-9200".
        Hide
        Rebecca Parks added a comment -

        Changed the first sentence of the "Required Free Ports" section of the 3.1.1 Release Notes to read, "You must have unused ports available for the ports GlassFish Server uses." Added the following ports to the "Default Port Assignments for GlassFish Server 3.1-3.1.1" table:

        22 SSH port

        9009 Java debugger

        6666 OSGi shell telnet port

        7676 JMS provider

        9090 GMS TCP start port

        9200 GMS TCP end port

        Auto-generated GMS listener port
        between GMS TCP
        start and end
        ports

        Auto-generated GMS multicast port
        between 2048
        and 32000

        I couldn't find info on the two MQ ports at the link provided. If it's important to list these, please provide more info.

        Show
        Rebecca Parks added a comment - Changed the first sentence of the "Required Free Ports" section of the 3.1.1 Release Notes to read, "You must have unused ports available for the ports GlassFish Server uses." Added the following ports to the "Default Port Assignments for GlassFish Server 3.1-3.1.1" table: 22 SSH port 9009 Java debugger 6666 OSGi shell telnet port 7676 JMS provider 9090 GMS TCP start port 9200 GMS TCP end port Auto-generated GMS listener port between GMS TCP start and end ports Auto-generated GMS multicast port between 2048 and 32000 I couldn't find info on the two MQ ports at the link provided. If it's important to list these, please provide more info.
        Hide
        Nigel Deakin added a comment -

        I've reviewed Rebecca's comment above from a JMS perspective. Agree that the "JMS Provider" uses port 7676 by default. Strictly speaking this is used by the MQ broker's "port mapper". though in GlassFish this is usually referred to simply as the JMS port.

        Is it worth adding that the default port numbers in that list (not just the JMS port but all the others as well) apply only to a standalone instance, such as a DAS? If the instance is clustered then different port numbers will be used.

        The other ports used by JMS that I mentioned were the "admin" and "jms" ports (where "jms" is not the same as the port mapper). "admin" and "jms" are services running in the MQ broker. These are allocated dynamically from the port range that the OS uses for dynamic ports (rather like GMS does). I don't know whether we need to mention these or not. It depends why we're listing ports here:

        • If we're telling the user what port they need to keep free then, since these ports are dynamically-allocated the user doesn't need to worry about keeping them free.
        • If we're documenting what port are used by a GlassFish instance (for users who run netstat to discover what ports are being used by GlassFish, and then ask us what they are all for) then they need to be mentioned.
        • If we're documenting the ports to allow the user to know what ports they need to open in a firewall, then we need not only to tell the user about the "tcp" and "admin" ports, but also how to hardwire them to a fixed port number. The MQ admin guide explains how to do this here
        Show
        Nigel Deakin added a comment - I've reviewed Rebecca's comment above from a JMS perspective. Agree that the "JMS Provider" uses port 7676 by default. Strictly speaking this is used by the MQ broker's "port mapper". though in GlassFish this is usually referred to simply as the JMS port. Is it worth adding that the default port numbers in that list (not just the JMS port but all the others as well) apply only to a standalone instance, such as a DAS? If the instance is clustered then different port numbers will be used. The other ports used by JMS that I mentioned were the "admin" and "jms" ports (where "jms" is not the same as the port mapper). "admin" and "jms" are services running in the MQ broker. These are allocated dynamically from the port range that the OS uses for dynamic ports (rather like GMS does). I don't know whether we need to mention these or not. It depends why we're listing ports here: If we're telling the user what port they need to keep free then, since these ports are dynamically-allocated the user doesn't need to worry about keeping them free. If we're documenting what port are used by a GlassFish instance (for users who run netstat to discover what ports are being used by GlassFish, and then ask us what they are all for) then they need to be mentioned. If we're documenting the ports to allow the user to know what ports they need to open in a firewall, then we need not only to tell the user about the "tcp" and "admin" ports, but also how to hardwire them to a fixed port number. The MQ admin guide explains how to do this here
        Hide
        Rebecca Parks added a comment -

        Changed the first sentence to "You must have seventeen unused ports available..." Added these two ports to the table:

        Auto-generated from the operating system's dynamic port range Message Queue TCP port

        Auto-generated from the operating system's dynamic port range Message Queue Admin port

        Show
        Rebecca Parks added a comment - Changed the first sentence to "You must have seventeen unused ports available..." Added these two ports to the table: Auto-generated from the operating system's dynamic port range Message Queue TCP port Auto-generated from the operating system's dynamic port range Message Queue Admin port

          People

          • Assignee:
            Mike Fitch
            Reporter:
            Nigel Deakin
          • Votes:
            0 Vote for this issue
            Watchers:
            3 Start watching this issue

            Dates

            • Created:
              Updated:
              Resolved: