- com
- pcbsys
- nirvana
- nAdminAPI
- nRealmACLEntry
Extends the nACLEntry class to expose the Realm specific permissions. More...
Public Member Functions | |
| boolean | canAccessTheRealm () |
| Can this Subject connect and use this realm. More... | |
| boolean | canConfigureRealm () |
| Can this subject set/get runtime configuration values for the realm. More... | |
| boolean | canManageChannels () |
| Can this subject make/delete or perform maintance on channels within this realm. More... | |
| boolean | canManageDataGroups () |
| Checks if this acl entry allows management of datagroups. More... | |
| boolean | canManageJoins () |
| Can this subject create/remove/list joins between channels within the namespace. More... | |
| boolean | canManageP2PServices () |
| Can this subject create/remove p2p services on this realm This will always return false as it is deprecated. More... | |
| boolean | canManageRealm () |
| Can this Subject add/remove remote realms into this realms namespace. More... | |
| boolean | canOverrideConnectionCount () |
| Can this subject bypass the Realms maximum connection count. More... | |
| boolean | canPublishToGlobalDataGroup () |
| Checks if this acl entry allows publishing to the default datagroup. More... | |
| boolean | canTakeOwnershipOfDataGroup () |
| Checks if this acl entry allows taking ownership of datagroups. More... | |
| boolean | canUseAdminAPI () |
| Any subject with this permission set can perform the following functions on a realm Disconnect users from the realm Set ACLs for channels, queues and the realm Retrieve a list of all channels, queues, joins and connected realms Set Client Timeout values Set/Get Realm Configuration values for the realm Some of these functions also depend on other permissions being set as well. More... | |
| nRealmACLEntry | clone () |
| Returns a clone of the nRealmACLEntry. More... | |
| nRealmACLEntry (String name, String host) throws nAdminIllegalArgumentException | |
| Creates a new nRealmACLEntry with the supplied name. More... | |
| nRealmACLEntry (String subject) throws nAdminIllegalArgumentException | |
| Creates a new nRealmACLEntry with the supplied name. More... | |
| nRealmACLEntry (nSecurityGroup subject) throws nAdminIllegalArgumentException | |
| Creates a new nRealmACLEntry with the supplied name. More... | |
| nRealmACLEntry (String subject, nACLEntry copy) throws nAdminIllegalArgumentException | |
| Creates a new nRealmACLEntry with the supplied name. More... | |
| nRealmACLEntry (nSecurityGroup subject, nACLEntry copy) throws nAdminIllegalArgumentException | |
| Creates a new nRealmACLEntry with the supplied name. More... | |
| void | setAccessTheRealm (boolean val) |
| Allows/Disallows this subject the ability to connect and use the realm. More... | |
| void | setConfigureRealm (boolean val) |
| Allows/Disallows setting realm configuration values. More... | |
| void | setManageChannels (boolean val) |
| Allow/Disallows this subject from making/deleteing or performing maintenance on any channel on the realm. More... | |
| void | setManageDataGroups (boolean flag) |
| Allows or disallows management of datagroups for this acl entry. More... | |
| void | setManageJoins (boolean val) |
| Allows/Disallows this subject from managing the joins between channels within the namespace. More... | |
| void | setManageP2PServices (boolean val) |
| Allows/Disallows this subject creating p2p services on this realm This is now a no operation function as its deprecated. More... | |
| void | setManageRealm (boolean val) |
| Allows/Disallows this client from adding/removing remote realms into the namespace. More... | |
| void | setOverrideConnectionCount (boolean val) |
| Allow/Disallows the subject from overriding the maximum connection count. More... | |
| void | setPublishToGlobalDataGroup (boolean flag) |
| Allows or disallows publishing to the default datagroup for this acl entry. More... | |
| void | setTakeOwnershipOfDataGroup (boolean flag) |
| Allows or disallows taking ownership of a datagroup for this acl entry. More... | |
| void | setUseAdminAPI (boolean val) |
| Allows/Disallows this subject from accessing the realms Admin API functions. More... | |
 Public Member Functions inherited from com.pcbsys.nirvana.nAdminAPI.nACLEntry | |
