Package com.yubico.fido.metadata

Class UnexpectedLegalHeader

java.lang.Object

java.lang.Throwable

java.lang.Exception

com.yubico.fido.metadata.UnexpectedLegalHeader

All Implemented Interfaces:

Serializable

public class UnexpectedLegalHeader
extends Exception

A FIDO Metadata Service metadata BLOB was successfully downloaded and validated, but contained an unexpected legal header.

This exception contains the offending downloaded metadata BLOB as well as the cached metadata BLOB, if any (see getCachedBlob()). This enables applications to gracefully fall back to the cached blob when possible, while notifying maintainers that action is required for the new legal header.

See Also:

• Serialized Form

Method Summary

Modifier and Type	Method	Description
Optional<MetadataBLOB>	getCachedBlob()	The cached metadata BLOB, if any.
@NonNull MetadataBLOB	getDownloadedBlob()	The newly downloaded metadata BLOB, which has an unexpected legal header.

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

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

Method Details

getCachedBlob

public Optional<MetadataBLOB> getCachedBlob()

The cached metadata BLOB, if any.

getDownloadedBlob

@NonNull
public @NonNull MetadataBLOB getDownloadedBlob()

The newly downloaded metadata BLOB, which has an unexpected legal header.

The unexpected legal header can be retrieved via the getPayload().getLegalHeader() methods.

See Also:

• MetadataBLOB.getPayload()
• MetadataBLOBPayload.getLegalHeader()