at_server_status 1.0.4 copy "at_server_status: ^1.0.4" to clipboard
at_server_status: ^1.0.4 copied to clipboard

A Dart library that provides a means to check on the status of the @‎root server as well as the secondary server for any particular @‎sign.

The Atsign FoundationThe Atsign Foundation

pub package pub points gitHub license

at_server_status #

The at_server_status library provides an easy means to check on the status of the atRoot server as well as the atServer for a particular atSign.

The atServer configuration lifecycle #

The lifecycle of an atServer as it gets created and paired is as follows:

  1. The first step is to provision an atSign from a registrar site.

    • The atSign is reserved by the registrar so nobody else can provision it.
    • atRoot does not yet have an entry for the atSign, rootStatus returns:
    • AtStatus.rootStatus = RootStatus.notFound
    • An atServer has not been deployed for the atSign, serverStatus returns:
    • AtStatus.serverStatus = ServerStatus.unavailable
    • The overall status from the status() method returns:
    • AtStatus.status() = AtSignStatus.notFound
    • Or, if you prefer an HttpStatus code, use the httpStatus() method:
    • AtStatus.httpStatus() = 404
  2. The next step in the process is when "Activate" is selected for an atSign on the registrar site.

    • An atServer gets deployed for the atSign which returns when it is ready.
    • AtStatus.serverStatus = ServerStatus.teapot
    • An entry in atRoot is created with the location of the atServer which returns:
    • AtStatus.rootStatus = RootStatus.found
    • A shared secret gets created and stored on the atServer.
    • The shared secret QR Code is displayed on the registrar site which is used to pair the atServer with a mobile device when all is ready.
  3. The next step in the process is when an @compliant application is used to "pair" with the atServer for the first time.

    • Typically, the application will detect that the atServer has not been paired and will prompt you to scan the QR Code to set this up.
    • The application presents the option to scan the QR Code which will then be used to pair the device to the atServer.
    • If you are unable to scan the QR Code (for example if you are using only the mobile device), then there is an option to copy the QR Code to the device and then upload it to the application.
    • The application will then create a public/private keypair to pair to the atServer which is stored on your device in the secure enclave which provides best in class security for this all important information. You need to guard this well as it is the key (pun intended) to protecting your information.
    • At this time, the information stored in the device keychain is only ' accessible to the application that created it. Another means and another library (the at_pairing library is used for that purpose).
  4. The final step in the process is to save a backup of this information.

    • In case you

Configuring additional applications to work with your atServer #

There are three methods that you can use to retrieve status information:

  1. Get an AtStatus object for some atSign
    • AtStatus atStatus = await atStatusImpl.get(atSign);
    • The AtStatus object includes both atRoot status and the atServer status
  2. The status() method returns an enumerated AtSignStatus value of the overall status of an atSign.
    • AtSignStatus atSignStatus = atStatus.status();
  3. The httpStatus() method returns an integer matching HTTPStatus values representing the overall status of an atSign.
    • int httpStatus = atStatus.httpStatus();

List of enumerated values #

  1. AtSignStatus enumerated values are:
    • enum AtSignStatus { notFound, teapot, activated, unavailable, error }
  2. RootStatus enumerated values are:
    • enum RootStatus { found, notFound, stopped, unavailable, error }
  3. ServerStatus enumerated values are:
    • enum ServerStatus { ready, teapot, activated, stopped, unavailable, error }
  4. Const values from HttpStatus are:
static const int notFound = 404
// Not Found(404) atServer has no root location, is not running and is not activated

static const int serviceUnavailable = 503
// Service Unavailable(503) atServer has root location, is not running and is not activated

int 418
// I'm a teapot(418) atServer has root location, is running and but not activated

static const int ok = 200
// OK (200) atServer has root location, is running and is activated

static const int internalServerError = 500
// Internal Server Error(500) at_find_api internal error

static const int badGateway = 502
// Bad Gateway(502) atRoot server is down

static const int methodNotAllowed = 405
// Method Not Allowed(405) only GET and HEAD are allowed
9
likes
140
pub points
55%
popularity

Publisher

verified publisheratsign.org

A Dart library that provides a means to check on the status of the @‎root server as well as the secondary server for any particular @‎sign.

Homepage
Repository (GitHub)
View/report issues
Contributing

Documentation

Documentation
API reference

License

BSD-3-Clause (LICENSE)

Dependencies

at_commons, at_lookup, at_utils, uuid

More

Packages that depend on at_server_status