An individual rule in an acl. More...

#include <zk/acl.hpp>

Public Member Functions
	acl_rule (std::string scheme, std::string id, permission permissions)
	Create an ACL under the given scheme and id with the given permissions. More...

const std::string &	scheme () const
	The authentication scheme this list is used for. More...

const std::string &	id () const
	The ID of the user under the `scheme`. More...

const permission &	permissions () const
	The permissions associated with this ACL. More...

Detailed Description

An individual rule in an acl.

It consists of a scheme and id pair to identify the who and a permission set to determine what they are allowed to do.

See also: https://zookeeper.apache.org/doc/r3.1.2/zookeeperProgrammers.html#sc_ACLPermissions

Definition at line 67 of file acl.hpp.

Constructor & Destructor Documentation

Create an ACL under the given scheme and id with the given permissions.

Definition at line 44 of file acl.cpp.

const std::string& zk::acl_rule::id ( ) const

inline

The ID of the user under the scheme.

For example, with the "ip" scheme, this is an IP address or CIDR netmask.

Definition at line 86 of file acl.hpp.

const permission& zk::acl_rule::permissions ( ) const

inline

The permissions associated with this ACL.

Definition at line 92 of file acl.hpp.

const std::string& zk::acl_rule::scheme ( ) const

inline

The authentication scheme this list is used for.

The most common scheme is "auth", which allows any authenticated user to perform actions (see acls::creator_all).

Definition at line 78 of file acl.hpp.

The documentation for this class was generated from the following files: