Interface Certificate

All Known Implementing Classes:
NegotiationState, RequestCertificate

public interface Certificate
The Certificate interface represents the certificate that is sent by a client during a secure HTTPS conversation. This may or may not contain an X509 certificate chain from the client. If it does not a CertificateChallenge may be used to issue a renegotiation of the connection. One completion of the renegotiation the challenge executes a completion operation.
See Also:
  • Method Summary

    Modifier and Type
    Method
    Description
    This will return the X509 certificate chain, if any, that has been sent by the client.
    This returns a challenge for the certificate.
    boolean
    This is used to determine if the X509 certificate chain is present for the request.
  • Method Details

    • getChain

      X509Certificate[] getChain() throws Exception
      This will return the X509 certificate chain, if any, that has been sent by the client. A certificate chain is typically only send when the server explicitly requests the certificate on the initial connection or when it is challenged for.
      Returns:
      this returns the clients X509 certificate chain
      Throws:
      Exception
    • getChallenge

      CertificateChallenge getChallenge() throws Exception
      This returns a challenge for the certificate. A challenge is issued by providing a Runnable task which is to be executed when the challenge has completed. Typically this task should be used to drive completion of an HTTPS request.
      Returns:
      this returns a challenge for the client certificate
      Throws:
      Exception
    • isChainPresent

      boolean isChainPresent() throws Exception
      This is used to determine if the X509 certificate chain is present for the request. If it is not present then a challenge can be used to request the certificate.
      Returns:
      true if the certificate chain is present
      Throws:
      Exception