Struct ServerCommunicationConfigClient 

pub struct ServerCommunicationConfigClient<R, P>
where
    R: ServerCommunicationConfigRepository,
    P: ServerCommunicationConfigPlatformApi,
{
    repository: R,
    platform_api: P,
}

Server communication configuration client

Fields

repository: R

platform_api: P

Implementations

impl<R, P> ServerCommunicationConfigClient<R, P>

where R: ServerCommunicationConfigRepository, P: ServerCommunicationConfigPlatformApi,

pub fn new(repository: R, platform_api: P) -> Self

Creates a new server communication configuration client

Arguments

• repository - Cookie storage implementation (e.g a StateProvider hook)
• platform_api - Cookie acquistion implementation

pub async fn get_config( &self, domain: String, ) -> Result<ServerCommunicationConfig, R::GetError>

Retrieves the server communication configuration for a domain

pub async fn needs_bootstrap(&self, domain: String) -> bool

Returns whether this domain uses cookie bootstrapping

Returns true if the domain has an SsoCookieVendor configuration, regardless of whether cookies have already been acquired. This is useful for determining if the domain requires the bootstrap flow (e.g., to show appropriate UI), without making claims about cookie validity.

pub async fn cookies(&self, domain: String) -> Vec<(String, String)>

👎Deprecated: Use get_cookies() instead, which will acquire cookies if not present in the config

Returns cookies to include in HTTP requests

Returns the stored cookies as-is. For sharded cookies, each entry includes the full cookie name with its -{N} suffix (e.g., AWSELBAuthSessionCookie-0).

pub async fn get_cookies( &self, domain: String, ) -> Result<Vec<AcquiredCookie>, AcquireCookieError>

Returns cookies to include in HTTP requests. For sharded cookies, each entry includes the full cookie name with its -{N} suffix (e.g., AWSELBAuthSessionCookie-0).

• If the configuration is not found or is Direct, returns an empty vector.
• If the configuration is SsoCookieVendor but has no acquired cookies, it will acquire them using the platform API and return the acquired cookies.

pub async fn set_communication_type( &self, domain: String, request: SetCommunicationTypeRequest, ) -> Result<(), R::SaveError>

👎Deprecated: Use set_communication_type_v2() instead, which extracts the domain from the config

Sets the server communication configuration for a domain

This method saves the provided communication configuration to the repository. Typically called when receiving the /api/config response from the server.

The request type intentionally excludes cookie_value, since cookies are managed separately via Self::acquire_cookie. Any previously acquired cookies stored in the repository are preserved across calls to this method.

Arguments

• domain - The server domain (e.g., “vault.acme.com”)
• request - The server communication configuration to store

Errors

Returns an error if the repository save operation fails

pub async fn set_communication_type_v2( &self, request: SetCommunicationTypeRequest, ) -> Result<(), R::SaveError>

Sets the server communication configuration using the domain from the config itself

Extracts the cookie_domain from the SsoCookieVendor config and uses it as the storage key. If the config is Direct, the call is silently ignored.

Typically called when receiving the /api/config response from the server.

Arguments

• config - The server communication configuration to store

Errors

Returns an error if the repository save operation fails

pub async fn acquire_cookie( &self, domain: &str, ) -> Result<Vec<AcquiredCookie>, AcquireCookieError>

Acquires a cookie from the platform and saves it to the repository

This method calls the platform API to trigger cookie acquisition (e.g., browser redirect to IdP), then validates and stores the acquired cookie in the repository.

Arguments

• domain - The server domain (e.g., “vault.acme.com”)

Errors

Returns an error if:

• Cookie acquisition was cancelled by the user (AcquireCookieError::Cancelled)
• Server configuration doesn’t support SSO cookies (AcquireCookieError::UnsupportedConfiguration)
• Acquired cookie name doesn’t match expected name (AcquireCookieError::CookieNameMismatch)
• Repository operations fail (AcquireCookieError::RepositoryGetError or AcquireCookieError::RepositorySaveError)

Trait Implementations

impl<R, P> CookieProvider for ServerCommunicationConfigClient<R, P>

where R: ServerCommunicationConfigRepository + Send + 'static, P: ServerCommunicationConfigPlatformApi + Send + 'static,

fn cookies<'life0, 'life1, 'async_trait>( &'life0 self, hostname: &'life1 str, ) -> Pin<Box<dyn Future<Output = Vec<(String, String)>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Returns stored cookies for the given hostname as name-value pairs.

fn acquire_cookie<'life0, 'life1, 'async_trait>( &'life0 self, hostname: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<(), AcquireCookieError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Acquires a fresh cookie from the platform and stores it for the given hostname.

fn needs_bootstrap<'life0, 'life1, 'async_trait>( &'life0 self, hostname: &'life1 str, ) -> Pin<Box<dyn Future<Output = bool> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Returns true if the hostname requires SSO cookie bootstrapping.