LSSTApplications  10.0+286,10.0+36,10.0+46,10.0-2-g4f67435,10.1+152,10.1+37,11.0,11.0+1,11.0-1-g47edd16,11.0-1-g60db491,11.0-1-g7418c06,11.0-2-g04d2804,11.0-2-g68503cd,11.0-2-g818369d,11.0-2-gb8b8ce7
LSSTDataManagementBasePackage
Static Public Member Functions | List of all members
lsst::daf::persistence::DbAuth Class Reference

Class for database authentication. More...

#include <DbAuth.h>

Static Public Member Functions

static void setPolicy (lsst::pex::policy::Policy::Ptr policy)
 
static bool available (std::string const &host, std::string const &port)
 
static std::string authString (std::string const &host, std::string const &port)
 
static std::string username (std::string const &host, std::string const &port)
 
static std::string password (std::string const &host, std::string const &port)
 

Detailed Description

Class for database authentication.

Provides access to username and password to be used to authenticate to a database. Actual username and password come from a well-known environment variable or a well-known file or a file specified by Policy. The format for the authenticator string in any location is "username:password".

Definition at line 58 of file DbAuth.h.

Member Function Documentation

std::string lsst::daf::persistence::DbAuth::authString ( std::string const &  host,
std::string const &  port 
)
static

Get the authenticator string for a database.

Parameters
[in]hostName of the host to connect to.
[in]portPort number to connect to (as string).
Returns
String with username:password

Definition at line 147 of file DbAuth.cc.

148  {
149  std::pair<std::string, std::string> result = search(host, port);
150  return result.first + ":" + result.second;
151 }
bool lsst::daf::persistence::DbAuth::available ( std::string const &  host,
std::string const &  port 
)
static

Determine whether an authenticator string is available for database access.

Parameters
[in]hostName of the host to connect to.
[in]portPort number to connect to (as string).
Returns
True if authenticator is available

Definition at line 130 of file DbAuth.cc.

131  {
132  try {
133  std::pair<std::string, std::string> result = search(host, port);
134  return true;
135  }
136  catch (...) {
137  return false;
138  }
139  return false; // not reached
140 }
std::string lsst::daf::persistence::DbAuth::password ( std::string const &  host,
std::string const &  port 
)
static

Get the password to use to authenticate to a database.

Parameters
[in]hostName of the host to connect to.
[in]portPort number to connect to (as string).
Returns
Password string

Definition at line 169 of file DbAuth.cc.

170  {
171  std::pair<std::string, std::string> result = search(host, port);
172  return result.second;
173 }
void lsst::daf::persistence::DbAuth::setPolicy ( lsst::pex::policy::Policy::Ptr  policy)
static

Set the authenticator Policy.

Parameters
[in]policyPointer to a Policy

Definition at line 119 of file DbAuth.cc.

119  {
120  dafBase::PersistentCitizenScope scopeGuard;
121  authPolicy = pexPolicy::Policy::Ptr(new pexPolicy::Policy(*policy, true));
122 }
lsst::pex::policy::Policy
a container for holding hierarchical configuration data in memory.
Definition: Policy.h:169
lsst::pex::policy::Policy::Ptr
boost::shared_ptr< Policy > Ptr
Definition: Policy.h:172
std::string lsst::daf::persistence::DbAuth::username ( std::string const &  host,
std::string const &  port 
)
static

Get the username to use to authenticate to a database.

Parameters
[in]hostName of the host to connect to.
[in]portPort number to connect to (as string).
Returns
Username string

Definition at line 158 of file DbAuth.cc.

159  {
160  std::pair<std::string, std::string> result = search(host, port);
161  return result.first;
162 }
The documentation for this class was generated from the following files:
Generated on Thu Sep 24 2015 02:29:34 for LSSTApplications by   doxygen 1.8.5