Class Schema

java.lang.Object
org.javagi.base.ProxyInstance
org.gnome.secret.Schema
All Implemented Interfaces:
Proxy
@Generated("org.javagi.JavaGI") public class Schema extends ProxyInstance

Represents a set of attributes that are stored with an item.

These schemas are used for interoperability between various services storing the same types of items.

Each schema has a name like org.gnome.keyring.NetworkPassword, and defines a set of attributes, and types (string, integer, boolean) for those attributes.

Attributes are stored as strings in the Secret Service, and the attribute types simply define standard ways to store integer and boolean values as strings. Attributes are represented in libsecret via a GLib.HashTable with string keys and values. Even for values that defined as an integer or boolean in the schema, the attribute values in the GLib.HashTable are strings. Boolean values are stored as the strings 'true' and 'false'. Integer values are stored in decimal, with a preceding negative sign for negative integers.

Schemas are handled entirely on the client side by this library. The name of the schema is automatically stored as an attribute on the item.

Normally when looking up passwords only those with matching schema names are returned. If the schema flags contain the SECRET_SCHEMA_DONT_MATCH_NAME flag, then lookups will not check that the schema name matches that on the item, only the schema's attributes are matched. This is useful when you are looking up items that are not stored by the libsecret library. Other libraries such as libgnome-keyring don't store the schema name.

Additional schemas can be defined via the Schema structure like this:

// in a header:

const SecretSchema * example_get_schema (void) G_GNUC_CONST;

#define EXAMPLE_SCHEMA  example_get_schema ()


// in a .c file

const SecretSchema *
example_get_schema (void)
{
    static const SecretSchema the_schema = {
        "org.example.Password", SECRET_SCHEMA_NONE,
        {
            {  "number", SECRET_SCHEMA_ATTRIBUTE_INTEGER },
            {  "string", SECRET_SCHEMA_ATTRIBUTE_STRING },
            {  "even", SECRET_SCHEMA_ATTRIBUTE_BOOLEAN },
            {  NULL, 0 },
        }
    };
    return &the_schema;
}

  • Constructor Details

    • Schema

      public Schema(MemorySegment address)
      Create a Schema proxy instance for the provided memory address.
      Parameters:
      address - the memory address of the native object

    • Schema

      public Schema(String name, Set<SchemaFlags> flags, HashTable<String, SchemaAttributeType> attributeNamesAndTypes)

      Using this function is not normally necessary from C code. This is useful for constructing SecretSchema structures in bindings.

      A schema represents a set of attributes that are stored with an item. These schemas are used for interoperability between various services storing the same types of items.

      Each schema has an name like org.gnome.keyring.NetworkPassword, and defines a set of attributes names, and types (string, integer, boolean) for those attributes.

      Each key in the attributes table should be a attribute name strings, and the values in the table should be integers from the SchemaAttributeType enumeration, representing the attribute type for each attribute name.

      Normally when looking up passwords only those with matching schema names are returned. If the schema flags contain the SchemaFlags.DONT_MATCH_NAME flag, then lookups will not check that the schema name matches that on the item, only the schema's attributes are matched. This is useful when you are looking up items that are not stored by the libsecret library. Other libraries such as libgnome-keyring don't store the schema name.

      Parameters:
      name - the dotted name of the schema
      flags - the flags for the schema
      attributeNamesAndTypes - the attribute names and types of those attributes

    • Schema

      public Schema(String name, SchemaFlags flags, HashTable<String, SchemaAttributeType> attributeNamesAndTypes)

      Using this function is not normally necessary from C code. This is useful for constructing SecretSchema structures in bindings.

      A schema represents a set of attributes that are stored with an item. These schemas are used for interoperability between various services storing the same types of items.

      Each schema has an name like org.gnome.keyring.NetworkPassword, and defines a set of attributes names, and types (string, integer, boolean) for those attributes.

      Each key in the attributes table should be a attribute name strings, and the values in the table should be integers from the SchemaAttributeType enumeration, representing the attribute type for each attribute name.

      Normally when looking up passwords only those with matching schema names are returned. If the schema flags contain the SchemaFlags.DONT_MATCH_NAME flag, then lookups will not check that the schema name matches that on the item, only the schema's attributes are matched. This is useful when you are looking up items that are not stored by the libsecret library. Other libraries such as libgnome-keyring don't store the schema name.

      Parameters:
      name - the dotted name of the schema
      flags - the flags for the schema
      attributeNamesAndTypes - the attribute names and types of those attributes

  • Method Details

    • getType

      public static @Nullable Type getType()
      Get the GType of the Schema class.
      Returns:
      the GType

    • getMemoryLayout

      public static MemoryLayout getMemoryLayout()
      The memory layout of the native struct.
      Returns:
      the memory layout

    • readName

      public String readName()
      Read the value of the field name.
      Returns:
      The value of the field name

    • writeName

      public void writeName(String name, Arena _arena)
      Write a value in the field name.
      Parameters:
      name - The new value for the field name
      _arena - to control the memory allocation scope

    • readFlags

      public Set<SchemaFlags> readFlags()
      Read the value of the field flags.
      Returns:
      The value of the field flags

    • writeFlags

      public void writeFlags(Set<SchemaFlags> flags)
      Write a value in the field flags.
      Parameters:
      flags - The new value for the field flags

    • readAttributes

      public @Nullable SchemaAttribute @Nullable [] readAttributes()
      Read the value of the field attributes.
      Returns:
      The value of the field attributes

    • writeAttributes

      public void writeAttributes(@Nullable SchemaAttribute @Nullable [] attributes, Arena _arena)
      Write a value in the field attributes.
      Parameters:
      attributes - The new value for the field attributes

    • ref

      public Schema ref()

      Adds a reference to the SecretSchema.

      It is not normally necessary to call this function from C code, and is mainly present for the sake of bindings. If the this Schema was statically allocated, then this function will copy the schema.

      Returns:
      the referenced schema, which should be later unreferenced with unref()

    • unref

      public void unref()

      Releases a reference to the SecretSchema.

      If the last reference is released then the schema will be freed.

      It is not normally necessary to call this function from C code, and is mainly present for the sake of bindings. It is an error to call this for a this Schema that was statically allocated.