# Print output for @column tags ?>
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.
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 |
---|
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()
Get the CA (Certification Authority) certificate associated with this credential. |
Credential.CertificateCredential
|
getCertCredential()
Get the certificate credential information. |
X509Certificate[]
|
getClientCertificateChain()
Get the client certificate chain associated with this credential. |
PrivateKey
|
getClientPrivateKey()
Get the client private key associated with this credential. |
String
|
getRealm()
Get the realm associated with this credential. |
Credential.SimCredential
|
getSimCredential()
Get the SIM credential information. |
Credential.UserCredential
|
getUserCredential()
Get the user credential information. |
int
|
hashCode()
Returns a hash code value for the object. |
void
|
setCaCertificate(X509Certificate caCertificate)
Set the CA (Certification Authority) certificate associated with this credential. |
void
|
setCertCredential(Credential.CertificateCredential certCredential)
Set the certificate credential information. |
void
|
setClientCertificateChain(X509Certificate[] certificateChain)
Set the client certificate chain associated with this credential. |
void
|
setClientPrivateKey(PrivateKey clientPrivateKey)
Set the client private key associated with this credential. |
void
|
setRealm(String realm)
Set the realm associated with this credential. |
void
|
setSimCredential(Credential.SimCredential simCredential)
Set the SIM credential information. |
void
|
setUserCredential(Credential.UserCredential userCredential)
Set the user credential information. |
String
|
toString()
Returns a string representation of the object. |
void
|
writeToParcel(Parcel dest, int flags)
Flatten this object in to a Parcel. |
Inherited methods | |
---|---|
public Credential ()
Constructor for creating Credential with default values.
public Credential (Credential source)
Copy constructor.
Parameters | |
---|---|
source |
Credential : The source to copy from |
public 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(android.os.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.
Value is either 0 or CONTENTS_FILE_DESCRIPTOR |
public 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:
x
, x.equals(x)
should return
true
.
x
and y
, x.equals(y)
should return true
if and only if
y.equals(x)
returns true
.
x
, y
, and z
, if
x.equals(y)
returns true
and
y.equals(z)
returns true
, then
x.equals(z)
should return true
.
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.
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. |
public X509Certificate getCaCertificate ()
Get the CA (Certification Authority) certificate associated with this credential.
Returns | |
---|---|
X509Certificate |
CA certificate associated with this credential, null if certificate is not
set or certificate is more than one. |
public Credential.CertificateCredential getCertCredential ()
Get the certificate credential information.
Returns | |
---|---|
Credential.CertificateCredential |
certificate credential information |
public X509Certificate[] getClientCertificateChain ()
Get the client certificate chain associated with this credential.
Returns | |
---|---|
X509Certificate[] |
client certificate chain associated with this credential |
public PrivateKey getClientPrivateKey ()
Get the client private key associated with this credential.
Returns | |
---|---|
PrivateKey |
client private key associated with this credential. |
public String getRealm ()
Get the realm associated with this credential.
Returns | |
---|---|
String |
the realm associated with this credential |
public Credential.SimCredential getSimCredential ()
Get the SIM credential information.
Returns | |
---|---|
Credential.SimCredential |
SIM credential information |
public Credential.UserCredential getUserCredential ()
Get the user credential information.
Returns | |
---|---|
Credential.UserCredential |
user credential information |
public 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:
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.
equals(Object)
method, then calling the hashCode
method on each of
the two objects must produce the same integer result.
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. |
public void setCaCertificate (X509Certificate caCertificate)
Set the CA (Certification Authority) certificate associated with this credential.
Parameters | |
---|---|
caCertificate |
X509Certificate : The CA certificate to set to |
public void setCertCredential (Credential.CertificateCredential certCredential)
Set the certificate credential information.
Parameters | |
---|---|
certCredential |
Credential.CertificateCredential : The certificate credential to set to |
public void setClientCertificateChain (X509Certificate[] certificateChain)
Set the client certificate chain associated with this credential.
Parameters | |
---|---|
certificateChain |
X509Certificate : The client certificate chain to set to |
public void setClientPrivateKey (PrivateKey clientPrivateKey)
Set the client private key associated with this credential.
Parameters | |
---|---|
clientPrivateKey |
PrivateKey : the client private key to set to |
public void setRealm (String realm)
Set the realm associated with this credential.
Parameters | |
---|---|
realm |
String : The realm to set to |
public void setSimCredential (Credential.SimCredential simCredential)
Set the SIM credential information.
Parameters | |
---|---|
simCredential |
Credential.SimCredential : The SIM credential to set to |
public void setUserCredential (Credential.UserCredential userCredential)
Set the user credential information.
Parameters | |
---|---|
userCredential |
Credential.UserCredential : The user credential to set to |
public String toString ()
Returns a string representation of the object. In general, the
toString
method returns a string that
"textually represents" this object. The result should
be a concise but informative representation that is easy for a
person to read.
It is recommended that all subclasses override this method.
The toString
method for class Object
returns a string consisting of the name of the class of which the
object is an instance, the at-sign character `@
', and
the unsigned hexadecimal representation of the hash code of the
object. In other words, this method returns a string equal to the
value of:
getClass().getName() + '@' + Integer.toHexString(hashCode())
Returns | |
---|---|
String |
a string representation of the object. |
public 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.PARCELABLE_WRITE_RETURN_VALUE .
Value is either 0 or a combination of Parcelable.PARCELABLE_WRITE_RETURN_VALUE , and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES |