AccessControlProfile.Builder

Kotlin |Java

public static final class AccessControlProfile.Builder
extends Object

java.lang.Object
↳	android.security.identity.AccessControlProfile.Builder

A builder for AccessControlProfile.

Summary

Public constructors
`Builder(AccessControlProfileId accessControlProfileId)` Each access control profile has numeric identifier that must be unique within the context of a Credential and may be used to reference the profile.

Public methods
`AccessControlProfile`	`build()` Creates a new `AccessControlProfile` from the data supplied to the builder.
`AccessControlProfile.Builder`	`setReaderCertificate(X509Certificate readerCertificate)` Sets the reader certificate to use when checking access control.
`AccessControlProfile.Builder`	`setUserAuthenticationRequired(boolean userAuthenticationRequired)` Set whether user authentication is required.
`AccessControlProfile.Builder`	`setUserAuthenticationTimeout(long userAuthenticationTimeoutMillis)` Sets the authentication timeout to use.

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 constructors

Builder

Added in API level 30

public Builder (AccessControlProfileId accessControlProfileId)

Each access control profile has numeric identifier that must be unique within the context of a Credential and may be used to reference the profile.

By default, the resulting AccessControlProfile will require user authentication with a timeout of zero, thus requiring the holder to authenticate for every presentation where data elements using this access control profile is used.

Parameters
`accessControlProfileId`	`AccessControlProfileId`: the access control profile identifier. This value cannot be `null`.

Public methods

build

Added in API level 30

public AccessControlProfile build ()

Creates a new AccessControlProfile from the data supplied to the builder.

Returns
`AccessControlProfile`	The created `AccessControlProfile` object. This value cannot be `null`.

setReaderCertificate

Added in API level 30

public AccessControlProfile.Builder setReaderCertificate (X509Certificate readerCertificate)

Sets the reader certificate to use when checking access control.

If set, this is checked against the certificate chain presented by reader. The access check is fulfilled only if one of the certificates in the chain, matches the certificate set by this method.

Parameters
`readerCertificate`	`X509Certificate`: the certificate to use for the access control check. This value cannot be `null`.

Returns
`AccessControlProfile.Builder`	The builder. This value cannot be `null`.

setUserAuthenticationRequired

Added in API level 30

public AccessControlProfile.Builder setUserAuthenticationRequired (boolean userAuthenticationRequired)

Set whether user authentication is required.

This should be used sparingly since disabling user authentication on just a single data element can easily create a Relay Attack if the device on which the credential is stored is compromised.

Parameters
`userAuthenticationRequired`	`boolean`: Set to true if user authentication is required, false otherwise.

Returns
`AccessControlProfile.Builder`	The builder. This value cannot be `null`.

setUserAuthenticationTimeout

Added in API level 30

public AccessControlProfile.Builder setUserAuthenticationTimeout (long userAuthenticationTimeoutMillis)

Sets the authentication timeout to use.

The authentication timeout specifies the amount of time, in milliseconds, for which a user authentication is valid, if user authentication is required (see setUserAuthenticationRequired(boolean)).

If the timeout is zero, then authentication is always required for each reader session.

Parameters
`userAuthenticationTimeoutMillis`	`long`: the authentication timeout, in milliseconds.

Returns
`AccessControlProfile.Builder`	The builder. This value cannot be `null`.