Uploaded image for project: 'OpenAM'
  1. OpenAM
  2. OPENAM-6219

Documentation of Base URL Provider Service


    • Type: Improvement
    • Status: Resolved
    • Priority: Major
    • Resolution: Fixed
    • Affects Version/s: 12.0.1, 13.0.0
    • Fix Version/s: 13.0.0
    • Component/s: documentation
    • Labels:
    • Rank:
    • Sprint:
      Sprint 90 - Team Shakespeare, Sprint 91 - Team Shakespeare, Sprint 100 - Team Shakespeare


      In a number of places, AM tries to work out what the external representation of the AM host is. Previously it tried to do this based solely on the incoming request, but sometimes that is not sufficient.

      A new provider service is created that allows the realm to have a configured option for how to obtain the base URL (including protocol) for places that need to return a URL to the client. The provider will have:

      • A radio button option for selecting URL source from:
        • Configured value
        • RFC7239 Forwarded header
        • X-Forwarded-Host + X-Forwarded-Proto headers
        • Host and protocol from the incoming AM request
        • An extension point that returns a base URL from a given HttpServletRequest.
      • A tick box to include/exclude the container's context path
      • A text field for specifying the configured fixed value (if required).
      • A text field for specifying the extension class (if required).

      This service is used to provide the URL base that is used in the well-known endpoints (OIDC and UMA). It needs to be documented so that users understand how to use it.


          Issue Links



              • Assignee:
                austingene Gene Hirayama
                jamesphillpotts James Phillpotts
              • Votes:
                0 Vote for this issue
                5 Start watching this issue


                • Created: