public abstract class ClientCertRequest
extends Object



ClientCertRequest: The user receives an instance of this class as a parameter of WebViewClient.onReceivedClientCertRequest. The request includes the parameters to choose the client certificate, such as the host name and the port number requesting the cert, the acceptable key types and the principals. The user should call one of the class methods to indicate how to deal with the client certificate request. All methods should be called on UI thread. WebView caches the proceed(PrivateKey, X509Certificate) and cancel() responses in memory and uses them to handle future client certificate requests for the same host/port pair. The user can clear the cached data using WebView.clearClientCertPreferences.

Summary

Public constructors

ClientCertRequest()

Public methods

abstract void cancel()

Cancel this request.

abstract String getHost()

Returns the host name of the server requesting the certificate.

abstract String[] getKeyTypes()

Returns the acceptable types of asymmetric keys.

abstract int getPort()

Returns the port number of the server requesting the certificate.

abstract Principal[] getPrincipals()

Returns the acceptable certificate issuers for the certificate matching the private key.

abstract void ignore()

Ignore the request for now.

abstract void proceed(PrivateKey privateKey, X509Certificate[] chain)

Proceed with the specified private key and client certificate chain.

Inherited methods

From class java.lang.Object

Object clone()

Creates and returns a copy of this object.

boolean equals(Object obj)

Indicates whether some other object is "equal to" this one.

void finalize()

Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.

final Class<?> getClass()

Returns the runtime class of this Object.

int hashCode()

Returns a hash code value for the object.

final void notify()

Wakes up a single thread that is waiting on this object's monitor.

final void notifyAll()

Wakes up all threads that are waiting on this object's monitor.

String toString()

Returns a string representation of the object.

final void wait(long timeoutMillis, int nanos)

Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.

final void wait(long timeoutMillis)

Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.

final void wait()

Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

Public constructors

ClientCertRequest

public ClientCertRequest ()

Public methods

cancel

public abstract void cancel ()

Cancel this request. Remember the user's choice and use it for future requests.

getHost

public abstract String getHost ()

Returns the host name of the server requesting the certificate.

Returns
String

getKeyTypes

public abstract String[] getKeyTypes ()

Returns the acceptable types of asymmetric keys.

Returns
String[] This value may be null.

getPort

public abstract int getPort ()

Returns the port number of the server requesting the certificate.

Returns
int

getPrincipals

public abstract Principal[] getPrincipals ()

Returns the acceptable certificate issuers for the certificate matching the private key.

Returns
Principal[] This value may be null.

ignore

public abstract void ignore ()

Ignore the request for now. Do not remember user's choice.

proceed

public abstract void proceed (PrivateKey privateKey, 
                X509Certificate[] chain)

Proceed with the specified private key and client certificate chain. Remember the user's positive choice and use it for future requests.

Parameters
privateKey PrivateKey
chain X509Certificate

Content and code samples on this page are subject to the licenses described in the Content License. Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.

Last updated 2025-02-10 UTC.