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::osauth_auth_object Class Reference

#include <irods_osauth_auth_object.hpp>

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

Public Member Functions

 osauth_auth_object (rError_t *_r_error)
 
 osauth_auth_object (const osauth_auth_object &)
 
virtual ~osauth_auth_object ()
 
virtual osauth_auth_objectoperator= (const osauth_auth_object &)
 
virtual bool operator== (const osauth_auth_object &) const
 
virtual error resolve (const std::string &, plugin_ptr &)
 
virtual error get_re_vars (rule_engine_vars_t &)
 
std::string user_name () const
 
std::string zone_name () const
 
std::string digest () const
 
void user_name (const std::string &_un)
 
void zone_name (const std::string &_zn)
 
void digest (const std::string &_dd)
 
- Public Member Functions inherited from irods::auth_object
 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 bool operator== (const auth_object &_rhs) const
 
- Public Member Functions inherited from irods::first_class_object
 first_class_object ()
 
virtual ~first_class_object ()
 

Private Attributes

std::string user_name_
 
std::string zone_name_
 
std::string digest_
 

Additional Inherited Members

- Protected Attributes inherited from irods::auth_object
rError_tr_error_
 
std::string request_result_
 =-=-=-=-=-=-=- More...
 
std::string user_name_
 
std::string zone_name_
 
std::string context_
 

Detailed Description

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

Description:\n object for a native irods authenticaion sceheme

Definition at line 21 of file irods_osauth_auth_object.hpp.

Constructor & Destructor Documentation

◆ osauth_auth_object() [1/2]

irods::osauth_auth_object::osauth_auth_object ( rError_t _r_error)

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

Description:\n Ctor

Definition at line 16 of file irods_osauth_auth_object.cpp.

◆ osauth_auth_object() [2/2]

irods::osauth_auth_object::osauth_auth_object ( const osauth_auth_object _rhs)

Definition at line 28 of file irods_osauth_auth_object.cpp.

References digest_, user_name_, and zone_name_.

◆ ~osauth_auth_object()

irods::osauth_auth_object::~osauth_auth_object ( )
virtual

Definition at line 23 of file irods_osauth_auth_object.cpp.

Member Function Documentation

◆ digest() [1/2]

std::string irods::osauth_auth_object::digest ( void  ) const
inline

Definition at line 55 of file irods_osauth_auth_object.hpp.

References digest_.

◆ digest() [2/2]

void irods::osauth_auth_object::digest ( const std::string &  _dd)
inline

Definition at line 67 of file irods_osauth_auth_object.hpp.

References digest_.

◆ get_re_vars()

error irods::osauth_auth_object::get_re_vars ( rule_engine_vars_t _kvp)
virtual

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

Description:\n serialize object to key-value pairs

Implements irods::auth_object.

Definition at line 114 of file irods_osauth_auth_object.cpp.

References digest_, SUCCESS, user_name_, and zone_name_.

◆ operator=()

osauth_auth_object & irods::osauth_auth_object::operator= ( const osauth_auth_object _rhs)
virtual

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

Description:\n assignment operator

Definition at line 38 of file irods_osauth_auth_object.cpp.

References digest_, irods::auth_object::operator=(), user_name_, and zone_name_.

Here is the call graph for this function:

◆ operator==()

bool irods::osauth_auth_object::operator== ( const osauth_auth_object ) const
virtual

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

Description:\n Comparison operator

Definition at line 49 of file irods_osauth_auth_object.cpp.

◆ resolve()

error irods::osauth_auth_object::resolve ( const std::string &  _interface,
plugin_ptr _ptr 
)
virtual

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

Description:\n Plugin resolution operation

Implements irods::auth_object.

Definition at line 56 of file irods_osauth_auth_object.cpp.

References irods::AUTH_INTERFACE(), irods::auth_mgr, irods::AUTH_OSAUTH_SCHEME(), ERROR, irods::auth_manager::init_from_type(), irods::error::ok(), PASS, ProcessType, irods::auth_manager::resolve(), SUCCESS, and SYS_INVALID_INPUT_PARAM.

Here is the call graph for this function:

◆ user_name() [1/2]

std::string irods::osauth_auth_object::user_name ( ) const
inlinevirtual

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

Description:\n accessors

Reimplemented from irods::auth_object.

Definition at line 49 of file irods_osauth_auth_object.hpp.

References user_name_.

Referenced by osauth_auth_client_start().

◆ user_name() [2/2]

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

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

Description:\n mutators

Reimplemented from irods::auth_object.

Definition at line 61 of file irods_osauth_auth_object.hpp.

References user_name_.

◆ zone_name() [1/2]

std::string irods::osauth_auth_object::zone_name ( ) const
inlinevirtual

Reimplemented from irods::auth_object.

Definition at line 52 of file irods_osauth_auth_object.hpp.

References zone_name_.

◆ zone_name() [2/2]

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

Reimplemented from irods::auth_object.

Definition at line 64 of file irods_osauth_auth_object.hpp.

References zone_name_.

Member Data Documentation

◆ digest_

std::string irods::osauth_auth_object::digest_
private

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

Description:\n md5 digest computed

Definition at line 82 of file irods_osauth_auth_object.hpp.

Referenced by digest(), get_re_vars(), operator=(), and osauth_auth_object().

◆ user_name_

std::string irods::osauth_auth_object::user_name_
private

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

Description:\n user name - from rcConn

Definition at line 74 of file irods_osauth_auth_object.hpp.

Referenced by get_re_vars(), operator=(), osauth_auth_object(), and user_name().

◆ zone_name_

std::string irods::osauth_auth_object::zone_name_
private

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

Description:\n zone name - from rcConn

Definition at line 78 of file irods_osauth_auth_object.hpp.

Referenced by get_re_vars(), operator=(), osauth_auth_object(), and zone_name().


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