MetaClientException (Smartcrypt SDK 2019.7.1)

java.lang.Object
- java.lang.Throwable
- - java.lang.Exception
  - - com.pkware.smartcrypt.metaclient.MetaClientException

All Implemented Interfaces:

Serializable
```
public final class MetaClientException
extends Exception
```
See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`String`	`category` Major area of the problem.
`static String`	`CATEGORY_ACCOUNT_DISABLED` User's account has been disabled at the server.
`static String`	`CATEGORY_ALREADY_MIGRATED` Account migration was already performed - calls initiated by `CATEGORY_MIGRATION_REQUIRED` are no longer applicable.
`static String`	`CATEGORY_CLIENT` Generic error usually related to client not respecting parameter rules or preconditions.
`static String`	`CATEGORY_CLIENT_REFRESH` Maximum offline access time exceeded - must communicate with server.
`static String`	`CATEGORY_COMMUNICATION_ERROR` Unable to communicate over network.
`static String`	`CATEGORY_DEVICE_NOT_ALLOWED` Transaction was denied because the device has been disabled/disallowed.
`static String`	`CATEGORY_FORCED_UPGRADE` Server said we have to upgrade.
`static String`	`CATEGORY_HTTP` Server is unhappy with us (or itself).
`static String`	`CATEGORY_INTERNAL` Something not coded correctly in PKMeta.
`static String`	`CATEGORY_INVALID_METADATA` During restore, found mismatch between metadata manifest and actual metadata (possible tampering, possible data corruption).
`static String`	`CATEGORY_ISOLATED_MODE` MC running in isolated mode - cannot perform operation.
`static String`	`CATEGORY_KEY_SERVER` Attempt to communicate with external key server was not successful.
`static String`	`CATEGORY_LOGIN_REQUIRED` Login required (attempted to use a function that requires being logged in).
`static String`	`CATEGORY_MIGRATION_MISMATCH` During migration, user authenticated to SMDS with a different email than the one being migrated.
`static String`	`CATEGORY_MIGRATION_REQUIRED` Account must move to a satellite or change its email to a non-authorized domain.
`static String`	`CATEGORY_NOT_FOUND` Something not found (e.g.
`static String`	`CATEGORY_NOT_MANAGED` MC attempted to use an unmanaged account with a workflow requiring a managed account.
`static String`	`CATEGORY_PASSWORD` Something not acceptable about a password.
`static String`	`CATEGORY_POLICY_VIOLATION` Attempted to do something not permitted by policy.
`static String`	`CATEGORY_PROTOCOL` Server response does not satisfy protocol.
`static String`	`CATEGORY_UNAUTHORIZED_SERVER` MC attempted to verify server authorization and security checks did not pass.
`static String`	`CATEGORY_UPGRADE` Data was found from another device running a newer version of metaclient.
`int`	`httpCode` If `category` is `CATEGORY_HTTP`, an HTTP response code.
`String`	`reason`
`static String`	`REASON_ACCOUNT_DISABLED` User's account has been disabled at the server.
`static String`	`REASON_AUXINFO_TOO_LARGE` AuxInfo being sent is to large.
`static String`	`REASON_CREDENTIALS` Email or password is bogus.
`static String`	`REASON_DENIED` Server didn't give Asset info because AssetRight explicitly denies the caller.
`static String`	`REASON_DEVICE_DISABLED` Device has been disabled either by team admin or by the owner (wipe metadata!!).
`static String`	`REASON_DOMAIN_NOT_FOUND` Indicates that the domain is not registered with CMDS as having an SMDS.
`static String`	`REASON_INACTIVE_ENDPOINT` For any number of reasons, the requested endpoint is not enabled on the current remote.
`static String`	`REASON_INVALID_LICENSE` License key is invalid.
`static String`	`REASON_NO_RIGHT` Server didn't give Asset info because no AssetRight applies to caller.
`static String`	`REASON_NOT_LICENSED` Server did not issue a license.
`static String`	`REASON_NOT_MANAGED` Server was asked to use an unmanaged account with a workflow or endpoint requiring a managed account.
`static String`	`REASON_OUT_OF_LICENSES` Server has no more licenses to issue.
`static String`	`REASON_REVISION` Server dislikes a put because it's not a newer revision.
`static String`	`REASON_SATELLITE_LICENSE` License is actived by a satellite NOT central.
`static String`	`REASON_SEND_TO_MASTER` The current remote cannot handle the request and the client should retry with a master node.
`static String`	`REASON_UPGRADE` Sent by server along with `403` to indicate that an upgrade is required (causes `CATEGORY_FORCED_UPGRADE`).

Constructor Summary

Constructors
Constructor and Description
`MetaClientException(String category, String message)`
`MetaClientException(String category, String message, Exception cause)`
`MetaClientException(String category, String message, String reason)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type Method and Description

String getMessage()
- Methods inherited from class java.lang.Throwable
  addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, 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

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getMessage()`

- Field Detail
  - CATEGORY_COMMUNICATION_ERROR
```
public static final String CATEGORY_COMMUNICATION_ERROR
```
    Unable to communicate over network.
    
    See Also:
    
    Constant Field Values
  - CATEGORY_PROTOCOL
```
public static final String CATEGORY_PROTOCOL
```
    Server response does not satisfy protocol.
    
    See Also:
    
    Constant Field Values
  - CATEGORY_HTTP
```
public static final String CATEGORY_HTTP
```
    Server is unhappy with us (or itself).
    
    See Also:
    
    httpCode, Constant Field Values
  - CATEGORY_INTERNAL
```
public static final String CATEGORY_INTERNAL
```
    Something not coded correctly in PKMeta.
    
    See Also:
    
    Constant Field Values
  - CATEGORY_NOT_FOUND
```
public static final String CATEGORY_NOT_FOUND
```
    Something not found (e.g. account).
    
    See Also:
    
    Constant Field Values
  - CATEGORY_PASSWORD
```
public static final String CATEGORY_PASSWORD
```
    Something not acceptable about a password.
    
    See Also:
    
    Constant Field Values
  - CATEGORY_CLIENT
```
public static final String CATEGORY_CLIENT
```
    Generic error usually related to client not respecting parameter rules or preconditions.
    
    See Also:
    
    Constant Field Values
  - CATEGORY_CLIENT_REFRESH
```
public static final String CATEGORY_CLIENT_REFRESH
```
    Maximum offline access time exceeded - must communicate with server.
    
    See Also:
    
    Constant Field Values
  - CATEGORY_UPGRADE
```
public static final String CATEGORY_UPGRADE
```
    Data was found from another device running a newer version of metaclient.
    
    See Also:
    
    Constant Field Values
  - CATEGORY_FORCED_UPGRADE
```
public static final String CATEGORY_FORCED_UPGRADE
```
    Server said we have to upgrade.
    
    See Also:
    
    Constant Field Values
  - CATEGORY_DEVICE_NOT_ALLOWED
```
public static final String CATEGORY_DEVICE_NOT_ALLOWED
```
    Transaction was denied because the device has been disabled/disallowed.
    
    See Also:
    
    Constant Field Values
  - CATEGORY_ACCOUNT_DISABLED
```
public static final String CATEGORY_ACCOUNT_DISABLED
```
    User's account has been disabled at the server.
    
    See Also:
    
    Constant Field Values
  - CATEGORY_ISOLATED_MODE
```
public static final String CATEGORY_ISOLATED_MODE
```
    MC running in isolated mode - cannot perform operation.
    
    See Also:
    
    Constant Field Values
  - CATEGORY_NOT_MANAGED
```
public static final String CATEGORY_NOT_MANAGED
```
    MC attempted to use an unmanaged account with a workflow requiring a managed account.
    
    See Also:
    
    Constant Field Values
  - CATEGORY_UNAUTHORIZED_SERVER
```
public static final String CATEGORY_UNAUTHORIZED_SERVER
```
    MC attempted to verify server authorization and security checks did not pass.
    
    See Also:
    
    Constant Field Values
  - CATEGORY_LOGIN_REQUIRED
```
public static final String CATEGORY_LOGIN_REQUIRED
```
    Login required (attempted to use a function that requires being logged in).
    
    See Also:
    
    Constant Field Values
  - CATEGORY_MIGRATION_REQUIRED
```
public static final String CATEGORY_MIGRATION_REQUIRED
```
    Account must move to a satellite or change its email to a non-authorized domain.
    
    See Also:
    
    Constant Field Values
  - CATEGORY_ALREADY_MIGRATED
```
public static final String CATEGORY_ALREADY_MIGRATED
```
    Account migration was already performed - calls initiated by CATEGORY_MIGRATION_REQUIRED are no longer applicable.
    
    See Also:
    
    Constant Field Values
  - CATEGORY_MIGRATION_MISMATCH
```
public static final String CATEGORY_MIGRATION_MISMATCH
```
    During migration, user authenticated to SMDS with a different email than the one being migrated.
    
    See Also:
    
    Constant Field Values
  - CATEGORY_INVALID_METADATA
```
public static final String CATEGORY_INVALID_METADATA
```
    During restore, found mismatch between metadata manifest and actual metadata (possible tampering, possible data corruption).
    
    See Also:
    
    Constant Field Values
  - CATEGORY_POLICY_VIOLATION
```
public static final String CATEGORY_POLICY_VIOLATION
```
    Attempted to do something not permitted by policy.
    
    See Also:
    
    Constant Field Values
  - CATEGORY_KEY_SERVER
```
public static final String CATEGORY_KEY_SERVER
```
    Attempt to communicate with external key server was not successful.
    
    See Also:
    
    Constant Field Values
  - REASON_UPGRADE
```
public static final String REASON_UPGRADE
```
    Sent by server along with 403 to indicate that an upgrade is required (causes CATEGORY_FORCED_UPGRADE).
    
    See Also:
    
    Constant Field Values
  - REASON_CREDENTIALS
```
public static final String REASON_CREDENTIALS
```
    Email or password is bogus.
    
    See Also:
    
    Constant Field Values
  - REASON_REVISION
```
public static final String REASON_REVISION
```
    Server dislikes a put because it's not a newer revision.
    
    See Also:
    
    Constant Field Values
  - REASON_NO_RIGHT
```
public static final String REASON_NO_RIGHT
```
    Server didn't give Asset info because no AssetRight applies to caller.
    
    See Also:
    
    Constant Field Values
  - REASON_DENIED
```
public static final String REASON_DENIED
```
    Server didn't give Asset info because AssetRight explicitly denies the caller.
    
    See Also:
    
    Constant Field Values
  - REASON_ACCOUNT_DISABLED
```
public static final String REASON_ACCOUNT_DISABLED
```
    User's account has been disabled at the server.
    
    See Also:
    
    Constant Field Values
  - REASON_DEVICE_DISABLED
```
public static final String REASON_DEVICE_DISABLED
```
    Device has been disabled either by team admin or by the owner (wipe metadata!!).
    
    See Also:
    
    Constant Field Values
  - REASON_DOMAIN_NOT_FOUND
```
public static final String REASON_DOMAIN_NOT_FOUND
```
    Indicates that the domain is not registered with CMDS as having an SMDS.
    
    See Also:
    
    Constant Field Values
  - REASON_NOT_MANAGED
```
public static final String REASON_NOT_MANAGED
```
    Server was asked to use an unmanaged account with a workflow or endpoint requiring a managed account.
    
    See Also:
    
    Constant Field Values
  - REASON_NOT_LICENSED
```
public static final String REASON_NOT_LICENSED
```
    Server did not issue a license.
    
    See Also:
    
    Constant Field Values
  - REASON_OUT_OF_LICENSES
```
public static final String REASON_OUT_OF_LICENSES
```
    Server has no more licenses to issue.
    
    See Also:
    
    Constant Field Values
  - REASON_INVALID_LICENSE
```
public static final String REASON_INVALID_LICENSE
```
    License key is invalid.
    
    See Also:
    
    Constant Field Values
  - REASON_SATELLITE_LICENSE
```
public static final String REASON_SATELLITE_LICENSE
```
    License is actived by a satellite NOT central.
    
    See Also:
    
    Constant Field Values
  - REASON_AUXINFO_TOO_LARGE
```
public static final String REASON_AUXINFO_TOO_LARGE
```
    AuxInfo being sent is to large.
    
    See Also:
    
    Constant Field Values
  - REASON_SEND_TO_MASTER
```
public static final String REASON_SEND_TO_MASTER
```
    The current remote cannot handle the request and the client should retry with a master node.
    
    See Also:
    
    Constant Field Values
  - REASON_INACTIVE_ENDPOINT
```
public static final String REASON_INACTIVE_ENDPOINT
```
    For any number of reasons, the requested endpoint is not enabled on the current remote. It may be enabled on another node.
    
    See Also:
    
    Constant Field Values
  - category
```
@Nonnull
public String category
```
    Major area of the problem.
  - httpCode
```
public int httpCode
```
    If category is CATEGORY_HTTP, an HTTP response code. The server often uses these to inform the client in useful ways.
  - reason
```
@Nullable
public String reason
```
- Constructor Detail
  - MetaClientException
```
public MetaClientException(String category,
                           @Nullable
                           String message)
```
  - MetaClientException
```
public MetaClientException(String category,
                           @Nullable
                           String message,
                           @Nullable
                           Exception cause)
```
  - MetaClientException
```
public MetaClientException(String category,
                           @Nullable
                           String message,
                           @Nullable
                           String reason)
```
- Method Detail
  - getMessage
```
public String getMessage()
```
    Overrides:
    
    getMessage in class Throwable

Class MetaClientException

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Throwable

Methods inherited from class java.lang.Object

Field Detail

CATEGORY_COMMUNICATION_ERROR

CATEGORY_PROTOCOL

CATEGORY_HTTP

CATEGORY_INTERNAL

CATEGORY_NOT_FOUND

CATEGORY_PASSWORD

CATEGORY_CLIENT

CATEGORY_CLIENT_REFRESH

CATEGORY_UPGRADE

CATEGORY_FORCED_UPGRADE

CATEGORY_DEVICE_NOT_ALLOWED

CATEGORY_ACCOUNT_DISABLED

CATEGORY_ISOLATED_MODE

CATEGORY_NOT_MANAGED

CATEGORY_UNAUTHORIZED_SERVER

CATEGORY_LOGIN_REQUIRED

CATEGORY_MIGRATION_REQUIRED

CATEGORY_ALREADY_MIGRATED

CATEGORY_MIGRATION_MISMATCH

CATEGORY_INVALID_METADATA

CATEGORY_POLICY_VIOLATION

CATEGORY_KEY_SERVER

REASON_UPGRADE

REASON_CREDENTIALS

REASON_REVISION

REASON_NO_RIGHT

REASON_DENIED

REASON_ACCOUNT_DISABLED

REASON_DEVICE_DISABLED

REASON_DOMAIN_NOT_FOUND

REASON_NOT_MANAGED

REASON_NOT_LICENSED

REASON_OUT_OF_LICENSES

REASON_INVALID_LICENSE

REASON_SATELLITE_LICENSE

REASON_AUXINFO_TOO_LARGE

REASON_SEND_TO_MASTER

REASON_INACTIVE_ENDPOINT

category

httpCode

reason

Constructor Detail

MetaClientException

MetaClientException

MetaClientException

Method Detail

getMessage