Beehive
  1. Beehive
  2. BEEHIVE-711

beehive-netui-config.xml elements added need to be documented

    Details

    • Type: Bug Bug
    • Status: Closed
    • Priority: Major Major
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: v1m1
    • Component/s: Documentation
    • Labels:
      None

      Description

      The following elements have been added as possible elements to include in beehive-netui-config.xml

      Added in BEEHIVE-529:
      <default-shared-flow-refs>
      <shared-flow-ref>
      <name></name>
      <type></type>
      </shared-flow-ref>
      </default-shared-flow-refs>

      Example:
      <default-shared-flow-refs>
      <shared-flow-ref>
      <name>defaultSharedFlow1</name>
      <type>miniTests.jspSeesSharedFlow.sharedFlow1.SharedFlow1</type>
      </shared-flow-ref>
      <shared-flow-ref>
      <name>defaultSharedFlow2</name>
      <type>miniTests.jspSeesSharedFlow.sharedFlow2.SharedFlow2</type>
      </shared-flow-ref>
      </default-shared-flow-refs>

      Reason for addition: there was no way for the JSP to access actions in a shared flow since there was no page flow to declare the shared flow reference. The <default-shared-flow-refs> declares default shared flow references that are used across the webapp.

      1. j711.txt
        36 kB
        Krista Baker

        Activity

        Hide
        Krista Baker added a comment -

        The following elements have been added as elements to include in beehive-netui-config.xml

        The url-config element and html-amp-entity element was added in: BEEHIVE-500
        The url-encode-urls element was added in: BEEHVIE-490
        <url-config>
        <url-encode-urls></url-encode-urls>
        <html-amp-entity></html-amp-entity>
        </url-config>

        Example:
        <url-config>
        <url-encode-urls>false</url-encode-urls>
        <html-amp-entity>false</html-amp-entity>
        </url-config>

        Both items default to true

        Reason for addition:
        html-amp-entity: the default urls parameters of '&' are now encoded to '&' according to the html 401 specifications by w3c. This item can be set to false and these items will no longer be encoded to '&' but will stay as '&'.

        url-encode-urls: If a user wants to write their URL for tags with href attributes as already encoded strings, this option allows them to turn off the auto-encoding that beehive does by default.

        Description:
        The config elements to turn off url encoding of the href values
        and not use the HTML amp entity are <url-encode-urls> and
        <html-amp-entity>. They are of type boolean and must be within
        the <url-config> element.

        The <url-config> element should go after the <jsp-tag-config> section.

        Show
        Krista Baker added a comment - The following elements have been added as elements to include in beehive-netui-config.xml The url-config element and html-amp-entity element was added in: BEEHIVE-500 The url-encode-urls element was added in: BEEHVIE-490 <url-config> <url-encode-urls></url-encode-urls> <html-amp-entity></html-amp-entity> </url-config> Example: <url-config> <url-encode-urls>false</url-encode-urls> <html-amp-entity>false</html-amp-entity> </url-config> Both items default to true Reason for addition: html-amp-entity: the default urls parameters of '&' are now encoded to '&' according to the html 401 specifications by w3c. This item can be set to false and these items will no longer be encoded to '&' but will stay as '&'. url-encode-urls: If a user wants to write their URL for tags with href attributes as already encoded strings, this option allows them to turn off the auto-encoding that beehive does by default. Description: The config elements to turn off url encoding of the href values and not use the HTML amp entity are <url-encode-urls> and <html-amp-entity>. They are of type boolean and must be within the <url-config> element. The <url-config> element should go after the <jsp-tag-config> section.
        Hide
        Krista Baker added a comment -

        Here is a patch for the beehive-netui-config.xml file. This patch fixes the following issues (and a couple other minor ones.)
        1) removed all references to legacy-tag-support
        This element was removed from beehive-netui-config.xml as of svn 165345
        2) moved default-language to be a child of expression-languages and not expression-language

        3) login-handler-class is no longer valid:
        login-handler with required child of handler-class
        and optional child of custom-property [0-*]
        4) added handler-class section
        type=xsd:string
        parents=action-forward-handler, exceptions-handler, forward-redirect-handler, login-handler, reloadable-class-handler
        5) forward-redirect-handler-class is no longer valid:
        forward-redirect-handler with required child of handler-class
        and optional child of custom-property [0-*]
        6) reloadable-class-handler-class, same as above, now reloadable-class-handler
        7) exceptions-handler-class, same as above, now exceptions-handler
        8) action-forward-handler has been added, same properties as above
        9) enable-renesting is now enable-self-nesting
        10) multipart-handler - removed the "To disable file To disable file upload, set the value to "none". [todo: other values include memory, ?, ...]
        The values listed in the syntax are consistent with the enumeration on the element, memory, disk, and disabled.
        In pageflow-config, changed set multipart-handler to "disabled" from "none"
        also removed the "There will be more settings here soon." although prevent-cache could probably use a description
        11) module-config-locators
        needed child module-config-locator added into General structure item
        12) prevent-cache has been added,
        parents: pageflow-config
        child: none
        type: enumerate [default | always | inDevMode ]
        13) handlers are now [0-*] not [0-1]
        14) spelling of link from iterator-factory to iterator-factorys ies
        15) factory-class - added parents: expression-language & iterator-factory
        16) request-interceptors
        Children:global [0-1]
        -> request-interceptor [0-*]
        ->interceptor-class [1]
        -> custom-property [0-*]
        B) add global as child of request-interceptors
        add updated syntax
        16A) add request-interceptors as global parents,
        add request-interceptor as child of global
        add request-interceptor to global example
        d) add request-interceptor as parent to custom-property
        C) add element request-interceptor
        Child: interceptor-class & custom-property
        parent: global
        e) add request-interceptor as parent to interceptor-class
        17) several children have been added into netui-config:
        pageflow-config
        Added: default-shared-flow-refs
        type-converters
        jsp-tag-config
        Added: url-config
        iterator-factories
        request-interceptors
        Added: prefix-handlers
        (and corresponding children)

        Show
        Krista Baker added a comment - Here is a patch for the beehive-netui-config.xml file. This patch fixes the following issues (and a couple other minor ones.) 1) removed all references to legacy-tag-support This element was removed from beehive-netui-config.xml as of svn 165345 2) moved default-language to be a child of expression-languages and not expression-language 3) login-handler-class is no longer valid: login-handler with required child of handler-class and optional child of custom-property [0-*] 4) added handler-class section type=xsd:string parents=action-forward-handler, exceptions-handler, forward-redirect-handler, login-handler, reloadable-class-handler 5) forward-redirect-handler-class is no longer valid: forward-redirect-handler with required child of handler-class and optional child of custom-property [0-*] 6) reloadable-class-handler-class, same as above, now reloadable-class-handler 7) exceptions-handler-class, same as above, now exceptions-handler 8) action-forward-handler has been added, same properties as above 9) enable-renesting is now enable-self-nesting 10) multipart-handler - removed the "To disable file To disable file upload, set the value to "none". [todo: other values include memory, ?, ...] The values listed in the syntax are consistent with the enumeration on the element, memory, disk, and disabled. In pageflow-config, changed set multipart-handler to "disabled" from "none" also removed the "There will be more settings here soon." although prevent-cache could probably use a description 11) module-config-locators needed child module-config-locator added into General structure item 12) prevent-cache has been added, parents: pageflow-config child: none type: enumerate [default | always | inDevMode ] 13) handlers are now [0-*] not [0-1] 14) spelling of link from iterator-factory to iterator-factorys ies 15) factory-class - added parents: expression-language & iterator-factory 16) request-interceptors Children:global [0-1] -> request-interceptor [0-*] ->interceptor-class [1] -> custom-property [0-*] B) add global as child of request-interceptors add updated syntax 16A) add request-interceptors as global parents, add request-interceptor as child of global add request-interceptor to global example d) add request-interceptor as parent to custom-property C) add element request-interceptor Child: interceptor-class & custom-property parent: global e) add request-interceptor as parent to interceptor-class 17) several children have been added into netui-config: pageflow-config Added: default-shared-flow-refs type-converters jsp-tag-config Added: url-config iterator-factories request-interceptors Added: prefix-handlers (and corresponding children)
        Hide
        Krista Baker added a comment -

        Steve, could you please review and submit this patch. Thanks, Krista

        Show
        Krista Baker added a comment - Steve, could you please review and submit this patch. Thanks, Krista
        Hide
        Rich Feit added a comment -

        I can take this one...

        Show
        Rich Feit added a comment - I can take this one...
        Hide
        Rich Feit added a comment -

        Thanks Krista – I applied this patch with revision 170304 and added some additional edits. There were some merge conflicts with later edits to the file, but I think I got everything resolved.

        Show
        Rich Feit added a comment - Thanks Krista – I applied this patch with revision 170304 and added some additional edits. There were some merge conflicts with later edits to the file, but I think I got everything resolved.
        Hide
        Krista Baker added a comment -

        Steve, I verified that the patch was submitted, would it be possible for you to give the file a once-over to be sure it is correct and close this issue?
        Thanks, Krista

        Show
        Krista Baker added a comment - Steve, I verified that the patch was submitted, would it be possible for you to give the file a once-over to be sure it is correct and close this issue? Thanks, Krista
        Hide
        Alejandro Ramirez added a comment -

        Please verify.

        Show
        Alejandro Ramirez added a comment - Please verify.
        Hide
        Nathan Jantz added a comment -

        I reviewed this in the distribution as of rev 178693 and I saw no obvious issues with the changes applied from the patch. I validated it for well-formedness etc as well and saw no validation errors. Closing issue.

        Show
        Nathan Jantz added a comment - I reviewed this in the distribution as of rev 178693 and I saw no obvious issues with the changes applied from the patch. I validated it for well-formedness etc as well and saw no validation errors. Closing issue.

          People

          • Assignee:
            Nathan Jantz
            Reporter:
            Krista Baker
          • Votes:
            0 Vote for this issue
            Watchers:
            0 Start watching this issue

            Dates

            • Created:
              Updated:
              Resolved:

              Development