Record Class BasicConstraints

java.lang.Object
java.lang.Record
zeroecho.pkix.BasicConstraints
Record Components:
certificateAuthority - whether the subject is a CA
pathLenConstraint - maximum number of subordinate CAs, present only when certificateAuthority is true
public record BasicConstraints(boolean certificateAuthority, OptionalInt pathLenConstraint) extends Record
The X.509 BasicConstraints extension value (RFC 5280, 4.2.1.9).

  • Constructor Details

    • BasicConstraints

      public BasicConstraints(boolean certificateAuthority, OptionalInt pathLenConstraint)
      Canonicalizing constructor.

  • Method Details

    • endEntity

      public static BasicConstraints endEntity()
      An end-entity (non-CA) basic constraints value.
      Returns:
      end-entity basic constraints

    • ca

      public static BasicConstraints ca()
      A CA basic constraints value with no path-length limit.
      Returns:
      unconstrained CA basic constraints

    • ca

      public static BasicConstraints ca(int pathLen)
      A CA basic constraints value with the given path-length limit.
      Parameters:
      pathLen - maximum number of subordinate CAs (non-negative)
      Returns:
      path-limited CA basic constraints

    • 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. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with the compare method from their corresponding wrapper classes.
      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.

    • certificateAuthority

      public boolean certificateAuthority()
      Returns the value of the certificateAuthority record component.
      Returns:
      the value of the certificateAuthority record component

    • pathLenConstraint

      public OptionalInt pathLenConstraint()
      Returns the value of the pathLenConstraint record component.
      Returns:
      the value of the pathLenConstraint record component