Added in API level 33

CredentialDataResult.Entries

public static interface CredentialDataResult.Entries

android.security.identity.CredentialDataResult.Entries


A class for representing data elements returned.

Summary

Constants

int STATUS_NOT_IN_REQUEST_MESSAGE

The entry wasn't in the request message.

int STATUS_NOT_REQUESTED

The entry was not requested.

int STATUS_NO_ACCESS_CONTROL_PROFILES

The entry was not retrieved because it was configured without any access control profile.

int STATUS_NO_SUCH_ENTRY

The entry does not exist.

int STATUS_OK

Value was successfully retrieved.

int STATUS_READER_AUTHENTICATION_FAILED

The entry was not retrieved because reader authentication failed.

int STATUS_USER_AUTHENTICATION_FAILED

The entry was not retrieved because user authentication failed.

Public methods

abstract byte[] getEntry(String namespaceName, String name)

Gets the raw CBOR data for the value of an entry.

abstract Collection<String> getEntryNames(String namespaceName)

Get the names of all requested entries in a name space.

abstract Collection<String> getNamespaces()

Gets the names of namespaces with retrieved entries.

abstract Collection<String> getRetrievedEntryNames(String namespaceName)

Get the names of all entries that was successfully retrieved from a name space.

abstract int getStatus(String namespaceName, String name)

Gets the status of an entry.

Constants

STATUS_NOT_IN_REQUEST_MESSAGE

Added in API level 33
public static final int STATUS_NOT_IN_REQUEST_MESSAGE

The entry wasn't in the request message.

Constant Value: 3 (0x00000003)

STATUS_NOT_REQUESTED

Added in API level 33
public static final int STATUS_NOT_REQUESTED

The entry was not requested.

Constant Value: 2 (0x00000002)

STATUS_NO_ACCESS_CONTROL_PROFILES

Added in API level 33
public static final int STATUS_NO_ACCESS_CONTROL_PROFILES

The entry was not retrieved because it was configured without any access control profile.

Constant Value: 6 (0x00000006)

STATUS_NO_SUCH_ENTRY

Added in API level 33
public static final int STATUS_NO_SUCH_ENTRY

The entry does not exist.

Constant Value: 1 (0x00000001)

STATUS_OK

Added in API level 33
public static final int STATUS_OK

Value was successfully retrieved.

Constant Value: 0 (0x00000000)

STATUS_READER_AUTHENTICATION_FAILED

Added in API level 33
public static final int STATUS_READER_AUTHENTICATION_FAILED

The entry was not retrieved because reader authentication failed.

Constant Value: 5 (0x00000005)

STATUS_USER_AUTHENTICATION_FAILED

Added in API level 33
public static final int STATUS_USER_AUTHENTICATION_FAILED

The entry was not retrieved because user authentication failed.

Constant Value: 4 (0x00000004)

Public methods

getEntry

Added in API level 33
public abstract byte[] getEntry (String namespaceName, 
                String name)

Gets the raw CBOR data for the value of an entry.

This should only be called on an entry for which the getStatus(java.lang.String, java.lang.String) method returns STATUS_OK.

Parameters
namespaceName String: the namespace name of the entry. This value cannot be null.

name String: the name of the entry to get the value for. This value cannot be null.

Returns
byte[] the raw CBOR data or null if no entry with the given name exists.

getEntryNames

Added in API level 33
public abstract Collection<String> getEntryNames (String namespaceName)

Get the names of all requested entries in a name space.

This includes the name of entries that wasn't successfully retrieved.

Parameters
namespaceName String: the namespace name to get entries for. This value cannot be null.

Returns
Collection<String> A collection of names for the given namespace or the empty collection if no entries was returned for the given name space. This value cannot be null.

getNamespaces

Added in API level 33
public abstract Collection<String> getNamespaces ()

Gets the names of namespaces with retrieved entries.

Returns
Collection<String> collection of name of namespaces containing retrieved entries. May be empty if no data was retrieved. This value cannot be null.

getRetrievedEntryNames

Added in API level 33
public abstract Collection<String> getRetrievedEntryNames (String namespaceName)

Get the names of all entries that was successfully retrieved from a name space.

This only return entries for which getStatus(java.lang.String, java.lang.String) will return STATUS_OK.

Parameters
namespaceName String: the namespace name to get entries for. This value cannot be null.

Returns
Collection<String> The entries in the given namespace that were successfully rerieved or the empty collection if no entries was returned for the given name space. This value cannot be null.

getStatus

Added in API level 33
public abstract int getStatus (String namespaceName, 
                String name)

Gets the status of an entry.

This returns STATUS_OK if the value was retrieved, STATUS_NO_SUCH_ENTRY if the given entry wasn't retrieved, STATUS_NOT_REQUESTED if it wasn't requested, STATUS_NOT_IN_REQUEST_MESSAGE if the request message was set but the entry wasn't present in the request message, STATUS_USER_AUTHENTICATION_FAILED if the value wasn't retrieved because the necessary user authentication wasn't performed, STATUS_READER_AUTHENTICATION_FAILED if the supplied reader certificate chain didn't match the set of certificates the entry was provisioned with, or STATUS_NO_ACCESS_CONTROL_PROFILES if the entry was configured without any access control profiles.

Parameters
namespaceName String: the namespace name of the entry. This value cannot be null.

name String: the name of the entry to get the value for. This value cannot be null.

Returns
int the status indicating whether the value was retrieved and if not, why. Value is STATUS_OK, STATUS_NO_SUCH_ENTRY, STATUS_NOT_REQUESTED, STATUS_NOT_IN_REQUEST_MESSAGE, STATUS_USER_AUTHENTICATION_FAILED, STATUS_READER_AUTHENTICATION_FAILED, or STATUS_NO_ACCESS_CONTROL_PROFILES