com.pcbsys.nirvana.nAdminAPI.nRealmACLEntry Class Reference

Extends the nACLEntry class to expose the Realm specific permissions More...

Inheritance diagram for com.pcbsys.nirvana.nAdminAPI.nRealmACLEntry:
com.pcbsys.nirvana.nAdminAPI.nACLEntry

Public Member Functions

virtual bool canAccessTheRealm ()
 Can this Subject connect and use this realm. More...
 
virtual bool canConfigureRealm ()
 Can this subject set/get runtime configuration values for the realm More...
 
virtual bool canManageChannels ()
 Can this subject make/delete or perform maintance on channels within this realm. More...
 
virtual bool canManageDataGroups ()
 Can this subject manage datagroups for the realm More...
 
virtual bool canManageJoins ()
 Can this subject create/remove/list joins between channels within the namespace More...
 
virtual bool canManageRealm ()
 Can this Subject add/remove remote realms into this realms namespace. More...
 
virtual bool canOverrideConnectionCount ()
 Can this subject bypass the Realms maximum connection count. More...
 
virtual bool canPublishToGlobalDataGroup ()
 Can this subject publish to the default datagroup for the realm More...
 
virtual bool canTakeOwnershipOfDataGroup ()
 Can this subject take ownership of datagroups on this realm More...
 
virtual bool 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 (string name, string host)
 Creates a new nRealmACLEntry with the supplied name. More...
 
 nRealmACLEntry (string subject)
 Creates a new nRealmACLEntry with the supplied name. More...
 
 nRealmACLEntry (nSecurityGroup grp)
 Creates a new nRealmACLEntry with the supplied name. More...
 
 nRealmACLEntry (string subject, nACLEntry copy)
 Creates a new nRealmACLEntry with the supplied name. More...
 
virtual void setAccessTheRealm (bool val)
 Allows/Disallows this subject the ability to connect and use the realm More...
 
virtual void setConfigureRealm (bool val)
 Allows/Disallows setting realm configuration values More...
 
virtual void setManageChannels (bool val)
 Allow/Disallows this subject from making/deleteing or performing maintenance on any channel on the realm More...
 
virtual void setManageDataGroups (bool val)
 Allows/Disallows datagroup management operations More...
 
virtual void setManageJoins (bool val)
 Allows/Disallows this subject from managing the joins between channels within the namespace More...
 
virtual void setManageRealm (bool val)
 Allows/Disallows this client from adding/removing remote realms into the namespace More...
 
virtual void setOverrideConnectionCount (bool val)
 Allow/Disallows the subject from overriding the maximum connection count More...
 
virtual void setPublishToGlobalDataGroup (bool val)
 Allows/Disallows publishing to the default datagroup More...
 
virtual void setTakeOwnershipOfDataGroup (bool val)
 Allows/Disallows taking ownership of datagroups More...
 
virtual void setUseAdminAPI (bool val)
 Allows/Disallows this subject from accessing the realms Admin API functions More...
 
- Public Member Functions inherited from com.pcbsys.nirvana.nAdminAPI.nACLEntry
virtual bool canList ()
 * Can this subject list the contents of an ACL More...
 
virtual bool canModify ()
 * Can this subject modify acl entries in a secure object More...
 
virtual nACLEntry clone ()
 * Returns a clone of the nChannelACLEntry More...
 
bool Equals (long aLong)
 * Required as part of the SortedObject interface. More...
 
override bool Equals (object item)
 * Used to compares this Object with another to determine sorting position. More...
 
virtual BitArray getBitset ()
 Get the bitset containing ACL permissions for this subject More...
 
virtual string getHost ()
 * Returns the host portion of the subject More...
 
virtual string getSubject ()
 * This method returns the completed subject User More...
 
virtual bool hasFullPrivileges ()
 * Does this csubject have full privileges for the secure object. More...
 
virtual bool isGroup ()
 Returns true if subject of this ACL entry is a group More...
 
virtual bool lessThan (long aLong)
 * Required as part of the SortedObject interface. More...
 
virtual bool lessThan (object item)
 * Used to compares this Object with another to determine sorting position More...
 
 nACLEntry (string name, string host)
 * Creates a new nACLEntry with the subject being name. More...
 
 nACLEntry (string subject)
 * Creates a new nACLEntry with the string argument of the form name. More...
 
 nACLEntry (nSecurityGroup grp)
 Creates a new nACLEntry with the given Security Group There are no default permissions set so this subject can perform NO actions on the secured objects More...
 
 nACLEntry (nSecurityGroup grp, BitArray bs)
 Creates a new nACLEntry with the given Security Group. More...
 
 nACLEntry (fAclGroup grp, BitArray bs)
 Creates a new nACLEntry with the given ACL Group. More...
 
virtual void setFullPrivileges (bool val)
 * Sets the subject to have full privileges for this secure object allowing the subject complete More...
 
virtual void setList (bool val)
 * Changes the current setting for this user to allow/disallow ACL listing

More...
 
virtual void setModify (bool val)
 * Changes the current setting for this subject to allow/disallow modifing ACL. More...
 
virtual void setPermissions (long permValue)
 This method is for internal use only More...
 

Additional Inherited Members

- Properties inherited from com.pcbsys.nirvana.nAdminAPI.nACLEntry
virtual string Name [get]
 * Returns the name of the ACLEntry More...
 

Detailed Description

Extends the nACLEntry class to expose the Realm specific permissions

nACLEntry

Constructor & Destructor Documentation

com.pcbsys.nirvana.nAdminAPI.nRealmACLEntry.nRealmACLEntry ( string  name,
string  host 
)

Creates a new nRealmACLEntry with the supplied name.

This class is used to manage subjects and their privileges they have on a realm.