| 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... | |
| com.pcbsys.nirvana.nAdminAPI.nRealmACLEntry.nRealmACLEntry | ( | String | name, |
| String | host | ||
| ) | throws nAdminIllegalArgumentException |
Creates a new nRealmACLEntry with the supplied name.
This class is used to manage subjects and their privileges they have on a realm.
| name | The name of the subject |
| host | The host name for the subject |
| nAdminIllegalArgumentException | if an invalid or null argument is passed |
| com.pcbsys.nirvana.nAdminAPI.nRealmACLEntry.nRealmACLEntry | ( | String | subject | ) | throws nAdminIllegalArgumentException |
Creates a new nRealmACLEntry with the supplied name.
This class is used to manage subjects and their privileges they have on a realm.
| subject | of the form user |
| nAdminIllegalArgumentException | if an invalid or null argument is passed |
| com.pcbsys.nirvana.nAdminAPI.nRealmACLEntry.nRealmACLEntry | ( | nSecurityGroup | subject | ) | throws nAdminIllegalArgumentException |
Creates a new nRealmACLEntry with the supplied name.
This class is used to manage subjects and their privileges they have on a realm.
| subject | of the form user |
| nAdminIllegalArgumentException | if an invalid or null argument is passed |
| com.pcbsys.nirvana.nAdminAPI.nRealmACLEntry.nRealmACLEntry | ( | String | subject, |
| nACLEntry | copy | ||
| ) | throws nAdminIllegalArgumentException |
Creates a new nRealmACLEntry with the supplied name.
This class is used to manage subjects and their privileges they have on a realm.
| subject | of the form user |
| copy | An nACLEntry to copy the current permissions from |
| nAdminIllegalArgumentException | if an invalid or null argument is passed |
| com.pcbsys.nirvana.nAdminAPI.nRealmACLEntry.nRealmACLEntry | ( | nSecurityGroup | subject, |
| nACLEntry | copy | ||
| ) | throws nAdminIllegalArgumentException |
Creates a new nRealmACLEntry with the supplied name.
This class is used to manage subjects and their privileges they have on a realm.
| subject | as an nSecurity Group |
| copy | An nACLEntry to copy the current permissions from |
| nAdminIllegalArgumentException | if an invalid or null argument is passed |
| boolean com.pcbsys.nirvana.nAdminAPI.nRealmACLEntry.canAccessTheRealm | ( | ) |
Can this Subject connect and use this realm.
If false the subject will be disconnected during the authentication stage.
| boolean com.pcbsys.nirvana.nAdminAPI.nRealmACLEntry.canConfigureRealm | ( | ) |
Can this subject set/get runtime configuration values for the realm.
| boolean com.pcbsys.nirvana.nAdminAPI.nRealmACLEntry.canManageChannels | ( | ) |
Can this subject make/delete or perform maintance on channels within this realm.
This permission is extends only for this realm within the namespace.
| boolean com.pcbsys.nirvana.nAdminAPI.nRealmACLEntry.canManageDataGroups | ( | ) |
Checks if this acl entry allows management of datagroups.
| boolean com.pcbsys.nirvana.nAdminAPI.nRealmACLEntry.canManageJoins | ( | ) |
Can this subject create/remove/list joins between channels within the namespace.
| boolean com.pcbsys.nirvana.nAdminAPI.nRealmACLEntry.canManageP2PServices | ( | ) |
Can this subject create/remove p2p services on this realm This will always return false as it is deprecated.
| boolean com.pcbsys.nirvana.nAdminAPI.nRealmACLEntry.canManageRealm | ( | ) |
Can this Subject add/remove remote realms into this realms namespace.
| boolean com.pcbsys.nirvana.nAdminAPI.nRealmACLEntry.canOverrideConnectionCount | ( | ) |
Can this subject bypass the Realms maximum connection count.
Typically all administrators would have this set so that a realm could be started with the user count set to a low number to allow a managed restart for example. Any user with this set will not check the current user count. This is not a license restriction, rather it is up to the end user to set the user count and these settings accordingly
| boolean com.pcbsys.nirvana.nAdminAPI.nRealmACLEntry.canPublishToGlobalDataGroup | ( | ) |
Checks if this acl entry allows publishing to the default datagroup.
| boolean com.pcbsys.nirvana.nAdminAPI.nRealmACLEntry.canTakeOwnershipOfDataGroup | ( | ) |
Checks if this acl entry allows taking ownership of datagroups.
| boolean com.pcbsys.nirvana.nAdminAPI.nRealmACLEntry.canUseAdminAPI | ( | ) |
Any subject with this permission set can perform the following functions on a realm Disconnect users from the realm Set ACLs for channels, queues and the realm Retrieve a list of all channels, queues, joins and connected realms Set Client Timeout values Set/Get Realm Configuration values for the realm Some of these functions also depend on other permissions being set as well.
| nRealmACLEntry com.pcbsys.nirvana.nAdminAPI.nRealmACLEntry.clone | ( | ) |
Returns a clone of the nRealmACLEntry.
| void com.pcbsys.nirvana.nAdminAPI.nRealmACLEntry.setAccessTheRealm | ( | boolean | val | ) |
Allows/Disallows this subject the ability to connect and use the realm.
| val | Boolean value to set |
| void com.pcbsys.nirvana.nAdminAPI.nRealmACLEntry.setConfigureRealm | ( | boolean | val | ) |
Allows/Disallows setting realm configuration values.
| val | Boolean value to set |
| void com.pcbsys.nirvana.nAdminAPI.nRealmACLEntry.setManageChannels | ( | boolean | val | ) |
Allow/Disallows this subject from making/deleteing or performing maintenance on any channel on the realm.
| val | Boolean value to set |
| void com.pcbsys.nirvana.nAdminAPI.nRealmACLEntry.setManageDataGroups | ( | boolean | flag | ) |
Allows or disallows management of datagroups for this acl entry.
| flag | boolean which when set to true will allow management of datagroups. |
| void com.pcbsys.nirvana.nAdminAPI.nRealmACLEntry.setManageJoins | ( | boolean | val | ) |
Allows/Disallows this subject from managing the joins between channels within the namespace.
| val | Boolean value to set |
| void com.pcbsys.nirvana.nAdminAPI.nRealmACLEntry.setManageP2PServices | ( | boolean | val | ) |
Allows/Disallows this subject creating p2p services on this realm This is now a no operation function as its deprecated.
| val | unused |
| void com.pcbsys.nirvana.nAdminAPI.nRealmACLEntry.setManageRealm | ( | boolean | val | ) |
Allows/Disallows this client from adding/removing remote realms into the namespace.
| val | Boolean value to set |
| void com.pcbsys.nirvana.nAdminAPI.nRealmACLEntry.setOverrideConnectionCount | ( | boolean | val | ) |
Allow/Disallows the subject from overriding the maximum connection count.
| val | Boolean value to set |
| void com.pcbsys.nirvana.nAdminAPI.nRealmACLEntry.setPublishToGlobalDataGroup | ( | boolean | flag | ) |
Allows or disallows publishing to the default datagroup for this acl entry.
| flag | boolean which when set to true will allow publishing to the default datagroup. |
| void com.pcbsys.nirvana.nAdminAPI.nRealmACLEntry.setTakeOwnershipOfDataGroup | ( | boolean | flag | ) |
Allows or disallows taking ownership of a datagroup for this acl entry.
| flag | boolean which when set to true will allow ownership of datagroups. |
| void com.pcbsys.nirvana.nAdminAPI.nRealmACLEntry.setUseAdminAPI | ( | boolean | val | ) |
Allows/Disallows this subject from accessing the realms Admin API functions.
| val | Boolean value to set |