Package io.asgardeo.java.oidc.sdk

Interface OIDCManager

  • All Known Implementing Classes:
    DefaultOIDCManager
    public interface OIDCManager
    OIDC manager service interface.

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      SessionContext handleOIDCCallback​(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, RequestContext requestContext)
      Processes the OIDC callback response and extract the authorization code, builds a token request, sends the token request and parse the token response where the authenticated user info and tokens would be added to the SessionContext object and returned.
      RequestContext logout​(SessionContext sessionContext, javax.servlet.http.HttpServletResponse response)
      Builds a logout request and redirects.
      RequestContext sendForLogin​(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
      Builds an authentication request and redirects.

    • Method Detail

      • sendForLogin

        RequestContext sendForLogin​(javax.servlet.http.HttpServletRequest request,
                            javax.servlet.http.HttpServletResponse response)
                     throws SSOAgentException
        Builds an authentication request and redirects.
        Parameters:
        request - Incoming HttpServletRequest.
        response - Outgoing HttpServletResponse
        Returns:
        RequestContext Object containing details regarding the state ID, nonce value for the AuthenticationRequest.
        Throws:
        SSOAgentException

      • handleOIDCCallback

        SessionContext handleOIDCCallback​(javax.servlet.http.HttpServletRequest request,
                                  javax.servlet.http.HttpServletResponse response,
                                  RequestContext requestContext)
                           throws SSOAgentException
        Processes the OIDC callback response and extract the authorization code, builds a token request, sends the token request and parse the token response where the authenticated user info and tokens would be added to the SessionContext object and returned.
        Parameters:
        request - Incoming HttpServletRequest.
        response - Outgoing HttpServletResponse.
        requestContext - RequestContext object containing the authentication request related information.
        Returns:
        SessionContext Object containing the authenticated User, AccessToken, RefreshToken and IDToken.
        Throws:
        SSOAgentException - Upon failed authentication.