public class CredentialDataRequest
extends Object


An object representing a request for credential data.

Summary

Nested classes

class CredentialDataRequest.Builder

A builder for CredentialDataRequest. 

Public methods

Map<String, Collection<String>> getDeviceSignedEntriesToRequest()

Gets the device-signed entries to request.

Map<String, Collection<String>> getIssuerSignedEntriesToRequest()

Gets the issuer-signed entries to request.

byte[] getReaderSignature()

Gets the reader signature.

byte[] getRequestMessage()

Gets the request message CBOR.

boolean isAllowUsingExhaustedKeys()

Gets whether to allow using an authentication key which use count has been exceeded.

boolean isAllowUsingExpiredKeys()

Gets whether to allow using an authentication key which is expired.

boolean isIncrementUseCount()

Gets whether to increment the use-count for the authentication key used.

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 methods

getDeviceSignedEntriesToRequest

Added in API level 33 

public Map<String, Collection<String>> getDeviceSignedEntriesToRequest ()

Gets the device-signed entries to request.

Returns
Map<String, Collection<String>> the device-signed entries to request.
This value cannot be null.

getIssuerSignedEntriesToRequest

Added in API level 33 

public Map<String, Collection<String>> getIssuerSignedEntriesToRequest ()

Gets the issuer-signed entries to request.

Returns
Map<String, Collection<String>> the issuer-signed entries to request.
This value cannot be null.

getReaderSignature

Added in API level 33 

public byte[] getReaderSignature ()

Gets the reader signature.

This data structure is described in the documentation for the PresentationSession.getCredentialData(String,CredentialDataRequest) method.

Returns
byte[] a COSE_Sign1 structure as described above.
This value may be null.

getRequestMessage

Added in API level 33 

public byte[] getRequestMessage ()

Gets the request message CBOR.

This data structure is described in the documentation for the PresentationSession.getCredentialData(String,CredentialDataRequest) method.

Returns
byte[] the request message CBOR as described above.
This value may be null.

isAllowUsingExhaustedKeys

Added in API level 33 

public boolean isAllowUsingExhaustedKeys ()

Gets whether to allow using an authentication key which use count has been exceeded.

By default this is set to true.

Returns
boolean whether to allow using an authentication key which use count has been exceeded if no other key is available.

isAllowUsingExpiredKeys

Added in API level 33 

public boolean isAllowUsingExpiredKeys ()

Gets whether to allow using an authentication key which is expired.

By default this is set to false.

Returns
boolean whether to allow using an authentication key which is expired if no other key is available.

isIncrementUseCount

Added in API level 33 

public boolean isIncrementUseCount ()

Gets whether to increment the use-count for the authentication key used.

By default this is set to true.

Returns
boolean whether to increment the use count of the authentication key used.

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 2026-02-26 UTC.