Contains the mapping between a subject User and the priviliges they can perform on a secured object such as a Realm, Channel or Queue. More...
Public Member Functions | |
| boolean | canList () |
| Can this subject list the contents of an ACL. More... | |
| boolean | canModify () |
| Can this subject modify acl entries in a secure object. More... | |
| nACLEntry | clone () |
| Returns a clone of the nChannelACLEntry. More... | |
| boolean | equals (long aLong) |
| Required as part of the SortedObject interface. More... | |
| String | getHost () |
| Returns the host portion of the subject. More... | |
| String | getName () |
| Returns the name of the ACLEntry. More... | |
| String | getSubject () |
| This method returns the completed subject User. More... | |
| boolean | hasFullPrivileges () |
| Does this csubject have full privileges for the secure object. More... | |
| boolean | isMatch (Object item) |
| Used to compares this Object with another to determine sorting position. More... | |
| boolean | lessThan (long aLong) |
| Required as part of the SortedObject interface. More... | |
| boolean | lessThan (Object item) |
| Used to compares this Object with another to determine sorting position. More... | |
| nACLEntry (String name, String host) throws nAdminIllegalArgumentException | |
| Creates a new nACLEntry with the subject being name. More... | |
| nACLEntry (String subject) throws nAdminIllegalArgumentException | |
| Creates a new nACLEntry with the string argument of the form name. More... | |
| void | setFullPrivileges (boolean val) |
| Sets the subject to have full privileges for this secure object allowing the subject complete control over the secure object WARNING: Use with great caution. More... | |
| void | setList (boolean val) |
| Changes the current setting for this user to allow/disallow ACL listing WARNING: Should be used in conjuction with ModifyACL. More... | |
| void | setModify (boolean val) |
| Changes the current setting for this subject to allow/disallow modifing ACL. More... | |
Contains the mapping between a subject User and the priviliges they can perform on a secured object such as a Realm, Channel or Queue.
On construction of these objects the name string can be set to "*" meaning All users and the host cal also be set to "*". For example, all users from a host called test.com can be configured such as *
| com.pcbsys.nirvana.nAdminAPI.nACLEntry.nACLEntry | ( | String | name, |
| String | host | ||
| ) | throws nAdminIllegalArgumentException |
Creates a new nACLEntry with the subject being name.
There are no default permissions set so this subject can perform NO actions on the secured objects
| name | Username/Token for the subject |
| host | the host they can connect from |
| nAdminIllegalArgumentException | if an invalid or null argument is passed |
| com.pcbsys.nirvana.nAdminAPI.nACLEntry.nACLEntry | ( | String | subject | ) | throws nAdminIllegalArgumentException |
Creates a new nACLEntry with the string argument of the form name.
There are no default permissions set so this subject can perform NO actions on the secured objects
| subject | of the form user |
| nAdminIllegalArgumentException | if an invalid or null argument is passed |
| boolean com.pcbsys.nirvana.nAdminAPI.nACLEntry.canList | ( | ) |
Can this subject list the contents of an ACL.
| boolean com.pcbsys.nirvana.nAdminAPI.nACLEntry.canModify | ( | ) |
Can this subject modify acl entries in a secure object.
| nACLEntry com.pcbsys.nirvana.nAdminAPI.nACLEntry.clone | ( | ) |
Returns a clone of the nChannelACLEntry.
| boolean com.pcbsys.nirvana.nAdminAPI.nACLEntry.equals | ( | long | aLong | ) |
Required as part of the SortedObject interface.
For internal use only
| String com.pcbsys.nirvana.nAdminAPI.nACLEntry.getHost | ( | ) |
Returns the host portion of the subject.
| String com.pcbsys.nirvana.nAdminAPI.nACLEntry.getName | ( | ) |
Returns the name of the ACLEntry.
| String com.pcbsys.nirvana.nAdminAPI.nACLEntry.getSubject | ( | ) |
This method returns the completed subject User.
| boolean com.pcbsys.nirvana.nAdminAPI.nACLEntry.hasFullPrivileges | ( | ) |
Does this csubject have full privileges for the secure object.
This privlege enables the subject to perform ANY action against this secure object if set to true.
| boolean com.pcbsys.nirvana.nAdminAPI.nACLEntry.isMatch | ( | Object | item | ) |
Used to compares this Object with another to determine sorting position.
For internal use only
| item | Object to compare |
| boolean com.pcbsys.nirvana.nAdminAPI.nACLEntry.lessThan | ( | long | aLong | ) |
Required as part of the SortedObject interface.
For internal use only
| boolean com.pcbsys.nirvana.nAdminAPI.nACLEntry.lessThan | ( | Object | item | ) |
Used to compares this Object with another to determine sorting position.
| item | Object to compare |
| void com.pcbsys.nirvana.nAdminAPI.nACLEntry.setFullPrivileges | ( | boolean | val | ) |
Sets the subject to have full privileges for this secure object allowing the subject complete control over the secure object WARNING: Use with great caution.
Should only set what is required rather than this entry. By default the realm server will automatically set this for the default administrator
| val | true for full, false otherwise |
| void com.pcbsys.nirvana.nAdminAPI.nACLEntry.setList | ( | boolean | val | ) |
Changes the current setting for this user to allow/disallow ACL listing WARNING: Should be used in conjuction with ModifyACL.
| val | boolean specifying the permission status |
| void com.pcbsys.nirvana.nAdminAPI.nACLEntry.setModify | ( | boolean | val | ) |
Changes the current setting for this subject to allow/disallow modifing ACL.
WARNING: Should not be given to normal subjects but only to subjects which need to administor the Secure Object.
| val | boolean specifying the permission status |