Package com.yubico.fido.metadata

Class FidoMetadataDownloader.FidoMetadataDownloaderBuilder.Step1

java.lang.Object

com.yubico.fido.metadata.FidoMetadataDownloader.FidoMetadataDownloaderBuilder.Step1

Enclosing class:

FidoMetadataDownloader.FidoMetadataDownloaderBuilder

public static class FidoMetadataDownloader.FidoMetadataDownloaderBuilder.Step1
extends Object

Step 1: Set the legal header to expect from the FIDO Metadata Service.

By using the FIDO Metadata Service, you will be subject to its terms of service. This step serves two purposes:

1. To remind you and any code reviewers that you need to read those terms of service before using this feature.
2. To help you detect if the legal header changes, so you can take appropriate action.

See expectLegalHeader(String...).

See Also:

• expectLegalHeader(String...)

Method Summary

Modifier and Type	Method	Description
FidoMetadataDownloader.FidoMetadataDownloaderBuilder.Step2	expectLegalHeader(@NonNull String... expectedLegalHeaders)	Set legal headers expected in the metadata BLOB.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

expectLegalHeader

public FidoMetadataDownloader.FidoMetadataDownloaderBuilder.Step2 expectLegalHeader(@NonNull
 @NonNull String... expectedLegalHeaders)

Set legal headers expected in the metadata BLOB.

By using the FIDO Metadata Service, you will be subject to its terms of service. This builder step serves two purposes:

1. To remind you and any code reviewers that you need to read those terms of service before using this feature.
2. To help you detect if the legal header changes, so you can take appropriate action.

If the legal header in the downloaded BLOB does not equal any of the expectedLegalHeaders, an UnexpectedLegalHeader exception will be thrown in the finalizing builder step.

Note that this library makes no guarantee that a change to the FIDO Metadata Service terms of service will also cause a change to the legal header in the BLOB.

At the time of this library release, the current legal header is "Retrieval and use of this BLOB indicates acceptance of the appropriate agreement located at https://fidoalliance.org/metadata/metadata-legal-terms/" .

Parameters:

expectedLegalHeaders - the set of BLOB legal headers you expect in the metadata BLOB payload.