All classes that exist in the Nirvana Realm NameSpace extend this object. More...

#include <nNode.h>

Inheritance diagram for com::pcbsys::nirvana::nAdminAPI::nNode:

Public Member Functions
virtual BitArray *	convertLong (longlong priv)
	Converts from a long to a bitArray used to specify ACL properties. More...

virtual nACLEntry *	createACLEntry (const std::string &subject, BitArray *pBs)
	Adds a specific acl entry to the leaf node acl. More...

virtual nACLEntry *	createACLEntry (nSecurityGroup grp, BitArray pBs)
	Adds a specific security group to the leaf node acl. More...

virtual bool	Equals (nNode *pItem)
	Check if this nNode is the same as the nNode passed in. More...

virtual bool	Equals (const std::string &item)
	Check if the string passed in matches the name of this nNode. More...

virtual const std::string &	getAbsolutePath ()
	This function walks the tree to the root to generate a fully qualified name for this node. More...

const std::string &	getInternalName ()
	Returns the name of this nNode. More...

const std::string &	getName ()
	Returns the name of the node. More...

virtual nNode *	getParent ()
	Returns this nodes parent node. More...

virtual std::string	getRelativePath (nNode *pTop)
	This method returns the relative path from this node to the nNode passed. More...

virtual bool	IsRemovable ()
	Returns true if this nNode can be removed. More...

Detailed Description

All classes that exist in the Nirvana Realm NameSpace extend this object.

This object contains generic functions such as getName and getAbsolutePath etc.

Member Function Documentation

virtual BitArray* com::pcbsys::nirvana::nAdminAPI::nNode::convertLong ( longlong priv )

virtual

Converts from a long to a bitArray used to specify ACL properties.

Parameters

priv	a longlong representation of the ACL properties to set

Returns: BitArray the BitArray generated from the longlong

virtual nACLEntry* com::pcbsys::nirvana::nAdminAPI::nNode::createACLEntry	(	const std::string &	subject,
		BitArray *	pBs
	)

virtual

Adds a specific acl entry to the leaf node acl.

Parameters

subject	the subject the ACL is assigned to
*pBs	the bitArray representing the ACL settings to be used

Exceptions

nInsufficientPrivilegesException	If the user is not permissioned to perform this operation
nNodeException	if the ACLs being set are invalid
nBaseAdminException	if unable to perform the operation, check the message for further information

Reimplemented in com::pcbsys::nirvana::nAdminAPI::nRealmNode, and com::pcbsys::nirvana::nAdminAPI::nLeafNode.

virtual nACLEntry* com::pcbsys::nirvana::nAdminAPI::nNode::createACLEntry	(	nSecurityGroup *	grp,
		BitArray *	pBs
	)

virtual

Adds a specific security group to the leaf node acl.

Parameters

*grp	the security group the ACL is assigned to
*pBs	the bitArray representing the ACL settings to be used

Exceptions

nInsufficientPrivilegesException	If the user is not permissioned to perform this operation
nNodeException	if the ACLs being set are invalid
nBaseAdminException	if unable to perform the operation, check the message for further information

Reimplemented in com::pcbsys::nirvana::nAdminAPI::nRealmNode, and com::pcbsys::nirvana::nAdminAPI::nLeafNode.

virtual bool com::pcbsys::nirvana::nAdminAPI::nNode::Equals ( nNode * pItem )

virtual

Check if this nNode is the same as the nNode passed in.

Parameters

*PItem the nNode to compare this nNode to

Returns: bool true if the nNode matches this nNode

virtual bool com::pcbsys::nirvana::nAdminAPI::nNode::Equals ( const std::string & item )

virtual

Check if the string passed in matches the name of this nNode.

Parameters

item	the string to compare the name of this node to

Returns: bool true if the string matches the name of this nNode

virtual const std::string& com::pcbsys::nirvana::nAdminAPI::nNode::getAbsolutePath ( )

virtual

This function walks the tree to the root to generate a fully qualified name for this node.

Returns: String full path and name

Reimplemented in com::pcbsys::nirvana::nAdminAPI::nLeafNode.

const std::string& com::pcbsys::nirvana::nAdminAPI::nNode::getInternalName ( )

Returns the name of this nNode.

Returns: string containing the name of this nNode

const std::string& com::pcbsys::nirvana::nAdminAPI::nNode::getName ( )

Returns the name of the node.

Returns: string name of the node

virtual nNode* com::pcbsys::nirvana::nAdminAPI::nNode::getParent ( )

virtual

Returns this nodes parent node.

If this node is the root it will return null

Returns: nNode of the parent

virtual std::string com::pcbsys::nirvana::nAdminAPI::nNode::getRelativePath ( nNode * pTop )

virtual

This method returns the relative path from this node to the nNode passed.

Note. It is assumed that the nNode passed is a parent node, this method will not locate nodes in different parts of the tree.

Parameters

nNode *ptop Node to get relative path to

Returns: String path relative to the node passed in

virtual bool com::pcbsys::nirvana::nAdminAPI::nNode::IsRemovable ( )

virtual

Returns true if this nNode can be removed.

Returns: bool true if the nNode can be removed

Reimplemented in com::pcbsys::nirvana::nAdminAPI::nRealmNode, com::pcbsys::nirvana::nAdminAPI::nLeafNode, and com::pcbsys::nirvana::nAdminAPI::nLinkNode.

Public Member Functions

Detailed Description

Member Function Documentation