<pre>.. highlight:: none

D-Bus Interface: Cached Objects
===============================

Related ticket(s):

-  `https://pagure.io/SSSD/sssd/issue/2338 &lt;https://pagure.io/SSSD/sssd/issue/2338&gt;`__

Related design page(s):

- `DBus Responder &lt;https://docs.pagure.org/SSSD.sssd/design_pages/dbus_responder.html&gt;`__

Problem statement
-----------------

This design document describes how objects can be marked as cached.

Use cases
---------

-  Allow tools like graphical user management to display a list of users
   who recently logged in.

D-Bus Interface
---------------

org.freedesktop.sssd.infopipe.Cache
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Object paths implementing this interface
&#34;&#34;&#34;&#34;&#34;&#34;&#34;&#34;&#34;&#34;&#34;&#34;&#34;&#34;&#34;&#34;&#34;&#34;&#34;&#34;&#34;&#34;&#34;&#34;&#34;&#34;&#34;&#34;&#34;&#34;&#34;&#34;&#34;&#34;&#34;&#34;&#34;&#34;&#34;&#34;

-  /org/freedesktop/sssd/infopipe/Users
-  /org/freedesktop/sssd/infopipe/Groups

Methods
&#34;&#34;&#34;&#34;&#34;&#34;&#34;

-  ao List()
-  ao ListByDomain(s:domain\_name)

   -  Returns list of objects that contains *cached* attribute.

Signals
&#34;&#34;&#34;&#34;&#34;&#34;&#34;

None.

Properties
&#34;&#34;&#34;&#34;&#34;&#34;&#34;&#34;&#34;&#34;

None.

org.freedesktop.sssd.infopipe.Cache.Object
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Object paths implementing this interface
&#34;&#34;&#34;&#34;&#34;&#34;&#34;&#34;&#34;&#34;&#34;&#34;&#34;&#34;&#34;&#34;&#34;&#34;&#34;&#34;&#34;&#34;&#34;&#34;&#34;&#34;&#34;&#34;&#34;&#34;&#34;&#34;&#34;&#34;&#34;&#34;&#34;&#34;&#34;&#34;

-  /org/freedesktop/sssd/infopipe/Users/\*
-  /org/freedesktop/sssd/infopipe/Groups/\*

Methods
&#34;&#34;&#34;&#34;&#34;&#34;&#34;

-  b Store()
-  b Remove()

   -  Those methods will add/remove *cached* attributed to the object
      under *path* implementing this interface.

Signals
&#34;&#34;&#34;&#34;&#34;&#34;&#34;

None.

Properties
&#34;&#34;&#34;&#34;&#34;&#34;&#34;&#34;&#34;&#34;

None.

Overview of the solution
------------------------

New sysdb attribute *ifp\_cached* is created for users and groups
objects. If this attribute is present, the object is considered to be
cached on IFP D-Bus. The introspection of an object path */obj/path*
will report all cached objects in the subtree */obj/path/\**.

How To Test
-----------

Call the D-Bus methods and properties. For example with **dbus-send**
tool. A cached object is supposed to appear in introspection.

Authors
-------

-  Jakub Hrozek &lt;`jhrozek@redhat.com &lt;mailto:jhrozek@redhat.com&gt;`__&gt;
-  Pavel Březina &lt;`pbrezina@redhat.com &lt;mailto:pbrezina@redhat.com&gt;`__&gt;
</pre>