public enum BrokerError extends Enum<BrokerError>
BrokerException.matchesError(BrokerError)
method is helpful to figure out if a thrown
BrokerException
is a specific error code. This can be used to check for specific errors and provide custom
handling for those.Enum Constant and Description |
---|
ContainerDeleteNotFound
Thrown on
SecuredContainerMapper.delete(UUID) when the SecuredContainer is not found on the Absio
Broker™ application. |
ContainerGetNotFound
Thrown on
SecuredContainerMapper.get(UUID) when the SecuredContainer is not found on the Absio
Broker™ application. |
ContainerPublishInsufficientPermissions
Thrown on
SecuredContainerMapper.createOrUpdate(SecuredContainer) when the user does not have permission
to update the SecuredContainer . |
ContainerSdkNoDownloadPermission
Thrown on
SecuredContainerMapper.get(UUID) when the user does not have permission to download the SecuredContainer . |
ContainerUpdateAccessNotFound
Thrown on
SecuredContainerMapper.updateAccess(UUID, List) when the SecuredContainer is not found
on the Absio Broker™ application. |
ContainerUpdateInsufficientPermissions
Thrown on
SecuredContainerMapper.createOrUpdate(SecuredContainer) when the user does not have permission
to update the SecuredContainer . |
ContainerUpdateTypeInsufficientPermissions
Thrown on
SecuredContainerMapper.updateType(UUID, String) when the user does not have permission to
update the type of the SecuredContainer . |
ContainerUpdateTypeNotFound
Thrown on
SecuredContainerMapper.updateType(UUID, String) when the SecuredContainer is not found
on the Absio Broker™ application. |
CreateSdkUserNotCreated
Thrown on
UserMapper.logIn(KeyRing) when the user id is not found on the Absio
Broker™ application. |
KeysFileChecksumGetKeysFileNotFound
Thrown on
KeyFileMapper.doesChecksumMatch(UUID, byte[]) when no key file exists
on the Absio Broker™ application for the user id. |
KeysFileChecksumGetUserIdInvalid
Thrown on
KeyFileMapper.doesChecksumMatch(UUID, byte[]) when the provided user id
is improperly formatted. |
KeysFileChecksumGetUserNotFound
Thrown on
KeyFileMapper.doesChecksumMatch(UUID, byte[]) when the user id is not
found on the Absio Broker™ application. |
KeysFileGetInvalidPassphrase
Thrown on
KeyFileMapper.get(UUID, String) when the passphrase could not be
validated by the Absio Broker™ application. |
KeysFileGetInvalidUserId
Thrown on
KeyFileMapper.get(UUID, String) when the provided user id is
improperly formatted. |
KeysFileGetKeysFileNotFound
Thrown on
KeyFileMapper.get(UUID, String) when no key file exists on the Absio
Broker™ application for the user id. |
KeysFileGetPassphraseRequired
Thrown on
KeyFileMapper.get(UUID, String) when no passphrase is provided to the
Absio Broker™ application. |
KeysFileGetUserNotFound
Thrown on
KeyFileMapper.get(UUID, String) when the user id is not found on the
Absio Broker™ application. |
KeysFileReminderGetKeysFileNotFound
Thrown on
KeyFileMapper.getReminder(UUID) when no key file exists on the Absio
Broker™ application for the user id. |
KeysFileReminderGetUserIdInvalid
Thrown on
KeyFileMapper.getReminder(UUID) when the provided user id is improperly
formatted. |
KeysFileReminderGetUserNotFound
Thrown on
KeyFileMapper.get(UUID, String) when the user id is not found on the Absio
Broker™ application. |
LogInSdkAllKeysInactive
Thrown on
UserMapper.logIn(KeyRing) by the SDK when the user id is not found on
the Absio Broker™ application. |
LogInSdkKeyFileNotFound
Thrown on
ServerProvider.logIn(UUID, String, String) by the SDK when the users key
file is not found on the Absio Broker™ application. |
LogInSignatureFailure
Thrown on
UserMapper.logIn(KeyRing) when the signature fails using the signing
key stored on Absio Broker™ application identified by the specified index. |
LogInSigningKeyNotFoundForUser
Thrown on
UserMapper.logIn(KeyRing) when the signing key index does not match a
stored signing key for that user on Absio Broker™ application. |
LogInUserNotActive
Thrown on
UserMapper.logIn(KeyRing) when the signing key used is not active. |
LogInUserNotFound
Thrown on
UserMapper.logIn(KeyRing) when the user id is not found on the Absio
Broker™ application. |
PublicKeyUserNotFound
Thrown on
PublicKeyMapper.getByIndex(UUID, KeyType, int) (KeyRing)}, PublicKeyMapper.get(UUID, KeyType, Integer) or PublicKeyMapper.getLatestActive(UUID, KeyType) when the user id is not found on the
Absio Broker™ application. |
Unknown
If there is no code or the code is found in the enumeration values, this is returned from
findErrorByCode(String) . |
Modifier and Type | Method and Description |
---|---|
static BrokerError |
findErrorByCode(String code)
Returns the
BrokerError with the matching code or Unknown if one is not found. |
String |
getCode()
Get the UUID code for the error on the Absio Broker™ application.
|
static BrokerError |
valueOf(String name)
Returns the enum constant of this type with the specified name.
|
static BrokerError[] |
values()
Returns an array containing the constants of this enum type, in
the order they are declared.
|
public static final BrokerError Unknown
findErrorByCode(String)
.public static final BrokerError LogInSigningKeyNotFoundForUser
UserMapper.logIn(KeyRing)
when the signing key index does not match a
stored signing key for that user on Absio Broker™ application.public static final BrokerError LogInSignatureFailure
UserMapper.logIn(KeyRing)
when the signature fails using the signing
key stored on Absio Broker™ application identified by the specified index.public static final BrokerError LogInUserNotActive
UserMapper.logIn(KeyRing)
when the signing key used is not active.public static final BrokerError LogInUserNotFound
UserMapper.logIn(KeyRing)
when the user id is not found on the Absio
Broker™ application.public static final BrokerError CreateSdkUserNotCreated
UserMapper.logIn(KeyRing)
when the user id is not found on the Absio
Broker™ application.public static final BrokerError LogInSdkAllKeysInactive
UserMapper.logIn(KeyRing)
by the SDK when the user id is not found on
the Absio Broker™ application.public static final BrokerError LogInSdkKeyFileNotFound
ServerProvider.logIn(UUID, String, String)
by the SDK when the users key
file is not found on the Absio Broker™ application.public static final BrokerError PublicKeyUserNotFound
PublicKeyMapper.getByIndex(UUID, KeyType, int)
(KeyRing)}, PublicKeyMapper.get(UUID, KeyType, Integer)
or PublicKeyMapper.getLatestActive(UUID, KeyType)
when the user id is not found on the
Absio Broker™ application.public static final BrokerError KeysFileChecksumGetKeysFileNotFound
KeyFileMapper.doesChecksumMatch(UUID, byte[])
when no key file exists
on the Absio Broker™ application for the user id.public static final BrokerError KeysFileChecksumGetUserIdInvalid
KeyFileMapper.doesChecksumMatch(UUID, byte[])
when the provided user id
is improperly formatted.public static final BrokerError KeysFileChecksumGetUserNotFound
KeyFileMapper.doesChecksumMatch(UUID, byte[])
when the user id is not
found on the Absio Broker™ application.public static final BrokerError KeysFileGetInvalidPassphrase
KeyFileMapper.get(UUID, String)
when the passphrase could not be
validated by the Absio Broker™ application.public static final BrokerError KeysFileGetInvalidUserId
KeyFileMapper.get(UUID, String)
when the provided user id is
improperly formatted.public static final BrokerError KeysFileGetKeysFileNotFound
KeyFileMapper.get(UUID, String)
when no key file exists on the Absio
Broker™ application for the user id.public static final BrokerError KeysFileGetPassphraseRequired
KeyFileMapper.get(UUID, String)
when no passphrase is provided to the
Absio Broker™ application.public static final BrokerError KeysFileGetUserNotFound
KeyFileMapper.get(UUID, String)
when the user id is not found on the
Absio Broker™ application.public static final BrokerError KeysFileReminderGetKeysFileNotFound
KeyFileMapper.getReminder(UUID)
when no key file exists on the Absio
Broker™ application for the user id.public static final BrokerError KeysFileReminderGetUserIdInvalid
KeyFileMapper.getReminder(UUID)
when the provided user id is improperly
formatted.public static final BrokerError KeysFileReminderGetUserNotFound
KeyFileMapper.get(UUID, String)
when the user id is not found on the Absio
Broker™ application.public static final BrokerError ContainerSdkNoDownloadPermission
SecuredContainerMapper.get(UUID)
when the user does not have permission to download the SecuredContainer
.public static final BrokerError ContainerDeleteNotFound
SecuredContainerMapper.delete(UUID)
when the SecuredContainer
is not found on the Absio
Broker™ application.public static final BrokerError ContainerUpdateInsufficientPermissions
SecuredContainerMapper.createOrUpdate(SecuredContainer)
when the user does not have permission
to update the SecuredContainer
.public static final BrokerError ContainerUpdateTypeInsufficientPermissions
SecuredContainerMapper.updateType(UUID, String)
when the user does not have permission to
update the type of the SecuredContainer
.public static final BrokerError ContainerPublishInsufficientPermissions
SecuredContainerMapper.createOrUpdate(SecuredContainer)
when the user does not have permission
to update the SecuredContainer
.public static final BrokerError ContainerUpdateAccessNotFound
SecuredContainerMapper.updateAccess(UUID, List)
when the SecuredContainer
is not found
on the Absio Broker™ application.public static final BrokerError ContainerUpdateTypeNotFound
SecuredContainerMapper.updateType(UUID, String)
when the SecuredContainer
is not found
on the Absio Broker™ application.public static final BrokerError ContainerGetNotFound
SecuredContainerMapper.get(UUID)
when the SecuredContainer
is not found on the Absio
Broker™ application.public static BrokerError[] values()
for (BrokerError c : BrokerError.values()) System.out.println(c);
public static BrokerError valueOf(String name)
name
- the name of the enum constant to be returned.IllegalArgumentException
- if this enum type has no constant with the specified nameNullPointerException
- if the argument is nullpublic static BrokerError findErrorByCode(String code)
BrokerError
with the matching code or Unknown
if one is not found.code
- the code to matchBrokerError
with the matching code or Unknown
if one is not foundCopyright © 2021. All rights reserved.