Share via

CosmosEncryptionClient Class

Package:
com.azure.cosmos.encryption
Maven Artifact:
com.azure:azure-cosmos-encryption:2.25.0
  • java.lang.Object
    • com.azure.cosmos.encryption.CosmosEncryptionClient

Implements

Closeable

public final class CosmosEncryptionClient
implements Closeable

Provides a client-side logical representation of the Azure Cosmos DB service. Calls to CosmosClient API's are blocked for completion.

Method Summary

Modifier and Type Method and Description
void close()

Close this CosmosClient instance and cleans up the resources.
CosmosClient getCosmosClient()
CosmosEncryptionDatabase getCosmosEncryptionDatabase(CosmosDatabase cosmosDatabase)

Gets a database with Encryption capabilities
CosmosEncryptionDatabase getCosmosEncryptionDatabase(String databaseId)

Gets a database with Encryption capabilities
KeyEncryptionKeyResolver getEncryptionKeyWrapProvider()
String getKeyEncryptionKeyResolverName()

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Method Details

close

public void close()

Close this CosmosClient instance and cleans up the resources.

getCosmosClient

public CosmosClient getCosmosClient()

Returns:

the Cosmos client

getCosmosEncryptionDatabase

public CosmosEncryptionDatabase getCosmosEncryptionDatabase(CosmosDatabase cosmosDatabase)

Gets a database with Encryption capabilities

Parameters:

cosmosDatabase - original database

Returns:

database with encryption capabilities

getCosmosEncryptionDatabase

public CosmosEncryptionDatabase getCosmosEncryptionDatabase(String databaseId)

Gets a database with Encryption capabilities

Parameters:

databaseId - original database id

Returns:

database with encryption capabilities

getEncryptionKeyWrapProvider

public KeyEncryptionKeyResolver getEncryptionKeyWrapProvider()

Returns:

the key encryption key resolver

getKeyEncryptionKeyResolverName

public String getKeyEncryptionKeyResolverName()

Returns:

the key encryption key resolver name

Applies to