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 Observable.
Public Member Functions | |
| synchronized void | add (nACLEntry entry) throws nBaseAdminException, nDuplicateACLEntryException, nAdminIllegalArgumentException |
| Adds a new nACLEntry into the list. More... | |
| boolean | contains (String subject) throws nAdminIllegalArgumentException |
| Returns whether an nACLEntry exists the nACL which matches this subject. More... | |
| nACLEntry | find (String subject) throws nACLEntryNotFoundException, nAdminIllegalArgumentException |
| Finds an nACLEntry within the list which matches this subject. More... | |
| nACLEntry | find (nACLEntry entry) throws nACLEntryNotFoundException, nAdminIllegalArgumentException |
| Finds an nACLEntry which matches the passed in nACLEntry. More... | |
| nACLEntry | get (int index) throws nAdminIllegalArgumentException |
| Returns the nACLEntry specified by the index parameter is useful to examine/walk the list. More... | |
| Enumeration | getCopyEntries (boolean copy) |
| Returns a deep copy Enumeration of nACLEntry objects which make up the list. More... | |
| Enumeration | getEntries () |
| Returns an Enumeration of nACLEntry objects which make up the list. More... | |
| synchronized void | remove (String subject) throws nACLEntryNotFoundException, nAdminIllegalArgumentException |
| Removes the nACLEntry which matches the subject specified by the string passed in. More... | |
| synchronized void | remove (nACLEntry entry) throws nACLEntryNotFoundException, nAdminIllegalArgumentException |
| Removes the nACLEntry which matches the subject specified the nACLEntry object. More... | |
| synchronized void | removeAll () |
| Removes ALL of the nACLEntry objects from the list. More... | |
| synchronized void | replace (nACLEntry entry) throws nACLEntryNotFoundException, nAdminIllegalArgumentException |
| Replaces the existing nACLEntry priviliges with the passed nACLEntry. More... | |
| int | size () |
| Returns the number of entries within the list. More... | |
represents a list of nACLEntry classes used by the Nirvana Realm server to control access to secured objects such as Realms, Channels and Queues.
| synchronized void com.pcbsys.nirvana.nAdminAPI.nACL.add | ( | nACLEntry | entry | ) | throws nBaseAdminException, nDuplicateACLEntryException, nAdminIllegalArgumentException |
Adds a new nACLEntry into the list.
| entry | The new nACLEntry to add to the list |
| nDuplicateACLEntryException | If the entry already exists in the list |
| nAdminIllegalArgumentException | if the entry is null |
| nBaseAdminException | Unable to perform the requested operation, check the message for further information |
| boolean com.pcbsys.nirvana.nAdminAPI.nACL.contains | ( | String | subject | ) | throws nAdminIllegalArgumentException |
Returns whether an nACLEntry exists the nACL which matches this subject.
| subject | String representation of the subject (user) |
| nAdminIllegalArgumentException | thrown if acl entry is null |
| nACLEntry com.pcbsys.nirvana.nAdminAPI.nACL.find | ( | String | subject | ) | throws nACLEntryNotFoundException, nAdminIllegalArgumentException |
Finds an nACLEntry within the list which matches this subject.
If it could not find a match it will throw nACLEntryNotFoundException
| subject | String representation of the subject (user) |
| nACLEntryNotFoundException | thrown if acl entry is not found |
| nAdminIllegalArgumentException | thrown if acl entry is null |
| nACLEntry com.pcbsys.nirvana.nAdminAPI.nACL.find | ( | nACLEntry | entry | ) | throws nACLEntryNotFoundException, nAdminIllegalArgumentException |
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
| entry | A nACLEntry to locate within the list |
| nACLEntryNotFoundException | thrown if acl entry is not found |
| nAdminIllegalArgumentException | thrown if acl entry is null |
| nACLEntry com.pcbsys.nirvana.nAdminAPI.nACL.get | ( | int | index | ) | throws nAdminIllegalArgumentException |
Returns the nACLEntry specified by the index parameter is useful to examine/walk the list.
| index | the index position of the nACLEntry to be retrieved |
| nAdminIllegalArgumentException | thrown if the index specified is out of range or less than 0. |
| Enumeration com.pcbsys.nirvana.nAdminAPI.nACL.getCopyEntries | ( | boolean | copy | ) |
Returns a deep copy Enumeration of nACLEntry objects which make up the list.
This is useful to examine/walk and modifying the list. It is different from getEntries() in that the return Enumeration is a deep copy of the underlying list and can be used to modify the AclList.
| Enumeration com.pcbsys.nirvana.nAdminAPI.nACL.getEntries | ( | ) |
| synchronized void com.pcbsys.nirvana.nAdminAPI.nACL.remove | ( | String | subject | ) | throws nACLEntryNotFoundException, nAdminIllegalArgumentException |
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
| subject | String representation of the subject (user) |
| nACLEntryNotFoundException | thrown if acl entry is not found |
| nAdminIllegalArgumentException | thrown if acl entry is null |
| synchronized void com.pcbsys.nirvana.nAdminAPI.nACL.remove | ( | nACLEntry | entry | ) | throws nACLEntryNotFoundException, nAdminIllegalArgumentException |
Removes the nACLEntry which matches the subject specified the nACLEntry object.
| entry | The nACLEntry to be removed from the list |
| nACLEntryNotFoundException | thrown if acl entry is not found |
| nAdminIllegalArgumentException | thrown if acl entry is null |
| synchronized void com.pcbsys.nirvana.nAdminAPI.nACL.removeAll | ( | ) |
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
| synchronized void com.pcbsys.nirvana.nAdminAPI.nACL.replace | ( | nACLEntry | entry | ) | throws nACLEntryNotFoundException, nAdminIllegalArgumentException |
Replaces the existing nACLEntry priviliges with the passed nACLEntry.
Useful for changing permissions for a subject within a list
| entry | The nACLEntry containing the updated priviliges |
| nACLEntryNotFoundException | Only if the entry could not be found |
| nAdminIllegalArgumentException | if the entry is null |
| int com.pcbsys.nirvana.nAdminAPI.nACL.size | ( | ) |
Returns the number of entries within the list.