Glacier2::PermissionsVerifier Class Reference

The Glacier2 permissions verifier. More...

#include <Glacier2/Glacier2.h>

Inheritance diagram for Glacier2::PermissionsVerifier:

Collaboration diagram for Glacier2::PermissionsVerifier:

Classes
struct	CheckPermissionsResult
	Encapsulates the results of a call to checkPermissions. More...

Public Types
using	ProxyType = PermissionsVerifierPrx

Public Member Functions
virtual bool	checkPermissions (::std::string userId, ::std::string password, ::std::string &reason, const ::Ice::Current &current) const =0
	Check whether a user has permission to access the router. More...
virtual ::std::string	ice_id (const ::Ice::Current &current) const override
	Obtains a Slice type ID representing the most-derived interface supported by this object. More...
virtual ::std::vector<::std::string >	ice_ids (const ::Ice::Current &current) const override
	Obtains a list of the Slice type IDs representing the interfaces supported by this object. More...
virtual bool	ice_isA (::std::string id, const ::Ice::Current &current) const override
	Determines whether this object supports an interface with the given Slice type ID. More...
Public Member Functions inherited from Ice::Object
virtual bool	ice_dispatch (Ice::Request &request, std::function< bool()> response=nullptr, std::function< bool(std::exception_ptr)> error=nullptr)
	Dispatches an invocation to a servant. More...
virtual std::string	ice_id (const Current &current) const
	Returns the Slice type ID of the most-derived interface supported by this object. More...
virtual std::vector< std::string >	ice_ids (const Current &current) const
	Returns the Slice type IDs of the interfaces supported by this object. More...
virtual bool	ice_isA (std::string s, const Current &current) const
	Tests whether this object supports a specific Slice interface. More...
virtual void	ice_ping (const Current &current) const
	Tests whether this object can be reached. More...
virtual	~Object ()=default

Static Public Member Functions
static const ::std::string &	ice_staticId ()
	Obtains the Slice type ID corresponding to this class. More...
Static Public Member Functions inherited from Ice::Object
static const std::string &	ice_staticId ()
	Obtains the Slice type ID of this type. More...

Detailed Description

The Glacier2 permissions verifier.

This is called through the process of establishing a session.

See also

Router

Member Typedef Documentation

ProxyType

using Glacier2::PermissionsVerifier::ProxyType = PermissionsVerifierPrx

Member Function Documentation

checkPermissions()

virtual bool Glacier2::PermissionsVerifier::checkPermissions ( ::std::string  userId, ::std::string  password, ::std::string &  reason, const ::Ice::Current &  current  ) const

pure virtual

Check whether a user has permission to access the router.

Parameters

userId	The user id for which to check permission.
password	The user's password.
reason	The reason why access was denied.
current	The Current object for the invocation.

Returns

True if access is granted, or false otherwise.

Exceptions

Glacier2::PermissionDeniedException

Raised if the user access is denied. This can be raised in place of returning false with a reason set in the reason out parameter.

ice_id()

virtual ::std::string Glacier2::PermissionsVerifier::ice_id ( const ::Ice::Current &  current ) const

override

Obtains a Slice type ID representing the most-derived interface supported by this object.

Parameters

current

The Current object for the invocation.

Returns

A fully-scoped type ID.

ice_ids()

virtual ::std::vector<::std::string> Glacier2::PermissionsVerifier::ice_ids ( const ::Ice::Current &  current ) const

override

Obtains a list of the Slice type IDs representing the interfaces supported by this object.

Parameters

current

The Current object for the invocation.

Returns

A list of fully-scoped type IDs.

ice_isA()

virtual bool Glacier2::PermissionsVerifier::ice_isA ( ::std::string  id, const ::Ice::Current &  current  ) const

overridevirtual

Determines whether this object supports an interface with the given Slice type ID.

Parameters

id	The fully-scoped Slice type ID.
current	The Current object for the invocation.

Returns

True if this object supports the interface, false, otherwise.

ice_staticId()

static const ::std::string& Glacier2::PermissionsVerifier::ice_staticId ( )

static

Obtains the Slice type ID corresponding to this class.

Returns

A fully-scoped type ID.

---

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

• generated/cpp11/x64/Release/Glacier2/PermissionsVerifier.h