Public Member Functions
com.pcbsys.nirvana.nAdminAPI.nSecurityGroup Class Reference

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

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 (string member)
 * Checks whether this nSecurityGroup contains a specific member (could be another nSecurityGroup or an nSubject More...
 
virtual Collection< nSubject > getMembers ()
 Returns the members of this security group as a collection of nSubjects. More...
 
virtual fAclGroup getSubject ()
 Returns the fACLGroup representation of the Security Group. More...
 
virtual nSubject lookup (nSubject member)
 * Locate the nSubject within this nSecurityGroup or it's member nSecurityGroup objects More...
 
 nSecurityGroup (string name)
 * Construct the nSecurityGroup with it's name More...
 
 nSecurityGroup (string name, nSubject[] members)
 * 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
int CompareTo (object obj)
 Compares this subject instance with specified subject instance More...
 
bool Equals (nSubject obj)
 Determines whether this instance and another specified nSubject object have same internal values More...
 
string getHost ()
 The host name for this subject. More...
 
String getName ()
 The Name being used by this subject More...
 
fSubject getSubject ()
 
string getUser ()
 The username being used by this subject More...
 
 nSubject (fSubject sub)
 Create a new nSubject using another subject instance More...
 
 nSubject (fAclGroup grp)
 Create a new nSubject using an AclGroup instance More...
 
 nSubject (string sub)
 Create a new nSubject using a key of user More...
 
override 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 ( string  name)

* Construct the nSecurityGroup with it's name

  • Parameters
    namethe name of the group
com.pcbsys.nirvana.nAdminAPI.nSecurityGroup.nSecurityGroup ( string  name,
nSubject[]  members 
)

* Construct the nSecurityGroup with a name and members

  • Parameters
    namethe name of the security group
  • Parameters
    membersthe initial members of the group
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 ( 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 Collection<nSubject> com.pcbsys.nirvana.nAdminAPI.nSecurityGroup.getMembers ( )
virtual

Returns the members of this security group as a collection of nSubjects.

Returns
a collection of nSubject objects, representing the members of this security group.
virtual fAclGroup com.pcbsys.nirvana.nAdminAPI.nSecurityGroup.getSubject ( )
virtual

Returns the fACLGroup representation of the Security Group.

Returns
the fACLGroup which is used to represent this SecurityGroup.
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