Parameters
nameThe name of the subject
hostThe host name for the subject
Exceptions
nAdminIllegalArgumentExceptionif an invalid or null argument is passed
com.pcbsys.nirvana.nAdminAPI.nRealmACLEntry.nRealmACLEntry ( string  subject)

Creates a new nRealmACLEntry with the supplied name.

This class is used to manage subjects and their privileges they have on a realm.

Parameters
subjectof the form user
Exceptions
nAdminIllegalArgumentExceptionif an invalid or null argument is passed
com.pcbsys.nirvana.nAdminAPI.nRealmACLEntry.nRealmACLEntry ( nSecurityGroup  grp)

Creates a new nRealmACLEntry with the supplied name.

This class is used to manage subjects and their privileges they have on a realm.

Parameters
subjectof the form user
Exceptions
nAdminIllegalArgumentExceptionif an invalid or null argument is passed
com.pcbsys.nirvana.nAdminAPI.nRealmACLEntry.nRealmACLEntry ( string  subject,
nACLEntry  copy 
)

Creates a new nRealmACLEntry with the supplied name.

This class is used to manage subjects and their privileges they have on a realm.

Parameters
subjectof the form user
copyAn nACLEntry to copy the current permissions from
Exceptions
nAdminIllegalArgumentExceptionif an invalid or null argument is passed

Member Function Documentation

virtual bool com.pcbsys.nirvana.nAdminAPI.nRealmACLEntry.canAccessTheRealm ( )
virtual

Can this Subject connect and use this realm.

If false the subject will be disconnected during the authentication stage.

Returns
The current configuration
virtual bool com.pcbsys.nirvana.nAdminAPI.nRealmACLEntry.canConfigureRealm ( )
virtual

Can this subject set/get runtime configuration values for the realm

Returns
The current configuration
virtual bool com.pcbsys.nirvana.nAdminAPI.nRealmACLEntry.canManageChannels ( )
virtual

Can this subject make/delete or perform maintance on channels within this realm.

This permission is extends only for this realm within the namespace.

Returns
The current configuration
virtual bool com.pcbsys.nirvana.nAdminAPI.nRealmACLEntry.canManageDataGroups ( )
virtual

Can this subject manage datagroups for the realm

Returns
The current configuration
virtual bool com.pcbsys.nirvana.nAdminAPI.nRealmACLEntry.canManageJoins ( )
virtual

Can this subject create/remove/list joins between channels within the namespace

Returns
The current configuration
virtual bool com.pcbsys.nirvana.nAdminAPI.nRealmACLEntry.canManageRealm ( )
virtual

Can this Subject add/remove remote realms into this realms namespace.

Returns
The current configuration
virtual bool com.pcbsys.nirvana.nAdminAPI.nRealmACLEntry.canOverrideConnectionCount ( )
virtual

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

Returns
The current configuration
virtual bool com.pcbsys.nirvana.nAdminAPI.nRealmACLEntry.canPublishToGlobalDataGroup ( )
virtual

Can this subject publish to the default datagroup for the realm

Returns
The current configuration
virtual bool com.pcbsys.nirvana.nAdminAPI.nRealmACLEntry.canTakeOwnershipOfDataGroup ( )
virtual

Can this subject take ownership of datagroups on this realm

Returns
The current configuration
virtual bool com.pcbsys.nirvana.nAdminAPI.nRealmACLEntry.canUseAdminAPI ( )
virtual

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

Returns
The current configuration
virtual void com.pcbsys.nirvana.nAdminAPI.nRealmACLEntry.setAccessTheRealm ( bool  val)
virtual

Allows/Disallows this subject the ability to connect and use the realm

Parameters
valBoolean value to set
virtual void com.pcbsys.nirvana.nAdminAPI.nRealmACLEntry.setConfigureRealm ( bool  val)
virtual

Allows/Disallows setting realm configuration values

Parameters
valBoolean value to set
virtual void com.pcbsys.nirvana.nAdminAPI.nRealmACLEntry.setManageChannels ( bool  val)
virtual

Allow/Disallows this subject from making/deleteing or performing maintenance on any channel on the realm

Parameters
valBoolean value to set
virtual void com.pcbsys.nirvana.nAdminAPI.nRealmACLEntry.setManageDataGroups ( bool  val)
virtual

Allows/Disallows datagroup management operations

Parameters
valBoolean value to set
virtual void com.pcbsys.nirvana.nAdminAPI.nRealmACLEntry.setManageJoins ( bool  val)
virtual

Allows/Disallows this subject from managing the joins between channels within the namespace

Parameters
valBoolean value to set
virtual void com.pcbsys.nirvana.nAdminAPI.nRealmACLEntry.setManageRealm ( bool  val)
virtual

Allows/Disallows this client from adding/removing remote realms into the namespace

Parameters
valBoolean value to set
virtual void com.pcbsys.nirvana.nAdminAPI.nRealmACLEntry.setOverrideConnectionCount ( bool  val)
virtual

Allow/Disallows the subject from overriding the maximum connection count

Parameters
valBoolean value to set
virtual void com.pcbsys.nirvana.nAdminAPI.nRealmACLEntry.setPublishToGlobalDataGroup ( bool  val)
virtual

Allows/Disallows publishing to the default datagroup

Parameters
valBoolean value to set
virtual void com.pcbsys.nirvana.nAdminAPI.nRealmACLEntry.setTakeOwnershipOfDataGroup ( bool  val)
virtual

Allows/Disallows taking ownership of datagroups

Parameters
valBoolean value to set
virtual void com.pcbsys.nirvana.nAdminAPI.nRealmACLEntry.setUseAdminAPI ( bool  val)
virtual

Allows/Disallows this subject from accessing the realms Admin API functions

Parameters
valBoolean value to set