javaserverfaces-spec-public
  1. javaserverfaces-spec-public
  2. JAVASERVERFACES_SPEC_PUBLIC-1251

Documentation for javax.faces.application.ResourceHandler.RESOURCE_CONTRACT_XML could use clarification

    Details

      Description

      The spec PDF says.

      2.7 Resource Library Contracts

      [...]

      When packaged in a JAR file, there is one additional packaging
      requirement: each resource library contract in the JAR must have a
      marker file. The name of the file is given by the value of the symbolic
      constant javax.faces.application.ResourceHandler.RESOURCE_CONTRACT_XML.
      This may be a zero length file, though future versions of the
      specification may use the file to declare the usage contract.

      The doc for the constant says:

      The name of the marker file that the implementation must scan for, within sub-directories META-INF/contracts, to identify the set of available resource library contracts.

      I propose the following improvement for the doc for the constant.

      This file must be located in META-INF/contracts/<contractName>/ in a jar file that contains a resource library contract, where <contractName> is the name of the contract. If the jar file contains multiple contracts, the marker file must be present in each one. See "constant field values" for the name of the file that must be placed at that location.

        Activity

        Ed Burns created issue -
        Ed Burns made changes -
        Field Original Value New Value
        Assignee Ed Burns [ edburns ]
        Ed Burns made changes -
        Status Open [ 1 ] Resolved [ 5 ]
        Resolution Fixed [ 1 ]
        Manfred Riem made changes -
        Status Resolved [ 5 ] Closed [ 6 ]

          People

          • Assignee:
            Ed Burns
            Reporter:
            Ed Burns
          • Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

            Dates

            • Created:
              Updated:
              Resolved:

              Time Tracking

              Estimated:
              Original Estimate - 1 hour
              1h
              Remaining:
              Remaining Estimate - 1 hour
              1h
              Logged:
              Time Spent - Not Specified
              Not Specified