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...

Inherits java::util::Observable.


Public Member Functions

synchronized void add (nACLEntry entry) throws nBaseAdminException, nDuplicateACLEntryException, nAdminIllegalArgumentException
 Adds a new nACLEntry into the list.
boolean contains (String subject) throws nAdminIllegalArgumentException
 Returns whether an nACLEntry exists the nACL which matches this subject.
nACLEntry find (nACLEntry entry) throws nACLEntryNotFoundException, nAdminIllegalArgumentException
 Finds an nACLEntry which matches the passed in nACLEntry.
nACLEntry find (String subject) throws nACLEntryNotFoundException, nAdminIllegalArgumentException
 Finds an nACLEntry within the list which matches this subject.
nACLEntry get (int index) throws nAdminIllegalArgumentException
 Returns the nACLEntry specified by the index parameter is useful to examine/walk the list.
Enumeration getEntries ()
 Returns an Enumeration of nACLEntry objects which make up the list.
synchronized void remove (nACLEntry entry) throws nACLEntryNotFoundException, nAdminIllegalArgumentException
 Removes the nACLEntry which matches the subject specified the nACLEntry object.
synchronized void remove (String subject) throws nACLEntryNotFoundException, nAdminIllegalArgumentException
 Removes the nACLEntry which matches the subject specified by the string passed in.
synchronized void removeAll ()
 Removes ALL of the nACLEntry objects from the list.
synchronized void replace (nACLEntry entry) throws nACLEntryNotFoundException, nAdminIllegalArgumentException
 Replaces the existing nACLEntry priviliges with the passed nACLEntry.
int size ()
 Returns the number of entries within the list.

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.

See also:
nACLEntry

Member Function Documentation

synchronized void com.pcbsys.nirvana.nAdminAPI.nACL.add ( nACLEntry  entry  )  throws nBaseAdminException, nDuplicateACLEntryException, nAdminIllegalArgumentException

Adds a new nACLEntry into the list.

Parameters:
entry The new nACLEntry to add to the list
Exceptions:
nDuplicateACLEntryException If the entry already exists in the list
nAdminIllegalArgumentException if the entry is null
nBaseAdminException Unable to perform the requested operation, check the message for further information

boolean com.pcbsys.nirvana.nAdminAPI.nACL.contains ( String  subject  )  throws nAdminIllegalArgumentException

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

Parameters:
subject String representation of the subject (user)
Returns:
whether a matching acl entry exists
Exceptions:
nAdminIllegalArgumentException thrown if acl entry is null

nACLEntry com.pcbsys.nirvana.nAdminAPI.nACL.find ( nACLEntry  entry  )  throws nACLEntryNotFoundException, nAdminIllegalArgumentException

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:
entry A nACLEntry to locate within the list
Returns:
the nACLEntry which matches
Exceptions:
nACLEntryNotFoundException thrown if acl entry is not found
nAdminIllegalArgumentException thrown if acl entry is null

nACLEntry com.pcbsys.nirvana.nAdminAPI.nACL.find ( String  subject  )  throws nACLEntryNotFoundException, nAdminIllegalArgumentException

Finds an nACLEntry within the list which matches this subject.

If it could not find a match it will throw nACLEntryNotFoundException

Parameters:
subject String representation of the subject (user)
Returns:
the nACLEntry which matched
Exceptions:
nACLEntryNotFoundException thrown if acl entry is not found
nAdminIllegalArgumentException thrown if acl entry is null

nACLEntry com.pcbsys.nirvana.nAdminAPI.nACL.get ( int  index  )  throws nAdminIllegalArgumentException

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

Parameters:
index the index position of the nACLEntry to be retrieved
Exceptions:
nAdminIllegalArgumentException thrown if the index specified is out of range or less than 0.
Returns:
the nACLEntry object at the specified index

Enumeration com.pcbsys.nirvana.nAdminAPI.nACL.getEntries (  ) 

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

This is useful to examine/walk the list.

Returns:
Enumeration of nACLEntry

synchronized void com.pcbsys.nirvana.nAdminAPI.nACL.remove ( nACLEntry  entry  )  throws nACLEntryNotFoundException, nAdminIllegalArgumentException

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

Parameters:
entry The nACLEntry to be removed from the list
Exceptions:
nACLEntryNotFoundException thrown if acl entry is not found
nAdminIllegalArgumentException thrown if acl entry is null

synchronized void com.pcbsys.nirvana.nAdminAPI.nACL.remove ( String  subject  )  throws nACLEntryNotFoundException, nAdminIllegalArgumentException

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:
subject String representation of the subject (user)
Exceptions:
nACLEntryNotFoundException thrown if acl entry is not found
nAdminIllegalArgumentException thrown if acl entry is null

synchronized void com.pcbsys.nirvana.nAdminAPI.nACL.removeAll (  ) 

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

synchronized void com.pcbsys.nirvana.nAdminAPI.nACL.replace ( nACLEntry  entry  )  throws nACLEntryNotFoundException, nAdminIllegalArgumentException

Replaces the existing nACLEntry priviliges with the passed nACLEntry.

Useful for changing permissions for a subject within a list

Parameters:
entry The nACLEntry containing the updated priviliges
Exceptions:
nACLEntryNotFoundException Only if the entry could not be found
nAdminIllegalArgumentException if the entry is null

int com.pcbsys.nirvana.nAdminAPI.nACL.size (  ) 

Returns the number of entries within the list.

Returns:
int size of this list