Uploaded image for project: 'mod_cluster'
  1. mod_cluster
  2. MODCLUSTER-643

Misleading JavaDoc for SPI Container Engine

    XMLWordPrintable

Details

    • Bug
    • Status: Closed (View Workflow)
    • Trivial
    • Resolution: Done
    • 1.3.8.Final, 1.4.0.Alpha1
    • 2.0.0.Final
    • Core / SPIs
    • None

    Description

      https://github.com/modcluster/mod_cluster/blob/7e4dadf03df78f05bbf06af6985ccf70d439f06a/container/spi/src/main/java/org/jboss/modcluster/container/Engine.java#L60

          /**
           * The connector to which this engine uses to communicate with its proxies.
           *
           * @return the connector used by mod_cluster
           */
          Connector getProxyConnector();
      
          /**
           * The connector to which this engine uses to communicate with its proxies.
           *
           * @return the connector used by mod_cluster
           */
          Iterable<Connector> getConnectors();
      

      From what I see and understand from the code, the javadoc for getConnectors() does not reflect its actual purpose - it seems like a copypaste from getProxyConnector(). I am not competent enough to write a proper JavaDoc myself through - please support me with it.

      Attachments

        Activity

          People

            rhn-engineering-rhusar Radoslav Husar
            phoe_jira Michal Herda (Inactive)
            Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved: