com.ibm.wsspi.security.web.saml

Interface AuthnRequestProvider

  • All Superinterfaces:
    IdentityProviderMapping


    public interface AuthnRequestProvider
    extends IdentityProviderMapping
    Implementing this interface enables WebSphere Security to redirect request to an URL for re-authentication or displaying error message upon authentication failure. Implementation of this interface must provide implementations for:
    • getIdentityProviderOrErrorURL(HttpServletRequest, String)
    • Field Summary

      Fields 
      Modifier and Type Field and Description
      static java.lang.String AUTHN_REQUEST
      Base64 encoded message that will be posted to SAML IdP.
      static java.lang.String RELAY_STATE
      Unique identifier for preserving and conveying state information in SP, and is posted to SAML IdP.
      static java.lang.String REQUEST_ID
      The ID for this message.
      static java.lang.String SSO_URL
      The SAML authentication request protocol endpoint at the identity provider to which the message will be posted.
    • Method Summary

      Methods 
      Modifier and Type Method and Description
      java.util.HashMap<java.lang.String,java.lang.String> getAuthnRequest(javax.servlet.http.HttpServletRequest req, java.lang.String errorMsg, java.lang.String acsUrl, java.util.ArrayList<java.lang.String> ssoUrls)
      Maps a HttpServletRequest to a valid URL.
    • Field Detail

      • AUTHN_REQUEST

        static final java.lang.String AUTHN_REQUEST
        Base64 encoded message that will be posted to SAML IdP.
        See Also:
        Constant Field Values
      • REQUEST_ID

        static final java.lang.String REQUEST_ID
        The ID for this message.
        See Also:
        Constant Field Values
      • RELAY_STATE

        static final java.lang.String RELAY_STATE
        Unique identifier for preserving and conveying state information in SP, and is posted to SAML IdP.
        See Also:
        Constant Field Values
      • SSO_URL

        static final java.lang.String SSO_URL
        The SAML authentication request protocol endpoint at the identity provider to which the message will be posted.
        See Also:
        Constant Field Values
    • Method Detail

      • getAuthnRequest

        java.util.HashMap<java.lang.String,java.lang.String> getAuthnRequest(javax.servlet.http.HttpServletRequest req,
                                                                           java.lang.String errorMsg,
                                                                           java.lang.String acsUrl,
                                                                           java.util.ArrayList<java.lang.String> ssoUrls)
                                                                             throws NotImplementedException
        Maps a HttpServletRequest to a valid URL. This is used to map the HttpServletRequest to a valid URL, so that WebSphere can redirect user to the URL for re-login or receiving error message
        Parameters:
        req - the HttpServletRequest
        errorMsg - the String
        acsUrl - the String of AssertionConsumerService URL
        ssoUrl - the ArrayList of Single-SignOn service URLs
        Returns:
        the URL String of the user which should be redirected to
        Throws:
        NotImplementedException - if this implementation is not supported.
IBM WebSphere Application ServerTM
Release 9.0