at_commons library
Classes
-
AtBuffer<
T> - Class holder for message of different data types(int, String etc.,)
- AtChainedException
- AtConstants
- AtExceptionManager
- AtExceptionManager is responsible for creating instances of the appropriate exception classes for a given exception scenario.
- AtExceptionStack
- Class to maintain stack of exceptions to form a chained exception.
- AtExceptionUtils
- Utility class that returns instance of exception for the given error code.
- AtKey
- AtKeyValidator
- Validates String representation of a AtKey For example String representation of a public key PublicKey will be public:phone.wavi@bob
- AtKeyValidators
- Returns an instance of AtKeyValidator
- AtTelemetryEvent
- Concrete AtTelemetryItem subclass for Events - e.g. SyncStarted, NetworkUnavailable, MonitorUnavailable
- AtTelemetryItem
- Generic telemetry datum
- AtTelemetrySample
- Concrete AtTelemetryItem subclass for Samples - e.g. KeyStoreSize, DataReceived, DataTransmitted
- AtTelemetryService
- Simple software telemetry service. See https://en.wikipedia.org/wiki/Telemetry#Software
- AtValue
- BatchRequest
- BatchResponse
- ByteBuffer
- EnrollParams
- EnrollResponse
- KeyFormatValidation
- Validates if the Key adheres to a format represented by a regex
- KeyLengthValidation
- Validates key length of a @sign
- KeyOwnershipValidation
- Validates if the ownership is right for a given key type
- Validates if key is rightly shared
- LocalKey
- Represents a local key Local key are confined to the client(device)/server it is created. The key does not sync between the local-secondary and the cloud-secondary.
- Metadata
- PrivateKey
- Represents a Private key.
- PublicKey
- Represents a public key.
- ReservedEntityValidation
- Verifies if the key belongs to reserved key list.
- Response
- SecureSocketConfig
- class to store configuration to create a security context while creating secure sockets
- SelfKey
- Represents a Self key.
- Represents a key shared to another atSign.
- StringBuffer
- UpdateParams
- Validation
- Implement a validation on a key
- ValidationContext
- Represents context of a validation See AtKeyValidator
- ValidationResult
-
Represents outcome of a key validation
See AtKeyValidator and
AtConcreteKeyValidator
- VerbSyntax
- VerbUtil
Enums
Extensions
Constants
- accessLogCompactionKey → const String
- apkamEncryptedDefaultPrivateKey → const String
- apkamEncryptedDefaultSelfEncryptionKey → const String
- apkamEncryptedSymmetricKey → const String
- apkamNamespaces → const String
- apkamPublicKey → const String
- APP_NAME → const String
- APP_VERSION → const String
- AT_CRAM_SECRET → const String
- AT_CRAM_SECRET_DELETED → const String
- AT_DIGEST → const String
- AT_ENCRYPTION_PRIVATE_KEY → const String
- AT_ENCRYPTION_PUBLIC_KEY → const String
- AT_ENCRYPTION_SELF_KEY → const String
- AT_ENCRYPTION_SHARED_KEY → const String
- AT_FROM_COMMIT_SEQUENCE → const String
- AT_KEY → const String
- AT_OPERATION → const String
- AT_PKAM_HASHING_ALGO → const String
- AT_PKAM_PRIVATE_KEY → const String
- AT_PKAM_PUBLIC_KEY → const String
- AT_PKAM_SIGNATURE → const String
- AT_PKAM_SIGNING_ALGO → const String
- AT_REGEX → const String
- AT_SIGN → const String
- AT_SIGNING_KEYPAIR_GENERATED → const String
- AT_SIGNING_PRIVATE_KEY → const String
- AT_SIGNING_PUBLIC_KEY → const String
- AT_STAT_ID → const String
- AT_TTB → const String
- AT_TTL → const String
- AT_TTL_NOTIFICATION → const String
- AT_TTR → const String
- AT_VALUE → const String
- AT_VALUE_REFERENCE → const String
- bypassCache → const String
- CACHED → const String
- CCD → const String
- CLIENT_CONFIG → const String
- CLIENT_ID → const String
- commitLogCompactionKey → const String
- CONFIG_NEW → const String
- CREATED_AT → const String
- defaultEncryptionPrivateKey → const String
- defaultSelfEncryptionKey → const String
- deviceName → const String
- ENCODING → const String
- ENCRYPTING_ALGO → const String
- ENCRYPTING_KEY_NAME → const String
- encryptionKeyName → const String
- enrollmentId → const String
- enrollParams → const String
- EPOCH_MILLIS → const String
- error_codes → const Map
- error_description → const Map
- FIRST_BYTE → const String
- FOR_AT_SIGN → const String
- FROM → const String
- FROM_AT_SIGN → const String
- ID → const String
- IS_BINARY → const String
- IS_ENCRYPTED → const String
- IS_LOCAL → const String
- IS_PUBLIC → const String
- IV_OR_NONCE → const String
- KEY → const String
- keyName → const String
- keyType → const String
- keyValue → const String
- LATEST_N → const String
- MESSAGE_TYPE → const String
- MONITOR_MULTIPLEXED_MODE → const String
- MONITOR_REGEX → const String
- MONITOR_SELF_NOTIFICATIONS → const String
- MONITOR_STRICT_MODE → const String
- namespace → const String
- NOTIFICATION → const String
- notificationCompactionKey → const String
- NOTIFIER → const String
- OPERATION → const String
- PAGE → const String
- PLATFORM → const String
- PRIORITY → const String
- PUBLIC_DATA_SIGNATURE → const String
- PUBLIC_SCOPE_PARAM → const String
- REFRESH_AT → const String
- SET_OPERATION → const String
- SHARED_KEY_ENCRYPTED → const String
- SHARED_KEY_ENCRYPTED_ENCRYPTING_ALGO → const String
- SHARED_KEY_ENCRYPTED_ENCRYPTING_KEY_NAME → const String
- SHARED_KEY_STATUS → const String
- SHARED_WITH_PUBLIC_KEY_CHECK_SUM → const String
- showHidden → const String
- statsNotificationId → const String
- STRATEGY → const String
- SYSTEM → const String
- TO → const String
- TO_AT_SIGN → const String
- UPDATE_ALL → const String
- UPDATE_JSON → const String
- UPDATE_META → const String
- UPDATED_AT → const String
- VALUE → const String
- VERSION → const String
- visibility → const String
Functions
-
getEnrollOperation(
EnrollOperationEnum? enrollOperationEnum) → String -
getEnrollStatusFromString(
String value) → EnrollStatus -
getMessageType(
MessageTypeEnum? messageTypeEnum) → String -
getOperationName(
OperationEnum? d) → String -
getPriority(
PriorityEnum? priorityEnum) → String -
getStrategy(
StrategyEnum? strategyEnum) → String
Exceptions / Errors
- AtBufferOverFlowException
- AtCertificateValidationException
- Exception thrown when security certification validation on root or secondary server fails
- AtClientException
- AtConnectException
- The class AtConnectException and its subclasses represent any issues that prevents an connection to the root or the secondary server
- AtDecryptionException
- AtEncryptionException
- AtEnrollmentException
- Exception thrown for enrollment related exceptions
- AtException
- The class AtException and its subclasses represents various exceptions that can arise while using the @ protocol.
- AtInvalidEnrollmentException
- Exception thrown when an Enrollment_id is expired or invalid
- AtIOException
- Exception thrown when there is any issue related to socket operations e.g read/write
- AtKeyException
- AtKeyNotFoundException
- AtPrivateKeyNotFoundException
- AtPublicKeyChangeException
- AtPublicKeyNotFoundException
- AtServerException
- AtSigningException
- Exception thrown for issues occurring during data signing or pkam signing operations.
- AtSigningVerificationException
- Exception thrown for issues occurring during data signing verification or pkam signing verification operations.
- AtThrottleLimitExceeded
- Exception thrown when the enrollment requests exceed the limit in the given time window
- AtTimeoutException
- Exception thrown when no response is received before the timeout duration
- AtValueException
- BlockedConnectionException
- BufferOverFlowException
- Exception thrown when data size passed to the socket is greater than configured buffer size
- ConnectionInvalidException
- Thrown when trying to perform a read/write on a connection which is invalid
- HandShakeException
- Exception thrown when from-pol handshake fails between two secondary servers
- IllegalArgumentException
- Exception thrown when any parameter in a verb command is invalid
- InboundConnectionLimitException
- Thrown when current server's inbound connection limit is reached
- InternalServerError
- Thrown for any unhandled server error
- InternalServerException
- Thrown for any unhandled server exception
- InvalidAtKeyException
- Exception thrown when a key is invalid
- InvalidAtSignException
- Exception thrown when an atsign name provided is invalid.
- InvalidDataException
- Exception thrown when data provided to a method is invalid.
- InvalidRequestException
- Exception thrown when request to secondary server is invalid
- InvalidResponseException
- Exception thrown when response from secondary server is invalid e.g invalid json format
- InvalidSyntaxException
- Exception thrown when an @ protocol verb has an invalid syntax.
- KeyNotFoundException
- Exception thrown when AtKey.key is not present in the keystore
- LookupException
- Thrown when lookup fails after handshake
- OutBoundConnectionInvalidException
- Thrown when trying to perform a read/write on an outbound connection which is invalid
- OutboundConnectionLimitException
- Thrown when current server's outbound connection limit is reached
- RootServerConnectivityException
- Exception thrown when there is an issue connecting to root server
- SecondaryConnectException
- Exception thrown when an atsign's secondary url cannot be reached or is unavailable Should this be extending AtConnectException?
- SecondaryNotFoundException
- Exception thrown when the requested atsign's secondary url is not present in Root server
- SecondaryServerConnectivityException
- Exception thrown when there is an issue connecting to secondary server
- SelfKeyNotFoundException
- ServerIsPausedException
- Thrown when a request is received on a connection while the server is paused
- UnAuthenticatedException
- Thrown when trying to perform a verb execution which requires authentication
- UnAuthorizedException
- Exception thrown when a client tries to execute a verb or establish a connection but doesn't have the required permissions