Struct DshApiPlatformClientFactory 

pub struct DshApiPlatformClientFactory { /* private fields */ }

Platform factory for DSH API client

This module provides a factory for creating DshApiClient instances, based on a platform and a single-sign-on access token for that platform.

The DshApiClients for the different tenant name all share the same API client which uses a pool to connect to the resource management API. This gives much better performance than creating a separate client for each tenant and avoids network and dns problems.

This factory should be used with the single-sign-on authentication and authorization pattern. For creating clients that authenticate and authorize with a robot password the DshApiClientFactory should be used.

Create a factory by providing the platform and access_token parameters to the create_from_access_token function.

Once you have the DshApiPlatformClientFactory you can call its client() method with a tenant name as parameter to get a DshApiClient.

Example

In this example explicit platform and access token parameters are used to create a DshApiPlatformClientFactory.

use dsh_api::platform::DshPlatform;
use dsh_api::dsh_api_platform_client_factory::DshApiPlatformClientFactory;
let platform = DshPlatform::try_from("np-aws-lz-dsh")?;
let access_token = "...";
let client_factory =
  DshApiPlatformClientFactory::create_from_access_token(platform, access_token)?;
let client = client_factory.client("my-tenant").await?;
...

Implementations

impl DshApiPlatformClientFactory

pub fn create_from_access_token<T>( platform: DshPlatform, access_token: T, ) -> Result<Self, DshApiError>

where T: Into<String>,

Create platform factory for DSH API client with static access token

This function will create a new DshApiPlatformClientFactory from the provided parameters.

Parameters

• platform - Platform for which the factory will be created.
• access_token - The static access token used to access the API for the platform.

Examples

use dsh_api::platform::DshPlatform;
use dsh_api::dsh_api_client_factory::DshApiPlatformClientFactory;

let platform = DshPlatform::new("nplz");
let access_token = "...";
let client_factory =
  DshApiPlatformClientFactory::create_from_access_token(platform, access_token)?;
let client = client_factory.client("my-tenant").await?;
println!("tenant is {}", client.tenant());

pub fn platform(&self) -> &DshPlatform

Returns the factories platform

pub async fn client<T>( &self, tenant_name: T, ) -> Result<DshApiClient, DshApiError>

where T: Into<String>,

Create an DSH API client

This function will create a new DshApiClient for the platform and the provided tenant name.

Parameters

• tenant_name - Name of the tenant for which the client will be created.

Returns

• Ok<DshApiClient> - Created client.
• Err<DshApiError> - Error message when the client could not be created.

Examples

use dsh_api::dsh_api_client_factory::DshApiPlatformClientFactory;

let platform = DshPlatform::try_from("np-aws-lz-dsh")?;
let access_token = "...";
let client_factory = DshApiPlatformClientFactory::create_from_access_token(platform, access_token)?;
match client_factory.client("my-tenant").await {
  Ok(client) => println!("tenant is {}", client.tenant()),
  Err(error) => println!("could not create client ({})", error),
}

Trait Implementations

impl Debug for DshApiPlatformClientFactory

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.