Poco::OSP::Auth

class PooledAuthAdminService

File Information

Library: OSP/Auth
Package: Auth
Header: Poco/OSP/Auth/PooledAuthAdminService.h

Description

This class implements the AuthAdminService interface in such a way that all methods are forwarded to one of multiple other AuthAdminService instances.

This can be used in systems with a large number of concurrent users to prevent a single AuthAdminService instance from becoming a bottleneck.

In order to improve caching behavior, requests for a specific user are always forwarded to the same backend.

Inheritance

Direct Base Classes: AuthAdminService

All Base Classes: AuthAdminService, AuthService, Poco::OSP::Service, Poco::RefCountedObject

Member Summary

Member Functions: addRole, addUser, any, assignRoleToUser, attributesForUser, authenticate, authorize, changePassword, effectivePermissionsForUser, findUsersByAttribute, forUser, getUserAttribute, grantPermissionsToRole, grantPermissionsToUser, invalidateCaches, isA, isExternalUser, isUserLockedOut, lockOutUser, onRoleAdded, onRoleRemoved, onUserAdded, onUserRemoved, onValidateUser, permissionsForRole, permissionsForUser, removeRole, removeRoleFromUser, removeUser, removeUserAttribute, replacePermissionsForRole, replacePermissionsForUser, replaceRolesForUser, replaceUserAttributes, reset, revokePermission, revokePermissionsFromRole, revokePermissionsFromUser, roleExists, roles, rolesForUser, setUserAttribute, type, uncacheUser, unlockOutUser, updateUserAttributes, userEnabled, userExists, users, usersWithAttribute, usersWithName, usersWithPermission, usersWithRole

Inherited Functions: addRole, addUser, assignRoleToUser, attributesForUser, authenticate, authorize, changePassword, duplicate, effectivePermissionsForUser, findUsersByAttribute, getUserAttribute, grantPermissionsToRole, grantPermissionsToUser, invalidateCaches, isA, isExternalUser, isUserLockedOut, lockOutUser, permissionsForRole, permissionsForUser, referenceCount, release, removeRole, removeRoleFromUser, removeUser, removeUserAttribute, replacePermissionsForRole, replacePermissionsForUser, replaceRolesForUser, replaceUserAttributes, reset, revokePermission, revokePermissionsFromRole, revokePermissionsFromUser, roleExists, roles, rolesForUser, setUserAttribute, type, uncacheUser, unlockOutUser, updateUserAttributes, userEnabled, userExists, users, usersWithAttribute, usersWithName, usersWithPermission, usersWithRole

Types Aliases

Ptr

using Ptr = Poco::AutoPtr < PooledAuthAdminService >;

Constructors

PooledAuthAdminService

explicit PooledAuthAdminService(
    const std::vector < AuthAdminService::Ptr > & backends
);

Creates the PooledAuthAdminService with the given backends. The vector must not be empty.

Destructor

~PooledAuthAdminService virtual

~PooledAuthAdminService();

Destroys the AuthAdminServiceImpl.

Member Functions

addRole virtual

void addRole(
    const std::string & rolename
);

See also: Poco::OSP::Auth::AuthAdminService::addRole()

addUser virtual

void addUser(
    const std::string & username,
    const std::string & password
);

See also: Poco::OSP::Auth::AuthAdminService::addUser()

assignRoleToUser virtual

void assignRoleToUser(
    const std::string & username,
    const std::string & rolename
);

See also: Poco::OSP::Auth::AuthAdminService::assignRoleToUser()

attributesForUser virtual

void attributesForUser(
    const std::string & username,
    std::set < std::string > & attributes
) const;

See also: Poco::OSP::Auth::AuthAdminService::attributesForUser()

attributesForUser virtual

void attributesForUser(
    const std::string & username,
    std::map < std::string, std::string > & attributes
) const;

See also: Poco::OSP::Auth::AuthAdminService::attributesForUser()

authenticate virtual

bool authenticate(
    const std::string & username,
    const std::string & credentials
) const;

See also: Poco::OSP::Auth::AuthService::authenticate()

authorize virtual

bool authorize(
    const std::string & username,
    const std::string & permission
) const;

