represents a list of nACLEntry classes used by the Nirvana Realm server to control access to secured objects such as Realms, Channels and Queues.
More...
Inherits com.pcbsys.nirvana.client.Observable.
represents a list of nACLEntry classes used by the Nirvana Realm server to control access to secured objects such as Realms, Channels and Queues.
nACLEntry
virtual void com.pcbsys.nirvana.nAdminAPI.nACL.add |
( |
nACLEntry |
entry | ) |
|
|
virtual |
Adds a new nACLEntry into the list.
- Parameters
-
- Exceptions
-
virtual bool com.pcbsys.nirvana.nAdminAPI.nACL.contains |
( |
string |
subject | ) |
|
|
virtual |
Returns whether an nACLEntry exists the nACL which matches this subject.
- Parameters
-
subject | String representation of the subject (user) |
- Returns
- whether a matching acl entry exists
- Exceptions
-
virtual nACLEntry com.pcbsys.nirvana.nAdminAPI.nACL.find |
( |
string |
subject | ) |
|
|
virtual |
Finds an nACLEntry within the list which matches this subject.
If it could not find a match it will throw nACLEntryNotFoundException
- Parameters
-
subject | String representation of the subject (user) |
- Returns
- the nACLEntry which matched
- Exceptions
-
Finds an nACLEntry which matches the passed in nACLEntry.
The comparision is done on the subject only and not the permissions since the subject must be unique in the list. If it could not find a match it will throw nACLEntryNotFoundException
- Parameters
-
- Returns
- the nACLEntry which matches
- Exceptions
-
virtual nACLEntry com.pcbsys.nirvana.nAdminAPI.nACL.get |
( |
int |
index | ) |
|
|
virtual |
Returns the nACLEntry specified by the index parameter is useful to examine/walk the list.
- Parameters
-
index | the index position of the nACLEntry to be retrieved |
- Exceptions
-
- Returns
- the nACLEntry object at the specified index
virtual System.Collections.IEnumerator com.pcbsys.nirvana.nAdminAPI.nACL.getEntries |
( |
| ) |
|
|
virtual |
Returns an IEnumerator of nACLEntry objects which make up the list.
This is useful to examine/walk the list.
- Returns
- IEnumerator of nACLEntry objects
virtual void com.pcbsys.nirvana.nAdminAPI.nACL.remove |
( |
string |
subject | ) |
|
|
virtual |
Removes the nACLEntry which matches the subject specified by the string passed in.
Currently no wild card removals are supported so only a direct match will result in the removal of the nACLEntry
- Parameters
-
subject | String representation of the subject (user) |
- Exceptions
-
virtual void com.pcbsys.nirvana.nAdminAPI.nACL.remove |
( |
nACLEntry |
entry | ) |
|
|
virtual |
Removes the nACLEntry which matches the subject specified the nACLEntry object.
- Parameters
-
entry | The nACLEntry to be removed from the list |
- Exceptions
-
virtual void com.pcbsys.nirvana.nAdminAPI.nACL.removeAll |
( |
| ) |
|
|
virtual |
Removes ALL of the nACLEntry objects from the list.
WARNING: if you commit an empty nACL you will effectivily block ALL access to the secure object. There is no way to override this so be careful when calling this function that you do actually add nACLEntry objects to this to at least allow the administrator back in
virtual void com.pcbsys.nirvana.nAdminAPI.nACL.replace |
( |
nACLEntry |
entry | ) |
|
|
virtual |
Replaces the existing nACLEntry priviliges with the passed nACLEntry.
Useful for changing permissions for a subject within a list
- Parameters
-
entry | The nACLEntry containing the updated priviliges |
- Exceptions
-
virtual int com.pcbsys.nirvana.nAdminAPI.nACL.size |
( |
| ) |
|
|
virtual |
Returns the number of entries within the list
- Returns
- int size of this list