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.hpp
Go to the documentation of this file.
1 #ifndef _AUTH_OBJECT_HPP_
2 #define _AUTH_OBJECT_HPP_
3 
4 #include "irods_error.hpp"
6 
7 #include "rcConnect.h"
8 
9 // boost includes
10 #include <boost/shared_ptr.hpp>
11 
12 namespace irods {
17  public:
19  auth_object( rError_t* _r_error );
20  auth_object( const auth_object& );
21  virtual ~auth_object();
22 
24  virtual auth_object& operator=( const auth_object& _rhs );
25 
27  virtual rError_t* r_error( void ) const {
28  return r_error_;
29  }
30  virtual std::string request_result() const {
31  return request_result_;
32  }
33  virtual void request_result( const std::string& _r ) {
34  request_result_ = _r;
35  }
36  virtual std::string context() const {
37  return context_;
38  }
39  virtual void context( const std::string& _c ) {
40  context_ = _c;
41  }
42  virtual std::string user_name() const {
43  return user_name_;
44  }
45  virtual std::string zone_name() const {
46  return zone_name_;
47  }
48  virtual void user_name( const std::string& _un ) {
49  user_name_ = _un;
50  }
51  virtual void zone_name( const std::string& _zn ) {
52  zone_name_ = _zn;
53  }
54 
56  virtual bool operator==( const auth_object& _rhs ) const;
57 
59  virtual error resolve( const std::string& _plugin_name, plugin_ptr& _plugin ) = 0;
61 
62  protected:
64 
66  // result passed to outgoing auth request
67  // struct back to client - challenge for native,
68  // password for pam etc
69  std::string request_result_;
70 
73  std::string user_name_;
74 
77  std::string zone_name_;
78 
82  std::string context_;
83  };
84 
86  typedef boost::shared_ptr<auth_object> auth_object_ptr;
87 
88 }; // namespace irods
89 
90 #endif // _AUTH_OBJECT_HPP_
irods::plugin_ptr
boost::shared_ptr< plugin_base > plugin_ptr
Definition: irods_first_class_object.hpp:18
irods::auth_object
Definition: irods_auth_object.hpp:16
irods::auth_object::~auth_object
virtual ~auth_object()
Definition: irods_auth_object.cpp:10
irods::auth_object::auth_object
auth_object(rError_t *_r_error)
Definition: irods_auth_object.cpp:5
irods::auth_object::operator=
virtual auth_object & operator=(const auth_object &_rhs)
Definition: irods_auth_object.cpp:22
irods::auth_object::get_re_vars
virtual error get_re_vars(rule_engine_vars_t &)=0
irods::auth_object::zone_name_
std::string zone_name_
Definition: irods_auth_object.hpp:77
irods::auth_object::context
virtual std::string context() const
Definition: irods_auth_object.hpp:36
rcConnect.h
irods::auth_object_ptr
boost::shared_ptr< auth_object > auth_object_ptr
Definition: irods_auth_object.hpp:86
irods::auth_object::zone_name
virtual void zone_name(const std::string &_zn)
Definition: irods_auth_object.hpp:51
rError_t
Definition: rodsError.h:24
irods
Definition: apiHandler.hpp:35
irods::auth_object::r_error
virtual rError_t * r_error(void) const
Definition: irods_auth_object.hpp:27
irods::auth_object::context
virtual void context(const std::string &_c)
Definition: irods_auth_object.hpp:39
irods::auth_object::r_error_
rError_t * r_error_
Definition: irods_auth_object.hpp:63
irods::auth_object::user_name
virtual void user_name(const std::string &_un)
Definition: irods_auth_object.hpp:48
irods::auth_object::zone_name
virtual std::string zone_name() const
Definition: irods_auth_object.hpp:45
irods::auth_object::user_name
virtual std::string user_name() const
Definition: irods_auth_object.hpp:42
irods::auth_object::user_name_
std::string user_name_
Definition: irods_auth_object.hpp:73
irods::auth_object::request_result
virtual std::string request_result() const
Definition: irods_auth_object.hpp:30
irods::auth_object::resolve
virtual error resolve(const std::string &_plugin_name, plugin_ptr &_plugin)=0
irods::auth_object::request_result
virtual void request_result(const std::string &_r)
Definition: irods_auth_object.hpp:33
irods::error
Definition: irods_error.hpp:23
irods::auth_object::context_
std::string context_
Definition: irods_auth_object.hpp:82
irods_first_class_object.hpp
irods::auth_object::operator==
virtual bool operator==(const auth_object &_rhs) const
Definition: irods_auth_object.cpp:30
irods::first_class_object
Definition: irods_first_class_object.hpp:23
irods_error.hpp
irods::auth_object::request_result_
std::string request_result_
=-=-=-=-=-=-=-
Definition: irods_auth_object.hpp:69
irods::rule_engine_vars_t
std::map< std::string, std::string > rule_engine_vars_t
Definition: irods_first_class_object.hpp:20