Package com.digicert.validation.challenges

Record Class ChallengeValidationResponse

java.lang.Object
java.lang.Record
com.digicert.validation.challenges.ChallengeValidationResponse
Record Components:
challengeValue - an Optional containing the validated challenge value, or an empty Optional if validation fails
errors - a Set of DcvError indicating the errors encountered during validation
public record ChallengeValidationResponse(Optional<String> challengeValue, Set<DcvError> errors) extends Record
A record to hold the results of a response validator.

The `challengeValue` field is an `Optional` that holds the validated random value or request token if the validation is successful and is empty if the validation fails. The `errors` field is a `Set` of DcvError that allows for providing a comprehensive list of issues that occurred during validation.

  • Field Details

  • Constructor Details

    • ChallengeValidationResponse

      public ChallengeValidationResponse(Optional<String> challengeValue, Set<DcvError> errors)
      Creates an instance of a ChallengeValidationResponse record class.
      Parameters:
      challengeValue - the value for the challengeValue record component
      errors - the value for the errors record component

  • Method Details

    • merge

      public ChallengeValidationResponse merge(ChallengeValidationResponse other)
      A convenience method to merge two challenge validation responses.

      If either response is successful, the challenge value from the first successful response is returned. If both responses are not valid, the errors from both responses are combined.

      Parameters:
      other - the second response to merge with this response
      Returns:
      a new ChallengeValidationResponse containing the merged results

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • challengeValue

      public Optional<String> challengeValue()
      Returns the value of the challengeValue record component.
      Returns:
      the value of the challengeValue record component

    • errors

      public Set<DcvError> errors()
      Returns the value of the errors record component.
      Returns:
      the value of the errors record component