com.pcbsys.nirvana.nAdminAPI.nACL Class Reference

represents a list of nACLEntry classes used by the Nirvana Realm server to control access to secured objects such as Realms, Channels and Queues. More...

Inheritance diagram for com.pcbsys.nirvana.nAdminAPI.nACL:
com.pcbsys.nirvana.client.Observable

Public Member Functions

virtual void add (nACLEntry entry)
 Adds a new nACLEntry into the list. More...
 
virtual bool contains (string subject)
 Returns whether an nACLEntry exists the nACL which matches this subject. More...
 
virtual nACLEntry find (string subject)
 Finds an nACLEntry within the list which matches this subject. More...
 
virtual nACLEntry find (nACLEntry entry)
 Finds an nACLEntry which matches the passed in nACLEntry. More...
 
virtual nACLEntry get (int index)
 Returns the nACLEntry specified by the index parameter is useful to examine/walk the list. More...
 
virtual
System.Collections.IEnumerator 
getEntries ()
 Returns an IEnumerator of nACLEntry objects which make up the list. More...
 
virtual void remove (string subject)
 Removes the nACLEntry which matches the subject specified by the string passed in. More...
 
virtual void remove (nACLEntry entry)
 Removes the nACLEntry which matches the subject specified the nACLEntry object. More...
 
virtual void removeAll ()
 Removes ALL of the nACLEntry objects from the list. More...
 
virtual void replace (nACLEntry entry)
 Replaces the existing nACLEntry priviliges with the passed nACLEntry. More...
 
virtual int size ()
 Returns the number of entries within the list More...
 
- Public Member Functions inherited from com.pcbsys.nirvana.client.Observable
void addObserver (IObserver o)
 Adds an observer to the set of observers for this object, provided that it is not the same as some observer already in the set. More...
 
int countObservers ()
 Returns the number of observers of this Observable object. More...
 
void deleteObserver (IObserver o)
 Deletes an observer from the set of observers of this object. More...
 
void deleteObservers ()
 Clears the observer list so that this object no longer has any observers. More...
 
bool hasChanged ()
 Tests if this object has changed. More...
 
void notifyObservers ()
 If this object has changed, as indicated by the hasChanged method, then notify all of its observers and then call the clearChanged method to indicate that this object has no longer changed. More...
 
void notifyObservers (Object arg)
 If this object has changed, as indicated by the More...
 
 Observable ()
 Construct an Observable with zero Observers. More...
 

Additional Inherited Members

- Protected Member Functions inherited from com.pcbsys.nirvana.client.Observable
void clearChanged ()
 Indicates that this object has no longer changed, or that it has already notified all of its observers of its most recent change, so that the hasChanged method will now return false. More...
 
void setChanged ()
 Marks this Observable object as having been changed; the hasChanged method will now return true. More...
 

Detailed Description

represents a list of nACLEntry classes used by the Nirvana Realm server to control access to secured objects such as Realms, Channels and Queues.

nACLEntry

Member Function Documentation

virtual void com.pcbsys.nirvana.nAdminAPI.nACL.add ( nACLEntry  entry)
virtual

Adds a new nACLEntry into the list.

Parameters
entryThe new nACLEntry to add to the list
Exceptions
nDuplicateACLEntryExceptionIf the entry already exists in the list
nAdminIllegalArgumentExceptionif the entry is null
nBaseAdminExceptionUnable to perform the requested operation, check the message for further information
virtual bool com.pcbsys.nirvana.nAdminAPI.nACL.contains ( string  subject)
virtual

Returns whether an nACLEntry exists the nACL which matches this subject.

Parameters
subjectString representation of the subject (user)
Returns
whether a matching acl entry exists
Exceptions
nAdminIllegalArgumentExceptionthrown if acl entry is null
virtual nACLEntry com.pcbsys.nirvana.nAdminAPI.nACL.find ( string  subject)
virtual

Finds an nACLEntry within the list which matches this subject.

If it could not find a match it will throw nACLEntryNotFoundException

Parameters
subjectString representation of the subject (user)
Returns
the nACLEntry which matched
Exceptions
nACLEntryNotFoundExceptionthrown if acl entry is not found
nAdminIllegalArgumentExceptionthrown if acl entry is null
virtual nACLEntry com.pcbsys.nirvana.nAdminAPI.nACL.find ( nACLEntry  entry)
virtual

Finds an nACLEntry which matches the passed in nACLEntry.

The comparision is done on the subject only and not the permissions since the subject must be unique in the list. If it could not find a match it will throw nACLEntryNotFoundException

Parameters
entryA nACLEntry to locate within the list
Returns
the nACLEntry which matches
Exceptions
nACLEntryNotFoundExceptionthrown if acl entry is not found
nAdminIllegalArgumentExceptionthrown if acl entry is null
virtual nACLEntry com.pcbsys.nirvana.nAdminAPI.nACL.get ( int  index)
virtual

Returns the nACLEntry specified by the index parameter is useful to examine/walk the list.

Parameters
indexthe index position of the nACLEntry to be retrieved
Exceptions
nAdminIllegalArgumentExceptionthrown if the index specified is out of range or less than 0.
Returns
the nACLEntry object at the specified index
virtual System.Collections.IEnumerator com.pcbsys.nirvana.nAdminAPI.nACL.getEntries ( )
virtual

Returns an IEnumerator of nACLEntry objects which make up the list.

This is useful to examine/walk the list.

Returns
IEnumerator of nACLEntry objects
virtual void com.pcbsys.nirvana.nAdminAPI.nACL.remove ( string  subject)
virtual

Removes the nACLEntry which matches the subject specified by the string passed in.

Currently no wild card removals are supported so only a direct match will result in the removal of the nACLEntry

Parameters
subjectString representation of the subject (user)
Exceptions
nACLEntryNotFoundExceptionthrown if acl entry is not found
nAdminIllegalArgumentExceptionthrown if acl entry is null
virtual void com.pcbsys.nirvana.nAdminAPI.nACL.remove ( nACLEntry  entry)
virtual

Removes the nACLEntry which matches the subject specified the nACLEntry object.

Parameters
entryThe nACLEntry to be removed from the list
Exceptions
nACLEntryNotFoundExceptionthrown if acl entry is not found
nAdminIllegalArgumentExceptionthrown if acl entry is null
virtual void com.pcbsys.nirvana.nAdminAPI.nACL.removeAll ( )
virtual

Removes ALL of the nACLEntry objects from the list.

WARNING: if you commit an empty nACL you will effectivily block ALL access to the secure object. There is no way to override this so be careful when calling this function that you do actually add nACLEntry objects to this to at least allow the administrator back in

virtual void com.pcbsys.nirvana.nAdminAPI.nACL.replace ( nACLEntry  entry)
virtual

Replaces the existing nACLEntry priviliges with the passed nACLEntry.

Useful for changing permissions for a subject within a list

Parameters
entryThe nACLEntry containing the updated priviliges
Exceptions
nACLEntryNotFoundExceptionOnly if the entry could not be found
nAdminIllegalArgumentExceptionif the entry is null
virtual int com.pcbsys.nirvana.nAdminAPI.nACL.size ( )
virtual

Returns the number of entries within the list

Returns
int size of this list