com.pcbsys.nirvana.nAdminAPI.nACLEntry Class Reference

* Contains the mapping between a subject User and the priviliges they can perform More...

Inheritance diagram for com.pcbsys.nirvana.nAdminAPI.nACLEntry:
com.pcbsys.nirvana.nAdminAPI.nChannelACLEntry com.pcbsys.nirvana.nAdminAPI.nInterfaceViaEntry com.pcbsys.nirvana.nAdminAPI.nRealmACLEntry com.pcbsys.nirvana.nAdminAPI.nServiceACLEntry

Public Member Functions

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

Properties

virtual string Name [get]
 * Returns the name of the ACLEntry More...
 

Detailed Description

* Contains the mapping between a subject User and the priviliges they can perform

  • on a secured object such as a Realm, Channel or Queue.
  • On construction of these objects the name string can be set to "*" meaning All users and
  • the host cal also be set to "*". For example, all users from a host called test.com can be configured
  • such as *

Constructor & Destructor Documentation

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

* Creates a new nACLEntry with the subject being name.

There are no

  • default permissions set so this subject can perform NO actions on the secured objects
  • Parameters
    nameUsername/Token for the subject
  • Parameters
    hostthe host they can connect from
  • Exceptions
    nAdminIllegalArgumentExceptionif an invalid or null argument is passed
com.pcbsys.nirvana.nAdminAPI.nACLEntry.nACLEntry ( string  subject)

* Creates a new nACLEntry with the string argument of the form name.

There are no

  • default permissions set so this subject can perform NO actions on the secured objects
com.pcbsys.nirvana.nAdminAPI.nACLEntry.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

Parameters
grpSecurity group used to form this ACL entry
com.pcbsys.nirvana.nAdminAPI.nACLEntry.nACLEntry ( nSecurityGroup  grp,
BitArray  bs 
)

Creates a new nACLEntry with the given Security Group.

The subject will have permissions defined in the input BitArray.

Parameters
grpSecurity group used to form this ACL entry
bsBitArray containing permissions for this subject
com.pcbsys.nirvana.nAdminAPI.nACLEntry.nACLEntry ( fAclGroup  grp,
BitArray  bs 
)

Creates a new nACLEntry with the given ACL Group.

The subject will have permissions defined in the input BitArray.

Parameters
grpACL group used to form this ACL entry
bsBitArray containing permissions for this subject

Member Function Documentation

virtual bool com.pcbsys.nirvana.nAdminAPI.nACLEntry.canList ( )
virtual

* Can this subject list the contents of an ACL

  • Returns
    a boolean indicating the current permission status for this user
virtual bool com.pcbsys.nirvana.nAdminAPI.nACLEntry.canModify ( )
virtual

* Can this subject modify acl entries in a secure object

  • Returns
    a boolean indicating the current permission status for this user
virtual nACLEntry com.pcbsys.nirvana.nAdminAPI.nACLEntry.clone ( )
virtual

* Returns a clone of the nChannelACLEntry

  • Returns
    a clone of the current object
bool com.pcbsys.nirvana.nAdminAPI.nACLEntry.Equals ( long  aLong)

* Required as part of the SortedObject interface.

For internal use only

override bool com.pcbsys.nirvana.nAdminAPI.nACLEntry.Equals ( object  item)

* Used to compares this Object with another to determine sorting position.

For internal

  • use only
  • Parameters
    itemObject to compare
  • Returns
    True if this object is equal to the passed in object
virtual BitArray com.pcbsys.nirvana.nAdminAPI.nACLEntry.getBitset ( )
virtual

Get the bitset containing ACL permissions for this subject

Returns
the bitset with ACL permissions
virtual string com.pcbsys.nirvana.nAdminAPI.nACLEntry.getHost ( )
virtual

* Returns the host portion of the subject

  • Returns
    The hostname
virtual string com.pcbsys.nirvana.nAdminAPI.nACLEntry.getSubject ( )
virtual

* This method returns the completed subject User

  • Returns
    String representation of the subject
virtual bool com.pcbsys.nirvana.nAdminAPI.nACLEntry.hasFullPrivileges ( )
virtual

* Does this csubject have full privileges for the secure object.

This privlege enables the

  • subject to perform ANY action against this secure object if set to true.
  • Returns
    a boolean indicating the current permission status for this user
virtual bool com.pcbsys.nirvana.nAdminAPI.nACLEntry.isGroup ( )
virtual

Returns true if subject of this ACL entry is a group

Returns
bool True if subject is a group, False otherwise
virtual bool com.pcbsys.nirvana.nAdminAPI.nACLEntry.lessThan ( long  aLong)
virtual

* Required as part of the SortedObject interface.

For internal use only

virtual bool com.pcbsys.nirvana.nAdminAPI.nACLEntry.lessThan ( object  item)
virtual

* Used to compares this Object with another to determine sorting position

  • Parameters
    itemObject to compare
  • Returns
    True if this object is less then the passed in object
virtual void com.pcbsys.nirvana.nAdminAPI.nACLEntry.setFullPrivileges ( bool  val)
virtual

* 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. Should only set what is required rather than this
  • entry. By default the realm server will automatically set this for the default administrator
  • Parameters
    valtrue for full, false otherwise
virtual void com.pcbsys.nirvana.nAdminAPI.nACLEntry.setList ( bool  val)
virtual

* Changes the current setting for this user to allow/disallow ACL listing

  • WARNING: Should be used in conjuction with ModifyACL
  • Parameters
    valboolean specifying the permission status
virtual void com.pcbsys.nirvana.nAdminAPI.nACLEntry.setModify ( bool  val)
virtual

* Changes the current setting for this subject to allow/disallow modifing ACL.

  • WARNING: Should not be given to normal subjects but only to subjects which need
  • to administor the Secure Object.
  • Parameters
    valboolean specifying the permission status
virtual void com.pcbsys.nirvana.nAdminAPI.nACLEntry.setPermissions ( long  permValue)
virtual

This method is for internal use only

Parameters
permValue

Property Documentation

virtual string com.pcbsys.nirvana.nAdminAPI.nACLEntry.Name
get

* Returns the name of the ACLEntry

  • Returns
    String name