Package org.forgerock.opendj.ldap.messages

Record Class StartTlsExtendedRequest

java.lang.Object
java.lang.Record
org.forgerock.opendj.ldap.messages.StartTlsExtendedRequest
Record Components:
sslOptions - the SslOptions that should be used when installing the TLS layer. This is only used client-side when interacting with a remove server using a Connection. In a server context, it always returns null.
controls - the List containing the controls.
All Implemented Interfaces:
ExtendedRequest<ExtendedResult>, ProtocolOp, Request
public record StartTlsExtendedRequest(SslOptions sslOptions, List<Control> controls) extends Record implements ExtendedRequest<ExtendedResult>
The start TLS extended request as defined in RFC 4511. The Start Transport Layer Security (StartTLS) operation's purpose is to initiate installation of a TLS layer.

Use an SslOptions when setting up LDAP options needed to use StartTLS. TrustManagers has methods you can use to set the trust manager for the SSL context builder.

See Also:

  • Field Details

  • Constructor Details

    • StartTlsExtendedRequest

      public StartTlsExtendedRequest(SslOptions sslOptions, List<Control> controls)
      Creates a new StartTlsExtendedRequest.

  • Method Details

    • getOid

      public String getOid()
      Description copied from interface: ExtendedRequest
      Returns the numeric OID associated with this extended request.
      Specified by:
      getOid in interface ExtendedRequest<ExtendedResult>
      Returns:
      The numeric OID associated with this extended request.

    • getResultDecoder

      public ExtendedResultDecoder<ExtendedResult> getResultDecoder()
      Description copied from interface: ExtendedRequest
      Returns a decoder which can be used to decoded responses to this extended request.
      Specified by:
      getResultDecoder in interface ExtendedRequest<ExtendedResult>
      Returns:
      A decoder which can be used to decoded responses to this extended request.

    • getValue

      public ByteString getValue()
      Description copied from interface: ExtendedRequest
      Returns the value, if any, associated with this extended request. Its format is defined by the specification of this extended request.
      Specified by:
      getValue in interface ExtendedRequest<ExtendedResult>
      Returns:
      The value associated with this extended request, or null if there is no value.

    • hasValue

      public boolean hasValue()
      Description copied from interface: ExtendedRequest
      Returns true if this extended request has a value. In some circumstances it may be useful to determine if an extended request has a value, without actually calculating the value and incurring any performance costs.
      Specified by:
      hasValue in interface ExtendedRequest<ExtendedResult>
      Returns:
      true if this extended request has a value, or false if there is no value.

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

    • sslOptions

      public SslOptions sslOptions()
      Returns the value of the sslOptions record component.
      Returns:
      the value of the sslOptions record component

    • controls

      public List<Control> controls()
      Returns the value of the controls record component.
      Specified by:
      controls in interface ProtocolOp
      Returns:
      the value of the controls record component