Skip to content

Most visited

Recently visited

navigation

Credential

public final class Credential
extends Object implements Parcelable

java.lang.Object
   ↳ 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

class Credential.CertificateCredential

Certificate based credential. 

class Credential.SimCredential

SIM (Subscriber Identify Module) based credential. 

class Credential.UserCredential

Username-password based credential. 

Inherited constants

From interface android.os.Parcelable

Fields

public static final Creator<Credential> CREATOR

Public constructors

Credential()

Constructor for creating Credential with default values.

Credential(Credential source)

Copy constructor.

Public methods

int describeContents()

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

boolean equals(Object thatObject)

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

X509Certificate getCaCertificate()
Credential.CertificateCredential getCertCredential()
boolean getCheckAaaServerCertStatus()
X509Certificate[] getClientCertificateChain()
PrivateKey getClientPrivateKey()
long getCreationTimeInMs()
long getExpirationTimeInMs()
String getRealm()
Credential.SimCredential getSimCredential()
Credential.UserCredential getUserCredential()
int hashCode()

Returns a hash code value for the object.

void setCaCertificate(X509Certificate caCertificate)
void setCertCredential(Credential.CertificateCredential certCredential)
void setCheckAaaServerCertStatus(boolean checkAaaServerCertStatus)
void setClientCertificateChain(X509Certificate[] certificateChain)
void setClientPrivateKey(PrivateKey clientPrivateKey)
void setCreationTimeInMs(long creationTimeInMs)
void setExpirationTimeInMs(long expirationTimeInMs)
void setRealm(String realm)
void setSimCredential(Credential.SimCredential simCredential)
void setUserCredential(Credential.UserCredential userCredential)
boolean validate()

Validate the configuration data.

void writeToParcel(Parcel dest, int flags)

Flatten this object in to a Parcel.

Inherited methods

From class java.lang.Object
From interface android.os.Parcelable

Fields

Public constructors

Credential

Credential ()

Constructor for creating Credential with default values.

Credential

Credential (Credential source)

Copy constructor.

Parameters
source Credential: The source to copy from

Public methods

describeContents

int describeContents ()

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(Parcel, int), the return value of this method must include the CONTENTS_FILE_DESCRIPTOR bit.

Returns
int a bitmask indicating the set of special object types marshaled by this Parcelable object instance.

equals

boolean equals (Object thatObject)

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.

The equals method for class Object implements the most discriminating possible equivalence relation on objects; that is, for any non-null reference values x and y, this method returns true if and only if x and y refer to the same object (x == y has the value true).

Note that it is generally necessary to override the hashCode method whenever this method is overridden, so as to maintain the general contract for the hashCode method, which states that equal objects must have equal hash codes.

Parameters
thatObject Object: the reference object with which to compare.
Returns
boolean true if this object is the same as the obj argument; false otherwise.

getCaCertificate

X509Certificate getCaCertificate ()

Returns
X509Certificate

getCheckAaaServerCertStatus

boolean getCheckAaaServerCertStatus ()

Returns
boolean

getClientCertificateChain

X509Certificate[] getClientCertificateChain ()

Returns
X509Certificate[]

getClientPrivateKey

PrivateKey getClientPrivateKey ()

Returns
PrivateKey

getCreationTimeInMs

long getCreationTimeInMs ()

Returns
long

getExpirationTimeInMs

long getExpirationTimeInMs ()

Returns
long

getRealm

String getRealm ()

Returns
String

hashCode

int hashCode ()

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by 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(Object) 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(java.lang.Object) 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.

As much as is reasonably practical, the hashCode method defined by class Object does return distinct integers for distinct objects. (This is typically implemented by converting the internal address of the object into an integer, but this implementation technique is not required by the Java™ programming language.)

Returns
int a hash code value for this object.

setCaCertificate

void setCaCertificate (X509Certificate caCertificate)

Parameters
caCertificate X509Certificate

setCertCredential

void setCertCredential (Credential.CertificateCredential certCredential)

Parameters
certCredential Credential.CertificateCredential

setCheckAaaServerCertStatus

void setCheckAaaServerCertStatus (boolean checkAaaServerCertStatus)

Parameters
checkAaaServerCertStatus boolean

setClientCertificateChain

void setClientCertificateChain (X509Certificate[] certificateChain)

Parameters
certificateChain X509Certificate

setClientPrivateKey

void setClientPrivateKey (PrivateKey clientPrivateKey)

Parameters
clientPrivateKey PrivateKey

setCreationTimeInMs

void setCreationTimeInMs (long creationTimeInMs)

Parameters
creationTimeInMs long

setExpirationTimeInMs

void setExpirationTimeInMs (long expirationTimeInMs)

Parameters
expirationTimeInMs long

setRealm

void setRealm (String realm)

Parameters
realm String

setSimCredential

void setSimCredential (Credential.SimCredential simCredential)

Parameters
simCredential Credential.SimCredential

setUserCredential

void setUserCredential (Credential.UserCredential userCredential)

Parameters
userCredential Credential.UserCredential

validate

boolean validate ()

Validate the configuration data.

Returns
boolean true on success or false on failure

writeToParcel

void writeToParcel (Parcel dest, 
                int flags)

Flatten this object in to a Parcel.

Parameters
dest Parcel: The Parcel in which the object should be written.
flags int: Additional flags about how the object should be written. May be 0 or PARCELABLE_WRITE_RETURN_VALUE.
This site uses cookies to store your preferences for site-specific language and display options.

Hooray!

This class requires API level or higher

This doc is hidden because your selected API level for the documentation is . You can change the documentation API level with the selector above the left navigation.

For more information about specifying the API level your app requires, read Supporting Different Platform Versions.

Take a one-minute survey?
Help us improve Android tools and documentation.