#include <authn.h>
List of all members.
Detailed Description
User and group handling.
- Note:
- This is the only interface not inheriting from BaseInterface.
Constructor & Destructor Documentation
virtual dmlite::Authn::~Authn |
( |
| ) |
|
|
virtual |
Member Function Documentation
Create a default security context.
- Returns:
- A newly created SecurityContext.
virtual void dmlite::Authn::deleteGroup |
( |
const std::string & |
groupName | ) |
throw (DmException) |
|
virtual |
virtual void dmlite::Authn::deleteUser |
( |
const std::string & |
userName | ) |
throw (DmException) |
|
virtual |
virtual GroupInfo dmlite::Authn::getGroup |
( |
const std::string & |
key, |
|
|
const boost::any & |
value |
|
) |
| throw (DmException) |
|
virtual |
Get a specific group using an alternative key.
- Parameters:
-
key | The key name. |
value | They value to search for. |
- Returns:
- The group.
- Note:
- The implementation will throw an exception if the field can not be used as key.
Reimplemented in dmlite::BuiltInAuthn.
virtual void dmlite::Authn::getIdMap |
( |
const std::string & |
userName, |
|
|
const std::vector< std::string > & |
groupNames, |
|
|
UserInfo * |
user, |
|
|
std::vector< GroupInfo > * |
groups |
|
) |
| throw (DmException) |
|
virtual |
Get the mapping of a user/group. Additionaly, new users and groups MAY be created by the implementation.
- Parameters:
-
userName | The user name. |
groupNames | The different groups. Can be empty. |
user | Pointer to an UserInfo struct where to put the data. |
groups | Pointer to a vector where the group mapping will be put. |
- Note:
- If groupNames is empty, grid mapfile will be used to retrieve the default group.
Reimplemented in dmlite::BuiltInAuthn.
virtual std::string dmlite::Authn::getImplId |
( |
void |
| ) |
const throw () |
|
pure virtual |
virtual UserInfo dmlite::Authn::getUser |
( |
const std::string & |
key, |
|
|
const boost::any & |
value |
|
) |
| throw (DmException) |
|
virtual |
Get a specific user using an alternative key.
- Parameters:
-
key | The key name. |
value | They value to search for. |
- Returns:
- The user.
- Note:
- The implementation will throw an exception if the field can not be used as key.
Reimplemented in dmlite::BuiltInAuthn.
Update group info. 'name' identify uniquely the group.
- Parameters:
-
group | The group metadata to update. |
Reimplemented in dmlite::BuiltInAuthn.
Update user info. 'name' identify uniquely the user.
- Parameters:
-
user | The user metadata to update. |
Reimplemented in dmlite::BuiltInAuthn.
The documentation for this class was generated from the following file: