Package com.avoka.tm.security

Class Saml2ParserResult

  • public class Saml2ParserResult
extends java.lang.Object
    The Saml2ParserResult is returned from the Saml2Paser.parse(request) method.
    Since:
    5.1.4
    See Also:
    Saml2Parser

    • Field Summary

      Fields 
      Modifier and Type Field Description
      java.lang.String debugLog
      contains a detailed log, including the infoLog entries of the parse operation.
      java.lang.Throwable error
      the Throwable when an error occurs during the parsing.
      java.lang.String infoLog
      contains a summary log of the parse operation.
      boolean isValid
      The isValid is true when the parsing has completed successfully without error.
      java.lang.String responseB64Decoded
      The SAMLResponse XML (String) after it has been Base64 decoded.
      java.lang.String responseRaw
      The raw SAMLResponse (String) taken from the request parameter.
      SsoAuthToken ssoAuthToken
      The ssoAuthToken (SsoAuthToken) holds the parsed user details from the SAML Response.
      java.util.List<java.lang.String> validationErrors
      contains a List of the validation error messages.

    • Constructor Summary

      Constructors 
      Constructor Description
      Saml2ParserResult​(SsoAuthToken ssoAuthToken, java.lang.String responseRaw, java.lang.String responseB64Decoded, java.lang.Throwable error, java.util.List<java.lang.String> validationErrors, java.lang.String debugLog, java.lang.String infoLog)
      Creates a immutable Saml2ParserResult.

    • Method Summary

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Field Detail

      • isValid

        public final boolean isValid
        The isValid is true when the parsing has completed successfully without error.

      • ssoAuthToken

        public final SsoAuthToken ssoAuthToken
        The ssoAuthToken (SsoAuthToken) holds the parsed user details from the SAML Response. If isValid == false then it will be null.

        If is valid the Security Manager Get SSO Auth Token should return this object

      • responseRaw

        public final java.lang.String responseRaw
        The raw SAMLResponse (String) taken from the request parameter.

        Save this to the SecurityLogger when troubleshooting. This can be useful for debug the Saml2Parser in a separate unit test

      • responseB64Decoded

        public final java.lang.String responseB64Decoded
        The SAMLResponse XML (String) after it has been Base64 decoded. Save this to the SecurityLogger it is useful for troubleshooting the structure of the SAML token.

      • error

        public final java.lang.Throwable error
        the Throwable when an error occurs during the parsing.

      • debugLog

        public final java.lang.String debugLog
        contains a detailed log, including the infoLog entries of the parse operation.

      • infoLog

        public final java.lang.String infoLog
        contains a summary log of the parse operation.

      • validationErrors

        public final java.util.List<java.lang.String> validationErrors
        contains a List of the validation error messages.

    • Constructor Detail

      • Saml2ParserResult

        public Saml2ParserResult​(SsoAuthToken ssoAuthToken,
                         java.lang.String responseRaw,
                         java.lang.String responseB64Decoded,
                         java.lang.Throwable error,
                         java.util.List<java.lang.String> validationErrors,
                         java.lang.String debugLog,
                         java.lang.String infoLog)
        Creates a immutable Saml2ParserResult.
        Parameters:
        ssoAuthToken - the SsoAuthToken that holds the parsed user details from the SAML Response.
        responseRaw - the String raw SAMLResponse taken from the request parameter.
        responseB64Decoded - the String SAMLResonse XML after it is has been Base64 decoded.
        error - the Throwable associated with a failure to parse the SAML Response
        validationErrors - a String List or validationError entries. Each String entry contains a type, a path to the node in the SAML Response relates to, an error context message, if an exception was caught the e.message() and the stack trace.
        debugLog - the String detailed log including the infoLog entries for the parse operation
        infoLog - the String summary log of the parse operation.