Conecte-se ao Atlas App Services - Kotlin SDK

Cliente de aplicativo padrão

Para inicializar um aplicativo com valores de configuração padrão, passe o ID do aplicativo para seu App Services App para o método App.create() :

// Creates an App with default configuration values
val app = App.create(YOUR_APP_ID) // Replace with your App ID

Cliente de aplicativo configurado

A interface AppConfiguration permite que você configure seu cliente de aplicativo com argumentos opcionais para um controle mais granular dos detalhes de conexão do aplicativo, como cabeçalhos de solicitação personalizados e chaves para criptografia local.

Para controlar as opções de configuração, use o AppConfiguration.Builder e chame o método .build() para passar um objeto de configuração:

// Creates an App with custom configuration values
AppConfiguration.Builder(YOUR_APP_ID)
    // Specify your custom configuration values
    .appName("my-app-name")
    .appVersion("1.0.0")
    .baseUrl("http://localhost:9090")
    .build()

Compartilhar conexões de sincronização

Por padrão, o SDK abre uma conexão separada com o servidor para cada domínio sincronizado. No Kotlin v1.13.0 e posterior, você pode habilitar a multiplexação de sessão. Quando ativado, o SDK compartilha uma conexão com o servidor para todos os domínios sincronizados abertos com um único usuário do Atlas App Services. O compartilhamento de uma conexão em várias sessões reduz os recursos e pode melhorar o desempenho.

A multiplexação está desabilitada por padrão. Você pode habilitá-lo no AppConfiguration usando o arquivo .enableSessionMultiflexing() , que aceita um valor booleano.

val config = AppConfiguration.Builder(YOUR_APP_ID)
    .enableSessionMultiplexing(true)
    .build()

Quando ativada, a conexão compartilhada não fecha imediatamente quando todas as sessões são fechadas. Em vez disso, ele permanece aberto pelos connectionLingerTime, que é padronizado para 30 segundos. Você pode substituir esta duração passando um novo valor para SyncTimeoutOptions.connectionLingerTime() no AppConfiguration.

val configCustomLingerTime = AppConfiguration.Builder(YOUR_APP_ID)
    .enableSessionMultiplexing(true)
    .syncTimeouts {
        connectionLingerTime = 10.seconds // Overrides default 30 secs
    }
    .build()

Para obter mais informações, consulte a seção Configurar tempos limite de sincronização nesta página.

Configurar tempos limite de sincronização

No Kotlin v1.13.0 e posterior, você pode substituir as configurações de tempo limite padrão usadas ao sincronizar dados entre o backend do Atlas e o aplicativo cliente .

Você pode definir várias configurações de tempo limite de sincronização no AppConfiguration usando o .syncTimeouts() método. Passe valores de propriedade de tempo limite específicos que você deseja substituir. Os tempos limite configurados se aplicam a todas as sessões de sincronização no aplicativo.

val config = AppConfiguration.Builder(YOUR_APP_ID)
    .syncTimeouts {
        connectTimeout = 1.minutes
        connectionLingerTime = 15.seconds
        pingKeepalivePeriod = 30.seconds
        pongKeepalivePeriod = 1.minutes
        fastReconnectLimit = 30.seconds
    }
    .build()

Para obter uma lista completa das propriedades de tempo limite disponíveis e suas definições, consulte a referência da API SyncTimeoutOptionsBuilder .

Criptografar metadados de aplicativos

Quando você se conecta ao App Services, o Realm cria arquivos de metadados adicionais em um dispositivo. Para mais informações sobre estes arquivos de metadados, consulte Atlas Device SDK for Kotlin.

Você pode criptografar os metadados que o Atlas App Services armazena em dispositivos clientes, semelhante à forma como você criptografa um domínio Realm.

Para criptografar os metadados do aplicativo, passe sua chave de encriptação para a propriedade encryptionKey ao inicializar o aplicativo:

val config =
    AppConfiguration.Builder(YOUR_APP_ID)
        // Specify the encryption key
        .encryptionKey(myEncryptionKey)
        .build()

Definir HTTP headerspersonalizados

Se você usar o App Services ou o Device Sync com uma configuração de proxy, talvez seja necessário definir HTTP headers personalizados. O Kotlin SDK suporta a configuração de HTTP headers personalizados no aplicativo. Esses cabeçalhos são anexados a cada solicitação ao App Services App, incluindo chamadas de função.

Ao inicializar o aplicativo, você pode passar:

• o valor personalizado authorizedHeaderName String

• qualquer customRequestHeaders em um mapa de chaves e valores de cabeçalho String (o SDK aceita valores vazios, mas não chaves vazias)

AppConfiguration.Builder(YOUR_APP_ID)
    .authorizationHeaderName("MyApp-Authorization")
    .customRequestHeaders { put("X-MyApp-Version", "1.0.0") }
    .build()

Habilitar a rede de plataforma

A rede de plataforma do Atlas Device SDK permite que você use a pilha de rede da sua plataforma em vez do cliente WebSocket padrão para o tráfego do Device Sync .

Quando habilitado, você pode configurar aplicativos em execução em plataformas Android e Java Virtual Machine (JVM) para usar WebSockets gerenciados pelo OkHttp. Os WebSockets gerenciados fornecem suporte de configuração avançada para proxies e firewalls que exigem autenticação.

A rede de plataforma está desabilitada por padrão. Você pode habilitá-lo no AppConfiguration utilizando o AppConfiguration.usePlatformNetwork() , que aceita um valor booleano.

val config =
    AppConfiguration.Builder(YOUR_APP_ID)
        .usePlatformNetworking(true)
        .build()

Conecte-se a um servidor MongoDB diferente durante o tempo de execução

Em alguns casos, você pode querer alterar o baseUrl enquanto o aplicativo está em execução.

Para alterar o baseUrl durante o tempo de execução, chame o método experimental app.updateBaseUrl . Você pode passar null para redefinir o baseUrl para o valor padrão.

// Specify a custom baseUrl to connect to.
// In this case, an Edge Server instance running on the device:
val config = AppConfiguration.Builder(EDGE_SERVER_APP_ID)
    .baseUrl("http://localhost:80")
    .build()
val app = App.create(config)
// ... log in a user and use the app ...
// Later, change the baseUrl.
// In this case, pass `null` to reset to default:
// https://services.cloud.mongodb.com
app.updateBaseUrl(null)

Se você alterar o baseUrl após ter conectado um usuário e aberto um banco de banco de dados sincronizado, o aplicativo deverá executar um reinício do cliente. Para obter mais informações, consulte Gerenciar erros de redefinição do cliente.

Execute o seguinte em seu código:

1. Pausar a sessão de sincronização

2. Atualize o baseUrl utilizando o método app.updateBaseUrl

3. Autentique novamente o usuário para fazer login usando o novo baseUrl

4. Abra um banco de dados de dados sincronizado extraindo dados do novo servidor

Tanto o servidor quanto o cliente devem estar online para que o usuário se autentique e se conecte ao novo servidor. Se o servidor não estiver online ou o cliente não tiver uma conexão de rede, o usuário não poderá autenticar e abrir o banco de dados de dados.