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

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

Protected Member Functions

 nChannelACLEntry (fAclGroup grp, BitSet bs) throws nAdminIllegalArgumentException
 Creates a new nChannelACLEntry for the name supplied. More...
 

Detailed Description

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

See Also
nACLEntry

Constructor & Destructor Documentation

com.pcbsys.nirvana.nAdminAPI.nChannelACLEntry.nChannelACLEntry ( String  name,
String  host 
) throws nAdminIllegalArgumentException

Creates a new nChannelACLEntry for the name supplied.

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

Parameters
nameName for the subject
hostHost name for the subject
Exceptions
nAdminIllegalArgumentExceptionif an invalid or null argument is passed
See Also
nACLEntry
com.pcbsys.nirvana.nAdminAPI.nChannelACLEntry.nChannelACLEntry ( String  subject) throws nAdminIllegalArgumentException

Creates a new nChannelACLEntry for the name supplied.

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

Parameters
subjectof the form user
Exceptions
nAdminIllegalArgumentExceptionif an invalid or null argument is passed
See Also
nACLEntry
com.pcbsys.nirvana.nAdminAPI.nChannelACLEntry.nChannelACLEntry ( nSecurityGroup  grp) throws nAdminIllegalArgumentException

Creates a new nChannelACLEntry for the name supplied.

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

Parameters
grpgroup name
Exceptions
nAdminIllegalArgumentExceptionif an invalid or null argument is passed
See Also
nACLEntry
com.pcbsys.nirvana.nAdminAPI.nChannelACLEntry.nChannelACLEntry ( fAclGroup  grp,
BitSet  bs 
) throws nAdminIllegalArgumentException
protected

Creates a new nChannelACLEntry for the name supplied.

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

Parameters
grpgroup name
Exceptions
nAdminIllegalArgumentExceptionif an invalid or null argument is passed
See Also
nACLEntry
com.pcbsys.nirvana.nAdminAPI.nChannelACLEntry.nChannelACLEntry ( String  subject,
nACLEntry  copy 
) throws nAdminIllegalArgumentException

Creates a new nChannelACLEntry for the name supplied.

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

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

Creates a new nChannelACLEntry for the name supplied.

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

Parameters
subjectas an nSecurityGroup
copyAn nACLEntry to copy the current permissions from
Exceptions
nAdminIllegalArgumentExceptionif an invalid or null argument is passed
See Also
nACLEntry

Member Function Documentation

boolean com.pcbsys.nirvana.nAdminAPI.nChannelACLEntry.canGetLastEID ( )

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
boolean com.pcbsys.nirvana.nAdminAPI.nChannelACLEntry.canPop ( )

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
boolean com.pcbsys.nirvana.nAdminAPI.nChannelACLEntry.canPurge ( )

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

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

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
boolean com.pcbsys.nirvana.nAdminAPI.nChannelACLEntry.canUseNamedSubscription ( )

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
boolean com.pcbsys.nirvana.nAdminAPI.nChannelACLEntry.canWrite ( )

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
nChannelACLEntry com.pcbsys.nirvana.nAdminAPI.nChannelACLEntry.clone ( )

Returns a clone of the nChannelACLEntry.

Returns
a clone of the current object
void com.pcbsys.nirvana.nAdminAPI.nChannelACLEntry.setGetLastEID ( boolean  val)

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

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

Allow/Disallow this subject from popping events from a queue.

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

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

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

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

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

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

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

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

Parameters
vala Boolean flag indicating the subject's permission status