2.5.14 Add Users to a Relay Server

  • Article

This use case describes how users are added to a relay server. The actor is an administrator.

The following diagram illustrates this process.

Process for adding users to a relay server

Figure 23: Process for adding users to a relay server

Preconditions

The relay server is configured and ready to be managed by a management server.

Steps

  1. The administrator adds users to a domain on the management server, as described in section 2.5.10, by using the administration application.

  2. The management server sends an add-user request to the relay server. If all of the users cannot be added in one request, the management server sends additional add-user requests to the relay server.

  3. The relay server receives the add-user request and processes it.

If the user database for the relay server exists and does not need to be rebuilt, the relay server adds the users to the existing user database and returns a response to the management server indicating that the users were added successfully.

If the user database for the relay server needs to be built or rebuilt, the following steps also occur:

  1. The relay server returns a response to the management server indicating that the user database needs to be built.

  2. The management server sends a request to put the relay server in an inactive state before building the user database.

  3. The relay server receives the request, enters the inactive state, and returns a successful response.

  4. The management server receives the successful response and sends add-user requests to build the user database on the relay server.

  5. The relay server receives the add-user requests, builds or rebuilds the user database, adds users to that user database, and returns successful responses.

  6. The management server sends a request to put the relay server in an active state.

  7. The relay server receives the request, enters the active state, and returns a successful response.

Errors

  • Cannot connect to the relay server – The administration application notifies the administrator of the error.

  • Relay server errors – The administration application notifies the administrator of the error.

  • Management server errors – The administration application notifies the administrator of the error.

Post-conditions

  • Users are added to the relay server.

  • Users are not added to the relay server and the administrator is notified of the error.