See also: Poco::OSP::Auth::AuthService::authorize()

authorize virtual

bool authorize(
    const std::string & userName,
    const std::string & roleOrScope,
    const std::string & permission
) const;

See also: Poco::OSP::Auth::AuthService::authorize()

changePassword virtual

void changePassword(
    const std::string & username,
    const std::string & password
);

See also: Poco::OSP::Auth::AuthAdminService::changePassword()

effectivePermissionsForUser virtual

void effectivePermissionsForUser(
    const std::string & username,
    std::set < std::string > & permissions
) const;

See also: Poco::OSP::Auth::AuthAdminService::effectivePermissionsForUser()

findUsersByAttribute virtual

std::vector < std::string > findUsersByAttribute(
    const std::string & attribute,
    const std::string & value
) const;

See also: Poco::OSP::Auth::AuthAdminService::findUsersByAttribute()

getUserAttribute virtual

std::string getUserAttribute(
    const std::string & username,
    const std::string & attribute,
    const std::string & deflt = std::string ()
) const;

See also: Poco::OSP::Auth::AuthAdminService::getUserAttribute()

grantPermissionsToRole virtual

void grantPermissionsToRole(
    const std::string & rolename,
    const std::set < std::string > & permissions
);

See also: Poco::OSP::Auth::AuthAdminService::grantPermissionsToRole()

grantPermissionsToUser virtual

void grantPermissionsToUser(
    const std::string & username,
    const std::set < std::string > & permissions
);

See also: Poco::OSP::Auth::AuthAdminService::grantPermissionsToUser()

invalidateCaches virtual

void invalidateCaches(
    int what = INVALIDATE_ALL
);

See also: Poco::OSP::Auth::AuthAdminService::invalidateCaches()

isA virtual

bool isA(
    const std::type_info & otherType
) const;

See also: Poco::OSP::Auth::AuthAdminService::isA()

isExternalUser virtual

bool isExternalUser(
    const std::string & username
) const;

See also: Poco::OSP::Auth::AuthAdminService::isExternalUser()

isUserLockedOut virtual

bool isUserLockedOut(
    const std::string & username
) const;

See also: Poco::OSP::Auth::AuthAdminService::isUserLockedOut()

lockOutUser virtual

void lockOutUser(
    const std::string & username,
    const Poco::DateTime & lockOutUntil
);

See also: Poco::OSP::Auth::AuthAdminService::lockOutUser()

permissionsForRole virtual

void permissionsForRole(
    const std::string & rolename,
    std::set < std::string > & permissions
) const;

See also: Poco::OSP::Auth::AuthAdminService::permissionsForRole()

permissionsForUser virtual

void permissionsForUser(
    const std::string & username,
    std::set < std::string > & permissions
) const;

See also: Poco::OSP::Auth::AuthAdminService::permissionsForUser()

removeRole virtual

void removeRole(
    const std::string & rolename
);

See also: Poco::OSP::Auth::AuthAdminService::removeRole()

removeRoleFromUser virtual

void removeRoleFromUser(
    const std::string & username,
    const std::string & rolename
);

See also: Poco::OSP::Auth::AuthAdminService::removeRoleFromUser()

removeUser virtual

void removeUser(
    const std::string & username
);

See also: Poco::OSP::Auth::AuthAdminService::removeUser()

removeUserAttribute virtual

void removeUserAttribute(
    const std::string & username,
    const std::string & attribute
);

See also: Poco::OSP::Auth::AuthAdminService::removeUserAttribute()

replacePermissionsForRole virtual

void replacePermissionsForRole(
    const std::string & rolename,
    const std::set < std::string > & permissions
);

See also: Poco::OSP::Auth::AuthAdminService::replacePermissionsForRole()

replacePermissionsForUser virtual

void replacePermissionsForUser(
    const std::string & username,
    const std::set < std::string > & permissions
);

See also: Poco::OSP::Auth::AuthAdminService::replacePermissionsForUser()

replaceRolesForUser virtual

void replaceRolesForUser(
    const std::string & username,
    const std::set < std::string > & permissions
);

See also: Poco::OSP::Auth::AuthAdminService::replaceRolesForUser()

replaceUserAttributes virtual

