Package net.shibboleth.idp.plugin.oidc.op.encoding.impl

Class ResponseUtil

  • public final class ResponseUtil
extends Object
    Response logging helper class.

    • Constructor Detail

      • ResponseUtil

        private ResponseUtil()
        Private constructor.

    • Method Detail

      • toString

        protected static String toString​(@Nullable
                                 com.nimbusds.oauth2.sdk.http.HTTPResponse httpResponse)
        Helper method to print response to string for logging.
        Parameters:
        httpResponse - response to be printed
        Returns:
        response as formatted string.

      • toString

        @Nullable
protected static String toString​(@Nullable
                                 javax.servlet.http.HttpServletResponse httpServletResponse,
                                 @Nullable
                                 String content)
        Helper method to print response to string for logging.
        Parameters:
        httpServletResponse - response to be printed
        content - message content
        Returns:
        response as formatted string.

      • getProtocolMessage

        @Nullable
public static String getProtocolMessage​(@Nullable
                                        com.nimbusds.oauth2.sdk.Response response)
        Helper method for getting protocol message for a Nimbus response object. This method can currently recognize success and error responses for OIDC authentication, token, userinfo, introspetion and revocation.
        Parameters:
        response - The response message
        Returns:
        The response message specific log message

      • getProtocolMessageForAuthenticationResponse

        @Nullable
public static String getProtocolMessageForAuthenticationResponse​(@Nonnull
                                                                 com.nimbusds.openid.connect.sdk.AuthenticationResponse response)
        Helper method for getting protocol message for OIDC authentication response.
        Parameters:
        response - The response message
        Returns:
        The response message specific log message

      • getProtocolMessageForRegistrationResponse

        @Nullable
public static String getProtocolMessageForRegistrationResponse​(@Nonnull
                                                               com.nimbusds.openid.connect.sdk.rp.OIDCClientInformationResponse response)
        Helper method for getting protocol message for OIDC registration response.
        Parameters:
        response - The response message
        Returns:
        The response message specific log message

      • getProtocolMessageForClientInformation

        @Nullable
public static String getProtocolMessageForClientInformation​(@Nullable
                                                            com.nimbusds.oauth2.sdk.client.ClientInformation clientInformation)
        Helper method for getting protocol message for client information object.
        Parameters:
        clientInformation - The client information
        Returns:
        The log message

      • getProtocolMessageForTokenResponse

        @Nullable
public static String getProtocolMessageForTokenResponse​(@Nonnull
                                                        com.nimbusds.oauth2.sdk.TokenResponse response)
        Helper method for getting protocol message for token response.
        Parameters:
        response - The response message
        Returns:
        The response message specific log message

      • getProtocolMessageForErrorObject

        @Nullable
public static String getProtocolMessageForErrorObject​(@Nullable
                                                      com.nimbusds.oauth2.sdk.ErrorObject errorObject)
        Helper method for getting protocol message for error object.
        Parameters:
        errorObject - The error object
        Returns:
        The log message

      • getProtocolMessageForTokens

        @Nullable
public static String getProtocolMessageForTokens​(@Nullable
                                                 com.nimbusds.oauth2.sdk.token.Tokens tokens)
        Helper method for getting protocol message for tokens object.
        Parameters:
        tokens - The tokens object
        Returns:
        The log message

      • getProtocolMessageForUserInfoResponse

        @Nullable
public static String getProtocolMessageForUserInfoResponse​(@Nonnull
                                                           com.nimbusds.openid.connect.sdk.UserInfoResponse response)
        Helper method for getting protocol message for OIDC user info response.
        Parameters:
        response - The response message
        Returns:
        The response message specific log message

      • getProtocolMessageForIntrospectionResponse

        @Nullable
public static String getProtocolMessageForIntrospectionResponse​(@Nonnull
                                                                com.nimbusds.oauth2.sdk.TokenIntrospectionResponse response)
        Helper method for getting protocol message for introspection response.
        Parameters:
        response - The response message
        Returns:
        The response message specific log message

      • getProtocolMessageForRevocationResponse

        @Nullable
public static String getProtocolMessageForRevocationResponse​(@Nonnull
                                                             com.nimbusds.oauth2.sdk.Response response)
        Helper method for getting protocol message for revocation response.
        Parameters:
        response - The response message
        Returns:
        The response message specific log message

      • getProtocolMessageForJSONSuccessResponse

        @Nullable
public static String getProtocolMessageForJSONSuccessResponse​(@Nonnull
                                                              com.nimbusds.oauth2.sdk.Response response)
        Helper method for getting protocol message for JSON success response.
        Parameters:
        response - The response message
        Returns:
        The response message specific log message