Package org.springframework.security.openid

Interface OpenIDConsumer

  • All Known Implementing Classes:
    OpenID4JavaConsumer
    public interface OpenIDConsumer
    An interface for OpenID library implementations

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.lang.String beginConsumption​(javax.servlet.http.HttpServletRequest req, java.lang.String claimedIdentity, java.lang.String returnToUrl, java.lang.String realm)
      Given the request, the claimedIdentity, the return to url, and a realm, lookup the openId authentication page the user should be redirected to.
      OpenIDAuthenticationToken endConsumption​(javax.servlet.http.HttpServletRequest req)  

    • Method Detail

      • beginConsumption

        java.lang.String beginConsumption​(javax.servlet.http.HttpServletRequest req,
                                  java.lang.String claimedIdentity,
                                  java.lang.String returnToUrl,
                                  java.lang.String realm)
                           throws OpenIDConsumerException
        Given the request, the claimedIdentity, the return to url, and a realm, lookup the openId authentication page the user should be redirected to.
        Parameters:
        req - HttpServletRequest
        claimedIdentity - String URI the user presented during authentication
        returnToUrl - String URI of the URL we want the user sent back to by the OP
        realm - URI pattern matching the realm we want the user to see
        Returns:
        String URI to redirect user to for authentication
        Throws:
        OpenIDConsumerException - if anything bad happens