Module dev.eidentification.bankid
Package dev.eidentification.bankid.client.request

Record Class SignRequest

java.lang.Object
java.lang.Record
dev.eidentification.bankid.client.request.SignRequest
Record Components:
endUserIp - The user IP address as seen by RP. String, IPv4 and IPv6 is allowed.
requirement - Requirements on how the auth or sign order must be performed.
userVisibleData - The text to be displayed and signed. The text can be formatted using CR, LF and CRLF for new lines. 1--40 000 characters after base 64 encoding.
userNonVisibleData - Data not displayed for the user. 1-200 000 characters after base 64-encoding.
userVisibleDataFormat - This parameter indicates that userVisibleData holds formatting characters which, will potentially make the text displayed to the user nicer to look at.
All Implemented Interfaces:
Request
public record SignRequest(String endUserIp, @Nullable Requirement requirement, UserVisibleData userVisibleData, @Nullable UserNonVisibleData userNonVisibleData, @Nullable VisibleDataFormat userVisibleDataFormat) extends Record implements Request
Request to initiates a signing order.

  • Constructor Details

  • Method Details

    • builder

      public static SignRequest.SignRequestBuilder builder()

    • getUri

      public String getUri()
      Description copied from interface: Request
      Returns the URI associated with the request.
      Specified by:
      getUri in interface Request
      Returns:
      The URI of the request.

    • 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.

    • endUserIp

      public String endUserIp()
      Returns the value of the endUserIp record component.
      Returns:
      the value of the endUserIp record component

    • requirement

      public @Nullable Requirement requirement()
      Returns the value of the requirement record component.
      Returns:
      the value of the requirement record component

    • userVisibleData

      public UserVisibleData userVisibleData()
      Returns the value of the userVisibleData record component.
      Returns:
      the value of the userVisibleData record component

    • userNonVisibleData

      public @Nullable UserNonVisibleData userNonVisibleData()
      Returns the value of the userNonVisibleData record component.
      Returns:
      the value of the userNonVisibleData record component

    • userVisibleDataFormat

      public @Nullable VisibleDataFormat userVisibleDataFormat()
      Returns the value of the userVisibleDataFormat record component.
      Returns:
      the value of the userVisibleDataFormat record component