com::pcbsys::nirvana::nAdminAPI::nSecurityGroup Class Reference

This class represents a "Security Group" that contains entries for nSubject objects, and other nSecurityGroup objects. More...

#include <nSecurityGroup.h>

Inheritance diagram for com::pcbsys::nirvana::nAdminAPI::nSecurityGroup:
com::pcbsys::nirvana::client::nSubject

Public Member Functions

virtual void add (nSubject *member)
 Add a member to the group. More...
 
virtual bool contains (nSubject *member)
 Checks whether this nSecurityGroup contains a specific nSubject. More...
 
virtual bool contains (std::string member)
 Checks whether this nSecurityGroup contains a specific member (could be another nSecurityGroup or an nSubject. More...
 
virtual std::list< nSubject * > * getMembers ()
 Gets the members for the group. More...
 
virtual fAclGroup * getSubject ()
 Gets the subject for the group. More...
 
virtual nSubjectlookup (nSubject *member)
 Locate the nSubject within this nSecurityGroup or it's member nSecurityGroup objects. More...
 
 nSecurityGroup (std::string name)
 Construct the nSecurityGroup with it's name. More...
 
 nSecurityGroup (std::string name, nSubject **members, int numMembers)
 Construct the nSecurityGroup with a name and members. More...
 
 nSecurityGroup (fAclGroup *group)
 Constructor for nSecurity Group taking an fACLGroup representation of a group. More...
 
- Public Member Functions inherited from com::pcbsys::nirvana::client::nSubject
std::string getHost ()
 The host name for this subject. More...
 
std::string getName ()
 The Name being used by this subject. More...
 
fSubject * getSubject ()
 The fSubject instance being used by this object. More...
 
std::string getUser ()
 The username being used by this subject. More...
 
 nSubject (fAclGroup *grp)
 Create a new nSubject using an AclGroup instance. More...
 
 nSubject (std::string sub)
 Create a new nSubject using a string. More...
 
std::string toString ()
 Converts this object into a string. More...
 

Detailed Description

This class represents a "Security Group" that contains entries for nSubject objects, and other nSecurityGroup objects.

The class can be used in conjunction with the nACLEntry (and any subclass of this object) in order to add nSecurityGroup objects into nACL objects for Nirvana Realm ACLs, Channel / Queue ACLs or Interface Via Lists.

Constructor & Destructor Documentation

com::pcbsys::nirvana::nAdminAPI::nSecurityGroup::nSecurityGroup ( std::string  name)

Construct the nSecurityGroup with it's name.

Parameters
namethe name of the group
com::pcbsys::nirvana::nAdminAPI::nSecurityGroup::nSecurityGroup ( std::string  name,
nSubject **  members,
int  numMembers 
)

Construct the nSecurityGroup with a name and members.

Parameters
namethe name of the security group
membersthe initial members of the group
numMembersthe number of members
com::pcbsys::nirvana::nAdminAPI::nSecurityGroup::nSecurityGroup ( fAclGroup *  group)

Constructor for nSecurity Group taking an fACLGroup representation of a group.

Parameters
groupthe fACLGroup to generate this SecurityGroup from.

Member Function Documentation

virtual void com::pcbsys::nirvana::nAdminAPI::nSecurityGroup::add ( nSubject member)
virtual

Add a member to the group.

Parameters
memberthe member to add
virtual bool com::pcbsys::nirvana::nAdminAPI::nSecurityGroup::contains ( nSubject member)
virtual

Checks whether this nSecurityGroup contains a specific nSubject.

Parameters
memberthe member to check within this group and sub groups
Returns
true if the member exists, else false
virtual bool com::pcbsys::nirvana::nAdminAPI::nSecurityGroup::contains ( std::string  member)
virtual

Checks whether this nSecurityGroup contains a specific member (could be another nSecurityGroup or an nSubject.

Parameters
memberthe member to check within this group and sub groups
Returns
true if the member exists, else false
virtual std::list<nSubject*>* com::pcbsys::nirvana::nAdminAPI::nSecurityGroup::getMembers ( )
virtual

Gets the members for the group.

Returns
list of the members subjects
virtual fAclGroup* com::pcbsys::nirvana::nAdminAPI::nSecurityGroup::getSubject ( )
virtual

Gets the subject for the group.

Returns
the subject
virtual nSubject* com::pcbsys::nirvana::nAdminAPI::nSecurityGroup::lookup ( nSubject member)
virtual

Locate the nSubject within this nSecurityGroup or it's member nSecurityGroup objects.

Parameters
memberthe member being searched for
Returns
the nSubject or nSecurityGroup that represents the nSubject passed in