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:


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

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.

See also:: nACLEntry

Parameters:

	name	Name for the subject
	host	Host name for the subject

Exceptions:

nAdminIllegalArgumentException

if an invalid or null argument is passed

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.

See also:: nACLEntry

Parameters:

subject

of the form user

Exceptions:

nAdminIllegalArgumentException

if an invalid or null argument is passed

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.

See also:: nACLEntry

Parameters:

	subject	of the form user
	copy	An nACLEntry to copy the current permissions from

Exceptions:

nAdminIllegalArgumentException

if an invalid or null argument is passed

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:

val