Interface ConsumerSiteAttributeMapper

  • All Known Implementing Classes:
    DefaultSiteAttributeMapper

    public interface ConsumerSiteAttributeMapper
    This interface needs to be implemented by an trusted assertion consumer site (a partner) to return a list of Attribute objects to be returned as AttributeStatements elements, as part of the Authentication Assertion returned to the partner during the SSO scenario of Browser Artifact and POST profile.

    Different partner would need to have a different implementation of the interface. The mappings between the partner source ID and the implementation class are configured at the Partner URLs field in SAML service.

    • Method Detail

      • getAttributes

        List getAttributes​(Object token,
                           jakarta.servlet.http.HttpServletRequest request,
                           jakarta.servlet.http.HttpServletResponse response,
                           String targetURL)
                    throws SAMLException
        Returns List of Attribute objects
        Parameters:
        token - User's session.
        request - The HttpServletRerquest object of the request which may contains query attributes to be included in the Assertion. This could be null if unavailable.
        response - The HttpServletResponse object. This could be null if unavailable.
        targetURL - value for TARGET query parameter when the user accessing the SAML aware servlet or post profile servlet. This could be null if unavailabl
        Returns:
        List if Attribute objects. Attribute is defined in the SAML SDK as part of com.sun.identity.saml.assertion package.
        Throws:
        SAMLException - if attributes cannot be obtained.