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)
	Set the authenticator Policy. More...
static void	resetPolicy ()
	Set the authenticator Policy back to null. More...
static bool	available (std::string const &host, std::string const &port)
	Determine whether an authenticator string is available for database access. More...
static std::string	authString (std::string const &host, std::string const &port)
	Get the authenticator string for a database. More...
static std::string	username (std::string const &host, std::string const &port)
	Get the username to use to authenticate to a database. More...
static std::string	password (std::string const &host, std::string const &port)
	Get the password to use to authenticate to a database. More...

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 57 of file DbAuth.h.

Member Function Documentation

authString()

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]	host	Name of the host to connect to.
[in]	port	Port number to connect to (as string).

Returns

String with username:password

Definition at line 135 of file DbAuth.cc.

                                                                                   {
    std::pair<std::string, std::string> result = search(host, port);
    return result.first + ":" + result.second;
}

available()

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]	host	Name of the host to connect to.
[in]	port	Port number to connect to (as string).

Returns

True if authenticator is available

Definition at line 120 of file DbAuth.cc.

                                                                             {
    try {
        std::pair<std::string, std::string> result = search(host, port);
        return true;
    } catch (...) {
        return false;
    }
    return false;  // not reached
}

password()

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]	host	Name of the host to connect to.
[in]	port	Port number to connect to (as string).

Returns

Password string

Definition at line 155 of file DbAuth.cc.

                                                                                 {
    std::pair<std::string, std::string> result = search(host, port);
    return result.second;
}

resetPolicy()

void lsst::daf::persistence::DbAuth::resetPolicy ( )

static

Set the authenticator Policy back to null.

Definition at line 112 of file DbAuth.cc.

{ authPolicy = nullptr; }

setPolicy()

void lsst::daf::persistence::DbAuth::setPolicy ( lsst::pex::policy::Policy::Ptr  policy )

static

Set the authenticator Policy.

Parameters

[in]

policy

Pointer to a Policy

Definition at line 106 of file DbAuth.cc.

                                                          {
    authPolicy = pexPolicy::Policy::Ptr(new pexPolicy::Policy(*policy, true));
}

username()

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]	host	Name of the host to connect to.
[in]	port	Port number to connect to (as string).

Returns

Username string

Definition at line 145 of file DbAuth.cc.

                                                                                 {
    std::pair<std::string, std::string> result = search(host, port);
    return result.first;
}

---

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

• /j/snowflake/release/lsstsw/stack/1a1d771/Linux64/daf_persistence/20.0.0/include/lsst/daf/persistence/DbAuth.h
• /j/snowflake/release/lsstsw/stack/1a1d771/Linux64/daf_persistence/20.0.0/src/DbAuth.cc