grpc::AuthContext Class Reference

#include <auth_context.h>

Inheritance diagram for grpc::AuthContext:

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

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.

Definition at line 72 of file grpcpp/impl/codegen/security/auth_context.h.

Constructor & Destructor Documentation

~AuthContext()

virtual grpc::AuthContext::~AuthContext ( )

inlinevirtual

Definition at line 74 of file grpcpp/impl/codegen/security/auth_context.h.

Member Function Documentation

AddProperty()

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

pure virtual

Mutation functions: should only be used by an AuthMetadataProcessor.

Implemented in grpc::SecureAuthContext.

begin()

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

pure virtual

Iteration over all the properties.

Implemented in grpc::SecureAuthContext.

end()

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

pure virtual

Implemented in grpc::SecureAuthContext.

FindPropertyValues()

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

pure virtual

Returns all the property values with the given name.

Implemented in grpc::SecureAuthContext.

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).

Implemented in grpc::SecureAuthContext.

GetPeerIdentityPropertyName()

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

pure virtual

Implemented in grpc::SecureAuthContext.

IsPeerAuthenticated()

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

pure virtual

Returns true if the peer is authenticated.

Implemented in grpc::SecureAuthContext.

SetPeerIdentityPropertyName()

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

pure virtual

Implemented in grpc::SecureAuthContext.

---

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

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