Ice 3.7 Slice API Reference
All Classes Interfaces Structs Exceptions Modules Files Operations Constants Sequences Dictionaries Enumerations Enumerator Pages
Operations | List of all members
Glacier2::PermissionsVerifier Interface Reference

The Glacier2 permissions verifier. More...

defined in <Glacier2/PermissionsVerifier.ice>

interface PermissionsVerifier { ... }

Operations

idempotent bool checkPermissions (string userId, string password, out string reason) throws PermissionDeniedException
 Check whether a user has permission to access the router. More...
 

Detailed Description

The Glacier2 permissions verifier.

This is called through the process of establishing a session.

See also
Router

Operation Documentation

◆ checkPermissions()

["nonmutating","cpp:const","format:sliced"]
idempotent bool checkPermissions ( string  userId,
string  password,
out string  reason 
) throws PermissionDeniedException

Check whether a user has permission to access the router.

Parameters
userIdThe user id for which to check permission.
passwordThe user's password.
reasonThe reason why access was denied.
Returns
True if access is granted, or false otherwise.
Exceptions
PermissionDeniedExceptionRaised if the user access is denied. This can be raised in place of returning false with a reason set in the reason out parameter.

The documentation for this interface was generated from the following file: