Class

FoundryKeyRotator

unstable since: 1.1

Description [src]

abstract class Foundry.KeyRotator : Foundry.Contextual
  implements Json.Serializable {
  /* No available fields */
}

Abstract base class for rotating API keys.

FoundryKeyRotator provides an interface for rotating API keys associated with a host and service name. Subclasses implement the actual rotation logic for specific services or providers.

Available since: 1.1

Hierarchy

hierarchy this FoundryKeyRotator implements_0 JsonSerializable this--implements_0 ancestor_0 FoundryContextual ancestor_0--this ancestor_1 GObject ancestor_1--ancestor_0

Implements

Instance methods

foundry_key_rotator_can_rotate

Checks if the key rotator can rotate the API key for the given host and service name.

unstable since: 1.1

foundry_key_rotator_check_expires_at

Checks when the key expires by querying the service.

unstable since: 1.1

foundry_key_rotator_rotate

Rotates the API key for the given host and service name.

unstable since: 1.1

Methods inherited from FoundryContextual (4)
foundry_contextual_acquire

This method provides a checked way to get a context for the contextual.

unstable since: 1.1

foundry_contextual_dup_context

Gets the FoundryContext that self is a part of while safely increasing the reference count of the resulting FoundryContext by 1.

foundry_contextual_inhibit

Creates a new FoundryInhibitor that will keep the FoundryContext alive and prevent shutdown until foundry_inhibitor_uninhibit() is called or the FoundryInhibitor is finalized, whichever comes first.

foundry_contextual_log
No description available.

Methods inherited from GObject (43)

Please see GObject for a full list of methods.

Methods inherited from JsonSerializable (8)
json_serializable_default_deserialize_property

Calls the default implementation of the Json.SerializableIface.deserialize_property virtual function.

json_serializable_default_serialize_property

Calls the default implementation of the Json.SerializableIface.serialize_property virtual function.

json_serializable_deserialize_property

Asks a JsonSerializable implementation to deserialize the property contained inside property_node and place its value into value.

json_serializable_find_property

Calls the Json.SerializableIface.find_property implementation on the JsonSerializable instance, which will return the property description for the given name.

json_serializable_get_property

Calls the Json.SerializableIface.get_property implementation on the JsonSerializable instance, which will get the value of the given property.

json_serializable_list_properties

Calls the Json.SerializableIface.list_properties implementation on the JsonSerializable instance, which will return the list of serializable properties.

json_serializable_serialize_property

Asks a JsonSerializable implementation to serialize an object property into a JSON node.

json_serializable_set_property

Calls the Json.SerializableIface.set_property implementation on the JsonSerializable instance, which will set the property with the given value.

Properties

Properties inherited from FoundryContextual (1)
Foundry.Contextual:context
No description available.

Signals

Signals inherited from GObject (1)
GObject::notify

The notify signal is emitted on an object when one of its properties has its value set through g_object_set_property(), g_object_set(), et al.

Class structure

struct FoundryKeyRotatorClass {
  FoundryContextualClass parent_class;
  DexFuture* (* check_expires_at) (
    FoundryKeyRotator* self,
    const char* host,
    const char* service_name,
    const char* secret
  );
  gboolean (* can_rotate) (
    FoundryKeyRotator* self,
    const char* host,
    const char* service_name,
    const char* secret
  );
  DexFuture* (* rotate) (
    FoundryKeyRotator* self,
    const char* host,
    const char* service_name,
    const char* secret,
    GDateTime* expire_at
  );
  
}

No description available.

Class members
parent_class: FoundryContextualClass

No description available.

check_expires_at: DexFuture* (* check_expires_at) ( FoundryKeyRotator* self, const char* host, const char* service_name, const char* secret )

No description available.

can_rotate: gboolean (* can_rotate) ( FoundryKeyRotator* self, const char* host, const char* service_name, const char* secret )

No description available.

rotate: DexFuture* (* rotate) ( FoundryKeyRotator* self, const char* host, const char* service_name, const char* secret, GDateTime* expire_at )

No description available.

Virtual methods

Foundry.KeyRotatorClass.can_rotate

Checks if the key rotator can rotate the API key for the given host and service name.

unstable since: 1.1

Foundry.KeyRotatorClass.check_expires_at

Checks when the key expires by querying the service.

unstable since: 1.1

Foundry.KeyRotatorClass.rotate

Rotates the API key for the given host and service name.

unstable since: 1.1