Added in API level 26

Credential


class Credential : Parcelable
kotlin.Any
   ↳ android.net.wifi.hotspot2.pps.Credential

Class representing Credential subtree in the PerProviderSubscription (PPS) Management Object (MO) tree. For more info, refer to Hotspot 2.0 PPS MO defined in section 9.1 of the Hotspot 2.0 Release 2 Technical Specification. In addition to the fields in the Credential subtree, this will also maintain necessary information for the private key and certificates associated with this credential.

Summary

Nested classes

Certificate based credential.

SIM (Subscriber Identify Module) based credential.

Username-password based credential.

Inherited constants
Public constructors

Constructor for creating Credential with default values.

Copy constructor.

Public methods
Int

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.

Boolean
equals(other: Any?)

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

X509Certificate!

Get the CA (Certification Authority) certificate associated with this credential.

Credential.CertificateCredential!

Get the certificate credential information.

Array<X509Certificate!>!

Get the client certificate chain associated with this credential.

PrivateKey!

Get the client private key associated with this credential.

Int

Get the minimum TLS version for TLS-based EAP methods.

String!

Get the realm associated with this credential.

Credential.SimCredential!

Get the SIM credential information.

Credential.UserCredential!

Get the user credential information.

Int

Returns a hash code value for the object.

Unit

Set the CA (Certification Authority) certificate associated with this credential.

Unit

Set the certificate credential information.

Unit

Set the client certificate chain associated with this credential.

Unit
setClientPrivateKey(clientPrivateKey: PrivateKey!)

Set the client private key associated with this credential.

Unit

Set the minimum TLS version for TLS-based EAP methods.

Unit
setRealm(realm: String!)

Set the realm associated with this credential.

Unit

Set the SIM credential information.

Unit

Set the user credential information.

String

Returns a string representation of the object.

Unit
writeToParcel(dest: Parcel, flags: Int)

Flatten this object in to a Parcel.

Properties
static Parcelable.Creator<Credential!>

Public constructors

Credential

Added in API level 26
Credential()

Constructor for creating Credential with default values.

Credential

Added in API level 26
Credential(source: Credential!)

Copy constructor.

Parameters
source Credential!: The source to copy from

Public methods

describeContents

Added in API level 26
fun describeContents(): Int

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. For example, if the object will include a file descriptor in the output of writeToParcel(android.os.Parcel,int), the return value of this method must include the CONTENTS_FILE_DESCRIPTOR bit.

Return
Int a bitmask indicating the set of special object types marshaled by this Parcelable object instance.
Value is either 0 or

equals

Added in API level 26
fun equals(other: Any?): Boolean

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

The equals method implements an equivalence relation on non-null object references:

  • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters
obj the reference object with which to compare.
Return
Boolean true if this object is the same as the obj argument; false otherwise.

getCaCertificate

Added in API level 26
fun getCaCertificate(): X509Certificate!

Get the CA (Certification Authority) certificate associated with this credential.

Return
X509Certificate! CA certificate associated with this credential, null if certificate is not set or certificate is more than one.

getCertCredential

Added in API level 26
fun getCertCredential(): Credential.CertificateCredential!

Get the certificate credential information.

Return
Credential.CertificateCredential! certificate credential information

getClientCertificateChain

Added in API level 26
fun getClientCertificateChain(): Array<X509Certificate!>!

Get the client certificate chain associated with this credential.

Return
Array<X509Certificate!>! client certificate chain associated with this credential

getClientPrivateKey

Added in API level 26
fun getClientPrivateKey(): PrivateKey!

Get the client private key associated with this credential.

Return
PrivateKey! client private key associated with this credential.

getMinimumTlsVersion

Added in API level 34
fun getMinimumTlsVersion(): Int

Get the minimum TLS version for TLS-based EAP methods.

Return
Int the TLS version.
Value is one of the following:

getRealm

Added in API level 26
fun getRealm(): String!

Get the realm associated with this credential.

Return
String! the realm associated with this credential

getSimCredential

Added in API level 26
fun getSimCredential(): Credential.SimCredential!

Get the SIM credential information.

Return
Credential.SimCredential! SIM credential information

getUserCredential

Added in API level 26
fun getUserCredential(): Credential.UserCredential!

Get the user credential information.

Return
Credential.UserCredential! user credential information

hashCode

Added in API level 26
fun hashCode(): Int

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
Return
Int a hash code value for this object.

setCaCertificate

Added in API level 26
fun setCaCertificate(caCertificate: X509Certificate!): Unit

Set the CA (Certification Authority) certificate associated with this credential.

Parameters
caCertificate X509Certificate!: The CA certificate to set to

setCertCredential

Added in API level 26
fun setCertCredential(certCredential: Credential.CertificateCredential!): Unit

Set the certificate credential information.

Parameters
certCredential Credential.CertificateCredential!: The certificate credential to set to

setClientCertificateChain

Added in API level 26
fun setClientCertificateChain(certificateChain: Array<X509Certificate!>!): Unit

Set the client certificate chain associated with this credential.

Parameters
certificateChain Array<X509Certificate!>!: The client certificate chain to set to

setClientPrivateKey

Added in API level 26
fun setClientPrivateKey(clientPrivateKey: PrivateKey!): Unit

Set the client private key associated with this credential.

Parameters
clientPrivateKey PrivateKey!: the client private key to set to

setMinimumTlsVersion

Added in API level 34
fun setMinimumTlsVersion(tlsVersion: Int): Unit

Set the minimum TLS version for TLS-based EAP methods. android.net.wifi.WifiManager#isTlsMinimumVersionSupported() indicates whether or not a minimum TLS version can be set. If not supported, the minimum TLS version is always TLS v1.0.

android.net.wifi.WifiManager#isTlsV13Supported() indicates whether or not TLS v1.3 is supported. If requested minimum is not supported, it will default to the maximum supported version.

Parameters
tlsVersion Int: the TLS version.
Value is one of the following:
Exceptions
java.lang.IllegalArgumentException if the TLS version is invalid.

setRealm

Added in API level 26
fun setRealm(realm: String!): Unit

Set the realm associated with this credential.

Parameters
realm String!: The realm to set to

setSimCredential

Added in API level 26
fun setSimCredential(simCredential: Credential.SimCredential!): Unit

Set the SIM credential information.

Parameters
simCredential Credential.SimCredential!: The SIM credential to set to

setUserCredential

Added in API level 26
fun setUserCredential(userCredential: Credential.UserCredential!): Unit

Set the user credential information.

Parameters
userCredential Credential.UserCredential!: The user credential to set to

toString

Added in API level 26
fun toString(): String

Returns a string representation of the object.

Return
String a string representation of the object.

writeToParcel

Added in API level 26
fun writeToParcel(
    dest: Parcel,
    flags: Int
): Unit

Flatten this object in to a Parcel.

Parameters
dest Parcel: The Parcel in which the object should be written.
This value cannot be null.
flags Int: Additional flags about how the object should be written. May be 0 or PARCELABLE_WRITE_RETURN_VALUE.
Value is either 0 or a combination of the following:

Properties

CREATOR

Added in API level 26
static val CREATOR: Parcelable.Creator<Credential!>