irods  4.2.8
About: iRODS (the integrated Rule Oriented Data System) is a distributed data-management system for creating data grids, digital libraries, persistent archives, and real-time data systems.
  Fossies Dox: irods-4.2.8.tar.gz  ("unofficial" and yet experimental doxygen-generated source code documentation)  

irods::auth_object Class Referenceabstract

#include <irods_auth_object.hpp>

Inheritance diagram for irods::auth_object:
[legend]
Collaboration diagram for irods::auth_object:
[legend]

Public Member Functions

 auth_object (rError_t *_r_error)
 
 auth_object (const auth_object &)
 
virtual ~auth_object ()
 
virtual auth_objectoperator= (const auth_object &_rhs)
 
virtual rError_tr_error (void) const
 
virtual std::string request_result () const
 
virtual void request_result (const std::string &_r)
 
virtual std::string context () const
 
virtual void context (const std::string &_c)
 
virtual std::string user_name () const
 
virtual std::string zone_name () const
 
virtual void user_name (const std::string &_un)
 
virtual void zone_name (const std::string &_zn)
 
virtual bool operator== (const auth_object &_rhs) const
 
virtual error resolve (const std::string &_plugin_name, plugin_ptr &_plugin)=0
 
virtual error get_re_vars (rule_engine_vars_t &)=0
 
- Public Member Functions inherited from irods::first_class_object
 first_class_object ()
 
virtual ~first_class_object ()
 

Protected Attributes

rError_tr_error_
 
std::string request_result_
 =-=-=-=-=-=-=- More...
 
std::string user_name_
 
std::string zone_name_
 
std::string context_
 

Detailed Description

Description:\n Class for representing authorization scheme objects

Definition at line 16 of file irods_auth_object.hpp.

Constructor & Destructor Documentation

◆ auth_object() [1/2]

irods::auth_object::auth_object ( rError_t _r_error)
Description:\n Ctor

Definition at line 5 of file irods_auth_object.cpp.

◆ auth_object() [2/2]

irods::auth_object::auth_object ( const auth_object _rhs)

Definition at line 14 of file irods_auth_object.cpp.

References context(), context_, r_error(), r_error_, request_result(), and request_result_.

Here is the call graph for this function:

◆ ~auth_object()

irods::auth_object::~auth_object ( )
virtual

Definition at line 10 of file irods_auth_object.cpp.

Member Function Documentation

◆ context() [1/2]

virtual std::string irods::auth_object::context ( ) const
inlinevirtual

◆ context() [2/2]

virtual void irods::auth_object::context ( const std::string &  _c)
inlinevirtual

Definition at line 39 of file irods_auth_object.hpp.

References context_.

◆ get_re_vars()

◆ operator=()

auth_object & irods::auth_object::operator= ( const auth_object _rhs)
virtual
Description:\n assignment operator

Definition at line 22 of file irods_auth_object.cpp.

References context(), context_, r_error(), r_error_, request_result(), and request_result_.

Referenced by irods::native_auth_object::operator=(), irods::osauth_auth_object::operator=(), and irods::pam_auth_object::operator=().

Here is the call graph for this function:

◆ operator==()

bool irods::auth_object::operator== ( const auth_object _rhs) const
virtual
Description:\n Comparison operator

Definition at line 30 of file irods_auth_object.cpp.

References context(), context_, r_error(), r_error_, request_result(), and request_result_.

Here is the call graph for this function:

◆ r_error()

virtual rError_t* irods::auth_object::r_error ( void  ) const
inlinevirtual
Description:\n Accessor for the rError pointer

Definition at line 27 of file irods_auth_object.hpp.

References r_error_.

Referenced by auth_object(), operator=(), and operator==().

◆ request_result() [1/2]

virtual std::string irods::auth_object::request_result ( ) const
inlinevirtual

Definition at line 30 of file irods_auth_object.hpp.

References request_result_.

Referenced by auth_object(), operator=(), operator==(), and osauth_auth_client_request().

◆ request_result() [2/2]

virtual void irods::auth_object::request_result ( const std::string &  _r)
inlinevirtual

Definition at line 33 of file irods_auth_object.hpp.

References request_result_.

◆ resolve()

virtual error irods::auth_object::resolve ( const std::string &  _plugin_name,
plugin_ptr _plugin 
)
pure virtual

◆ user_name() [1/2]

virtual std::string irods::auth_object::user_name ( ) const
inlinevirtual

Reimplemented in irods::osauth_auth_object.

Definition at line 42 of file irods_auth_object.hpp.

References user_name_.

◆ user_name() [2/2]

virtual void irods::auth_object::user_name ( const std::string &  _un)
inlinevirtual

Reimplemented in irods::osauth_auth_object.

Definition at line 48 of file irods_auth_object.hpp.

References user_name_.

◆ zone_name() [1/2]

virtual std::string irods::auth_object::zone_name ( ) const
inlinevirtual

Reimplemented in irods::osauth_auth_object.

Definition at line 45 of file irods_auth_object.hpp.

References zone_name_.

◆ zone_name() [2/2]

virtual void irods::auth_object::zone_name ( const std::string &  _zn)
inlinevirtual

Reimplemented in irods::osauth_auth_object.

Definition at line 51 of file irods_auth_object.hpp.

References zone_name_.

Member Data Documentation

◆ context_

std::string irods::auth_object::context_
protected

=-=-=-=-=-=-=-

Description:\n context string which might hold anything
coming from a client call

Definition at line 82 of file irods_auth_object.hpp.

Referenced by auth_object(), context(), operator=(), operator==(), and irods::pam_auth_object::pam_auth_object().

◆ r_error_

rError_t* irods::auth_object::r_error_
protected

Definition at line 63 of file irods_auth_object.hpp.

Referenced by auth_object(), operator=(), operator==(), and r_error().

◆ request_result_

std::string irods::auth_object::request_result_
protected

=-=-=-=-=-=-=-

Definition at line 69 of file irods_auth_object.hpp.

Referenced by auth_object(), operator=(), operator==(), and request_result().

◆ user_name_

◆ zone_name_


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