com.pcbsys.nirvana.nAdminAPI.nChannelACLEntry Class Reference

Extends the nACLEntry class to supply Channel/Queue specific security settings More...

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

Public Member Functions

virtual bool canGetLastEID ()
 Can this subject get the last event id from the Channel. More...
 
virtual bool canPop ()
 Can this subject POP events from a Queue. More...
 
virtual bool canPurge ()
 Can this subject remove events from the Channel/Queue using the purge methods. More...
 
virtual bool canRead ()
 Can the subject read from the Queue/Channel. More...
 
virtual bool canUseNamedSubscription ()
 Can this subject use a named subscription on the Channel. More...
 
virtual bool canWrite ()
 Can this subject write to the Queue/Channel. More...
 
 nChannelACLEntry (string name, string host)
 Creates a new nChannelACLEntry for the name supplied. More...
 
 nChannelACLEntry (string subject)
 Creates a new nChannelACLEntry for the name supplied. More...
 
 nChannelACLEntry (string subject, nACLEntry copy)
 Creates a new nChannelACLEntry for the name supplied. More...
 
 nChannelACLEntry (nSecurityGroup grp)
 * Creates a new nChannelACLEntry for the name supplied. More...
 
virtual void setGetLastEID (bool val)
 Allow/Disallow this subject from getting the last EID from the Channel More...
 
virtual void setPop (bool val)
 Allow/Disallow this subject from popping events from a queue More...
 
virtual void setPurge (bool val)
 Allow/Disallow this subject from purging events from the queue/channel More...
 
virtual void setRead (bool val)
 Allow/Disallow this subject from reading from the Channel/Queue More...
 
virtual void setUseNamedSubscription (bool val)
 Allow/Disallow this subject from creating a named subscription to a Channel More...
 
virtual void setWrite (bool val)
 Allow/Disallow this subject from writing to the Channel/Queue 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 supply Channel/Queue specific security settings

nACLEntry

Constructor & Destructor Documentation

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

Creates a new nChannelACLEntry for the name supplied.

By default this subject has NO privileges and they must be set.

nACLEntry

Parameters
nameName for the subject
hostHost name for the subject
Exceptions
nAdminIllegalArgumentExceptionif an invalid or null argument is passed
com.pcbsys.nirvana.nAdminAPI.nChannelACLEntry.nChannelACLEntry ( string  subject)

Creates a new nChannelACLEntry for the name supplied.

By default this subject has NO privileges and they must be set.

nACLEntry

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

Creates a new nChannelACLEntry for the name supplied.

By default this subject has NO privileges and they must be set.

nACLEntry

Parameters
subjectof the form user
copyAn nACLEntry to copy the current permissions from
Exceptions
nAdminIllegalArgumentExceptionif an invalid or null argument is passed
com.pcbsys.nirvana.nAdminAPI.nChannelACLEntry.nChannelACLEntry ( nSecurityGroup  grp)

* Creates a new nChannelACLEntry for the name supplied.

By default this

  • subject has NO privileges and they must be set.

Member Function Documentation

virtual bool com.pcbsys.nirvana.nAdminAPI.nChannelACLEntry.canGetLastEID ( )
virtual

Can this subject get the last event id from the Channel.

The Queue does not support this function

Returns
The current subject permission status as a boolean
virtual bool com.pcbsys.nirvana.nAdminAPI.nChannelACLEntry.canPop ( )
virtual

Can this subject POP events from a Queue.

Since a POP is an atomic read/write operation since it removes the event from the queue. However a user can pop events but might not be permissioned to write events to the queue.

Returns
The current subject permission status as a boolean
virtual bool com.pcbsys.nirvana.nAdminAPI.nChannelACLEntry.canPurge ( )
virtual

Can this subject remove events from the Channel/Queue using the purge methods.

Returns
The current subject permission status as a boolean
virtual bool com.pcbsys.nirvana.nAdminAPI.nChannelACLEntry.canRead ( )
virtual

Can the subject read from the Queue/Channel.

If true the subject can pop/peek a queue and subscribe to a channel

Returns
The current subject permission status as a boolean
virtual bool com.pcbsys.nirvana.nAdminAPI.nChannelACLEntry.canUseNamedSubscription ( )
virtual

Can this subject use a named subscription on the Channel.

  • When using a named subscription, the state of the last Event received by the subscription is kept by the Server.
  • If the Connection is dropped and restarted with the same name, the server will automatically start the subscription from where the last event received, without the user needing to supply an Event ID to start from.
Returns
The current subject permission status as a boolean
virtual bool com.pcbsys.nirvana.nAdminAPI.nChannelACLEntry.canWrite ( )
virtual

Can this subject write to the Queue/Channel.

If the secure object is a Channel it means the subject can publish to it, if it is a Queue the subject can push on to the queue.

Returns
The current subject permission status as a boolean
virtual void com.pcbsys.nirvana.nAdminAPI.nChannelACLEntry.setGetLastEID ( bool  val)
virtual

Allow/Disallow this subject from getting the last EID from the Channel

Parameters
vala Boolean flag indicating the subject's permission status
virtual void com.pcbsys.nirvana.nAdminAPI.nChannelACLEntry.setPop ( bool  val)
virtual

Allow/Disallow this subject from popping events from a queue

Parameters
vala Boolean flag indicating the subject's permission status
virtual void com.pcbsys.nirvana.nAdminAPI.nChannelACLEntry.setPurge ( bool  val)
virtual

Allow/Disallow this subject from purging events from the queue/channel

Parameters
vala Boolean flag indicating the subject's permission status
virtual void com.pcbsys.nirvana.nAdminAPI.nChannelACLEntry.setRead ( bool  val)
virtual

Allow/Disallow this subject from reading from the Channel/Queue

Parameters
vala Boolean flag indicating the subject's permission status
virtual void com.pcbsys.nirvana.nAdminAPI.nChannelACLEntry.setUseNamedSubscription ( bool  val)
virtual

Allow/Disallow this subject from creating a named subscription to a Channel

Parameters
vala Boolean flag indicating the subject's permission status
virtual void com.pcbsys.nirvana.nAdminAPI.nChannelACLEntry.setWrite ( bool  val)
virtual

Allow/Disallow this subject from writing to the Channel/Queue

Parameters
vala Boolean flag indicating the subject's permission status