CreatePublicKeyCredentialDomException.kt
/*
* Copyright 2022 The Android Open Source Project
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package androidx.credentials.exceptions.publickeycredential
import androidx.annotation.RestrictTo
import androidx.credentials.exceptions.CreateCredentialCustomException
import androidx.credentials.exceptions.CreateCredentialException
import androidx.credentials.exceptions.domerrors.DomError
import androidx.credentials.exceptions.domerrors.UnknownError
import androidx.credentials.exceptions.publickeycredential.DomExceptionUtils.Companion.SEPARATOR
import androidx.credentials.internal.FrameworkClassParsingException
/**
* During the create-passkey flow, this is thrown when a DOM Exception is thrown,
* indicating the operation contains a DOMException error type. The fido spec can be found
* [here](https://webidl.spec.whatwg.org/#idl-DOMException-error-names). The full list of
* implemented DOMErrors extends from and can be seen at [DomError].
*
* @property domError the specific error from the DOMException types defined in the fido spec found
* [here](https://webidl.spec.whatwg.org/#idl-DOMException-error-names)
* @throws NullPointerException If [domError] is null
*/
class CreatePublicKeyCredentialDomException @JvmOverloads constructor(
val domError: DomError,
errorMessage: CharSequence? = null
) : CreatePublicKeyCredentialException(
TYPE_CREATE_PUBLIC_KEY_CREDENTIAL_DOM_EXCEPTION + SEPARATOR + domError.type,
errorMessage) {
internal companion object {
internal const val TYPE_CREATE_PUBLIC_KEY_CREDENTIAL_DOM_EXCEPTION: String =
"androidx.credentials.TYPE_CREATE_PUBLIC_KEY_CREDENTIAL_DOM_EXCEPTION"
@JvmStatic
@RestrictTo(RestrictTo.Scope.LIBRARY) // used from java tests
fun createFrom(type: String, msg: String?): CreateCredentialException {
val prefix = "$TYPE_CREATE_PUBLIC_KEY_CREDENTIAL_DOM_EXCEPTION$SEPARATOR"
return try {
DomExceptionUtils.generateDomException(type, prefix, msg,
CreatePublicKeyCredentialDomException(UnknownError()))
} catch (t: FrameworkClassParsingException) {
// Parsing failed but don't crash the process. Instead just output a response
// with the raw framework values.
CreateCredentialCustomException(type, msg)
}
}
}
}