void replaceUserAttributes(
    const std::string & username,
    const std::map < std::string, std::string > & attributes
);

See also: Poco::OSP::Auth::AuthAdminService::replaceUserAttributes()

reset virtual

void reset();

See also: Poco::OSP::Auth::AuthAdminService::reset()

revokePermission virtual

void revokePermission(
    const std::string & permission
);

See also: Poco::OSP::Auth::AuthAdminService::revokePermission()

revokePermissionsFromRole virtual

void revokePermissionsFromRole(
    const std::string & rolename,
    const std::set < std::string > & permissions
);

See also: Poco::OSP::Auth::AuthAdminService::revokePermissionsFromRole()

revokePermissionsFromUser virtual

void revokePermissionsFromUser(
    const std::string & username,
    const std::set < std::string > & permissions
);

See also: Poco::OSP::Auth::AuthAdminService::revokePermissionsFromUser()

roleExists virtual

bool roleExists(
    const std::string & rolename
) const;

See also: Poco::OSP::Auth::AuthAdminService::roleExists()

roles virtual

void roles(
    std::set < std::string > & roles
) const;

See also: Poco::OSP::Auth::AuthAdminService::roles()

rolesForUser virtual

void rolesForUser(
    const std::string & username,
    std::set < std::string > & roles
) const;

See also: Poco::OSP::Auth::AuthAdminService::rolesForUser()

setUserAttribute virtual

void setUserAttribute(
    const std::string & username,
    const std::string & attribute,
    const std::string & value
);

See also: Poco::OSP::Auth::AuthAdminService::setUserAttribute()

type virtual

const std::type_info & type() const;

See also: Poco::OSP::Auth::AuthAdminService::type()

uncacheUser virtual

void uncacheUser(
    const std::string & username
);

See also: Poco::OSP::Auth::AuthAdminService::uncacheUser()

unlockOutUser virtual

void unlockOutUser(
    const std::string & username
);

See also: Poco::OSP::Auth::AuthAdminService::unlockOutUser()

updateUserAttributes virtual

void updateUserAttributes(
    const std::string & username,
    const std::map < std::string, std::string > & attributes
);

See also: Poco::OSP::Auth::AuthAdminService::updateUserAttributes()

userEnabled virtual

bool userEnabled(
    const std::string & username
) const;

See also: Poco::OSP::Auth::AuthAdminService::userEnabled()

userExists virtual

bool userExists(
    const std::string & username
) const;

See also: Poco::OSP::Auth::AuthService::userExists()

users virtual

int users(
    std::set < std::string > & users,
    int first = 0,
    int limit = 0
) const;

See also: Poco::OSP::Auth::AuthAdminService::users()

usersWithAttribute virtual

int usersWithAttribute(
    std::set < std::string > & users,
    const std::string & attribute,
    const std::string & value,
    int first = 0,
    int limit = 0
) const;

See also: Poco::OSP::Auth::AuthAdminService::usersWithAttribute()

usersWithName virtual

int usersWithName(
    std::set < std::string > & users,
    const std::string & pattern,
    int first = 0,
    int limit = 0
) const;

See also: Poco::OSP::Auth::AuthAdminService::usersWithName()

usersWithPermission virtual

int usersWithPermission(
    std::set < std::string > & users,
    const std::string & permission,
    int first = 0,
    int limit = 0
) const;

See also: Poco::OSP::Auth::AuthAdminService::usersWithPermission()

usersWithRole virtual

int usersWithRole(
    std::set < std::string > & users,
    const std::string & role,
    int first = 0,
    int limit = 0
) const;

See also: Poco::OSP::Auth::AuthAdminService::usersWithRole()

any protected

AuthAdminService::Ptr any() const;

forUser protected

AuthAdminService::Ptr forUser(
    const std::string & username
) const;

onRoleAdded protected

void onRoleAdded(
    const std::string & rolename
);

onRoleRemoved protected

void onRoleRemoved(
    const std::string & rolename
);

onUserAdded protected

void onUserAdded(
    const std::string & username
);

onUserRemoved protected

void onUserRemoved(
    const std::string & username
);

onValidateUser protected

void onValidateUser(
    ValidateUserEvent & event
);