grpc::AuthContext Class Reference

Class encapsulating the Authentication Information. More...

#include <auth_context.h>

Public Member Functions
virtual	~AuthContext ()
virtual bool	IsPeerAuthenticated () const =0
	Returns true if the peer is authenticated. More...
virtual std::vector< grpc::string_ref >	GetPeerIdentity () const =0
	A peer identity. More...
virtual grpc::string	GetPeerIdentityPropertyName () const =0
virtual std::vector< grpc::string_ref >	FindPropertyValues (const grpc::string &name) const =0
	Returns all the property values with the given name. More...
virtual AuthPropertyIterator	begin () const =0
	Iteration over all the properties. More...
virtual AuthPropertyIterator	end () const =0
virtual void	AddProperty (const grpc::string &key, const string_ref &value)=0
	Mutation functions: should only be used by an AuthMetadataProcessor. More...
virtual bool	SetPeerIdentityPropertyName (const string &name)=0

Detailed Description

Class encapsulating the Authentication Information.

It includes the secure identity of the peer, the type of secure transport used as well as any other properties required by the authorization layer.

Constructor & Destructor Documentation

~AuthContext()

virtual grpc::AuthContext::~AuthContext ( )

inlinevirtual

Member Function Documentation

AddProperty()

virtual void grpc::AuthContext::AddProperty ( const grpc::string &  key, const string_ref &  value  )

pure virtual

Mutation functions: should only be used by an AuthMetadataProcessor.

begin()

virtual AuthPropertyIterator grpc::AuthContext::begin ( ) const

pure virtual

Iteration over all the properties.

end()

virtual AuthPropertyIterator grpc::AuthContext::end ( ) const

pure virtual

FindPropertyValues()

virtual std::vector<grpc::string_ref> grpc::AuthContext::FindPropertyValues ( const grpc::string &  name ) const

pure virtual

Returns all the property values with the given name.

GetPeerIdentity()

virtual std::vector<grpc::string_ref> grpc::AuthContext::GetPeerIdentity ( ) const

pure virtual

A peer identity.

It is, in general, comprised of one or more properties (in which case they have the same name).

GetPeerIdentityPropertyName()

virtual grpc::string grpc::AuthContext::GetPeerIdentityPropertyName ( ) const

pure virtual

IsPeerAuthenticated()

virtual bool grpc::AuthContext::IsPeerAuthenticated ( ) const

pure virtual

Returns true if the peer is authenticated.

SetPeerIdentityPropertyName()

virtual bool grpc::AuthContext::SetPeerIdentityPropertyName ( const string &  name )

pure virtual

---

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

• include/grpcpp/impl/codegen/security/auth_context.h