[SSSD] Design Discussion: D-Bus responder

Jakub Hrozek jhrozek at redhat.com
Mon Feb 24 12:17:16 UTC 2014


On Mon, Feb 24, 2014 at 12:32:04PM +0100, Pavel Březina wrote:
> https://fedorahosted.org/sssd/wiki/DesignDocs/DBusResponder
> 
> Hi,
> I couldn't find the original thread so I'm starting a new one.

The design was reviewed in a private thread mostly as the API evolved
organically from a proof of concept. You're right we should have followed
up on the devel list.

> I would
> like us to agree on best practice of naming methods. The current design
> is somewhat inconsistent, since it uses e.g. FindUserByName(name) and
> GetDomain(name) for obtaining one object path by name.
> 
> I'm proposing the following convention:
> * List<class>() returning array of object paths, no arguments
>   - ListUsers
>   - ListDomains
> * Find<class><condition>(arg1, ...) returning array of object paths
>   - FindUsersByName(filter)
>   - FindGroupsByName(filter)
> * Get<class><condition>(arg1, ...) returning single object path
>   - GetUserById(id)
>   - GetDomainByName(name)

FWIW, I modeled the API based on the existing AccountsService API and
Nalin's subsequent redesign document. I agree that more consistent API
would be good, but I would prefer to always use Find everywhere to avoid
clashing with Get/GetAll from DBus.Properties.



More information about the sssd-devel mailing list