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

void add (nSubject member) throws nBaseAdminException
 Add a member to the group. More...
 
boolean contains (nSubject member)
 Checks whether this nSecurityGroup contains a specific nSubject. More...
 
boolean contains (String member)
 Checks whether this nSecurityGroup contains a specific member (could be another nSecurityGroup or an nSubject. More...
 
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...
 
void remove (nSubject member) throws nBaseAdminException
 Remove a member from the group. More...
 
- Public Member Functions inherited from com.pcbsys.nirvana.client.nSubject
String getHost ()
 The host name for this subject. More...
 
String getUser ()
 The username being used by this subject. More...
 
 nSubject (String key)
 Create a new nSubject using a key of user. 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
membersthe initial members of the group

Member Function Documentation

void com.pcbsys.nirvana.nAdminAPI.nSecurityGroup.add ( nSubject  member) throws nBaseAdminException

Add a member to the group.

Parameters
memberthe member to add
boolean com.pcbsys.nirvana.nAdminAPI.nSecurityGroup.contains ( nSubject  member)

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
boolean com.pcbsys.nirvana.nAdminAPI.nSecurityGroup.contains ( String  member)

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
nSubject com.pcbsys.nirvana.nAdminAPI.nSecurityGroup.lookup ( nSubject  member)

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
void com.pcbsys.nirvana.nAdminAPI.nSecurityGroup.remove ( nSubject  member) throws nBaseAdminException

Remove a member from the group.

Parameters
memberthe member to add