VOS::VobjectBase Class Reference
[libvos]

#include <vos/vos/vobjectbase.hh>

Inheritance diagram for VOS::VobjectBase:

List of all members.

Detailed Description

A base implementation class for virtual objects.

Except for a few implementation-specific added methods, the API is the same as Vobject.

Definition at line 95 of file vobjectbase.hh.

Public Member Functions

virtual ~VobjectBase ()
VobjectState & getVobjectState ()
virtual const std::string & getSiteName () const
virtual VUtil::vRef< Site > getSite () const
virtual const VUtil::URL & getURL () const
virtual bool isLocal ()
virtual bool isRemote ()
virtual void cacheChildren (bool b)
Specify if this vobject's child list should be cached locally.
virtual void cacheParents (bool b)
Specify if this vobject's parent set should be cached locally.
virtual TypeSetIterator getTypes (Vobject *requester)
virtual TypeSetIterator getTypes ()
virtual void addType (Vobject *requester, const std::string &s)
virtual void addType (const std::string &s)
Adds a new type to this object's type set.
virtual void removeType (Vobject *requester, const std::string &s)
virtual void removeType (const std::string &s)
Remove a type from the type set.
virtual ParentSetIterator getParents (Vobject *requester)
virtual ParentSetIterator getParents ()
Get the set of parent-child relationships in which this object is the child.
virtual ChildListIterator getChildren (Vobject *requester, int start=0, int end=-1)
virtual ChildListIterator getChildren (int start=0, int end=-1)
Get the children of this Vobject.
virtual int numChildren (Vobject *requester)
virtual int numChildren ()
virtual VUtil::vRef< Vobject > findObject (Vobject *requester, const std::string &path)
virtual VUtil::vRef< Vobject > findObject (const std::string &path)
Follows some path to find the Vobject.
virtual VUtil::vRef< ParentChildRelation > findChild (Vobject *requester, const std::string &path)
virtual VUtil::vRef< ParentChildRelation > findChild (const std::string &path)
Fetch a child.
virtual VUtil::vRef< ParentChildRelation > findChild (Vobject *requester, int pos)
virtual VUtil::vRef< ParentChildRelation > findChild (int pos)
Get the child at a certain position.
virtual VUtil::vRef< ParentChildRelation > findParent (Vobject *requester, Vobject &parent)
virtual VUtil::vRef< ParentChildRelation > findParent (Vobject &parent)
virtual VUtil::vRef< ParentChildRelation > findParent (Vobject *parent)
Find a parent.
virtual void setChild (Vobject *requester, int position, const std::string &contextual_name, Vobject *child)
virtual void setChild (int position, const std::string &contextual_name, Vobject *child)
Replace an entry in the child list with a new entry.
virtual void insertChild (Vobject *requester, int position, const std::string &contextual_name, Vobject *child)
virtual void insertChild (int position, const std::string &contextual_name, Vobject *child)
Insert a child at some position with a new object.
virtual void removeChild (Vobject *requester, ParentChildRelation *pcr, bool strict=true)
virtual void removeChild (ParentChildRelation *pcr, bool strict=true)
Remove the child at some position.
virtual void sendMessage (Message *m)
Delivers a message to the object.
virtual void sendMessage (MessageBlock *m)
Delivers a block of messages to the object.
virtual void sendUpdateMessage (Message *m)
Delivers an update message to this object -- only meaningful if this is a remote object.
virtual void addTypeListener (Vobject *requester, TypeChangeListener *tl, bool refresh=true)
virtual void addTypeListener (TypeChangeListener *tl, bool refresh=true)
Adds some object callback to be notified when the type set changes.
virtual void addParentListener (Vobject *requester, ParentChangeListener *pl, bool refresh=true)
virtual void addParentListener (ParentChangeListener *pl, bool refresh=true)
Adds some object callback to be notified when the parent set changes.
virtual void addChildListener (Vobject *requester, ChildChangeListener *cl, bool refresh=true)
virtual void addChildListener (ChildChangeListener *cl, bool refresh=true)
Adds some object callback to be notified when the child list changes.
virtual void removeTypeListener (Vobject *requester, TypeChangeListener *tl)
virtual void removeTypeListener (TypeChangeListener *tl)
Removes an object callback, previously added with addTypeListener().
virtual void removeParentListener (Vobject *requester, ParentChangeListener *pl)
virtual void removeParentListener (ParentChangeListener *pl)
Removes an object callback, previously added with addParentListener().
virtual void removeChildListener (Vobject *requester, ChildChangeListener *cl)
virtual void removeChildListener (ChildChangeListener *cl)
Removes an object callback, previously added with addChildListener().
virtual void excise ()
Ask that all known references to this object to release their references so the object can be deleted, by calling ObjectExciseListener::notifyObjectExcise().
virtual void saveState (MessageBlock &output, std::set< std::string > &types, bool portable)
Create a message block which, when run, will recreate any non-VOS state related to this vobject (such as property values).
virtual void addFlag (const std::string &flag)
Add a flag string.
virtual void removeFlag (const std::string &flag)
Remove a flag string.
virtual bool checkFlag (const std::string &flag)
Check the flag std::string.
virtual void addVobjectExtension (VobjectExtension *vx)
virtual void addMetaObjectExtension (MetaObject *m)
virtual MetaObjectIterator getMetaObjectExtensions ()
virtual StringIterator getPolicy (Vobject *requester, const std::string &domain, Identity *id)
virtual StringIterator getPolicy (const std::string &domain, Identity *id)
Do an access control lookup; for some identity requesting access, this will return the appropriate policy in some domain based on the current access control lists.
Access control lookup works like this:
1. Check each ACL to see if it lists this Identity. If so, we use that ACL's policy.
2. Otherwise, check each ACL for groups that this Identity belongs to. If the Identity is a member of several Groups that are in different ACLs, then return the policy for each relevant ACL. The caller should check *every* policy to determine pass or fail -- this is up to the caller, but commonly in VOS code if any policy grants permission then permission is given. This means that groups can be used to add permissions, but not take them away! Design you access control scheme accordingly (and make the default permissions as restrictive as possible).
3. Otherwise, because neither the Identity nor any Group it is a member of appear in any ACL, the default access control is returned.
Parameters:

domain the policy domain of interest

id the identity requesting access
virtual StringIterator getAvailablePolicies (Vobject *requester, const std::string &domain)
virtual StringIterator getAvailablePolicies (const std::string &domain)
Returns:
all policies in a particular policy domain that are available for use.
virtual void addToACL (Vobject *requester, const std::string &ACLname, Identity *id)

virtual void addToACL (const std::string &ACLname, Identity *id)

Add an identity to an access control list (ACL).

If this identity exists in another ACL, it will be removed from that ACL first.

Parameters:

	ACLname	the name of the ACL. This is a comma-separated list of the access control policies to apply for each domain. For example "core:read-only,property:accept-all". Order does not matter (it will be sorted) but this access control list name is distict from just "core:read-only"!
	id	the Identity to add

virtual void addToACL (Vobject *requester, const std::string &ACLname, Group *grp)

virtual void addToACL (const std::string &ACLname, Group *grp)

Add a group to an access control list (ACL).

If this group exists in another ACL, it will be removed from that ACL first.

Parameters:

	ACLname	the name of the ACL. This is a comma-separated list of the access control policies to apply for each domain. For example "core:read-only,property:accept-all". Order does not matter (it will be sorted) but this access control list name is distict from just "core:read-only"!
	grp	the Group to add

virtual void removeFromACL (Vobject *requester, const std::string &ACLname, Identity *id)

virtual void removeFromACL (const std::string &ACLname, Identity *id)

Remove an Identity from an access control list (ACL).

The ACL will be deleted when the last member is removed.

Parameters:

	ACLname	the name of the ACL. This is a comma-separated list of the access control policies to apply for each domain. For example "core:read-only,property:accept-all". Order does not matter (it will be sorted) but this access control list name is distict from just "core:read-only"!
	id	the Identity to add

virtual void removeFromACL (Vobject *requester, const std::string &ACLname, Group *grp)

virtual void removeFromACL (const std::string &ACLname, Group *grp)

Remove a Group from an access control list (ACL).

The ACL will be deleted when the last member is removed.

Parameters:

	ACLname	the name of the ACL. This is a comma-separated list of the access control policies to apply for each domain. For example "core:read-only,property:accept-all". Order does not matter (it will be sorted) but this access control list name is distict from just "core:read-only"!
	grp	the Group to add

virtual void deleteACL (Vobject *requester, const std::string &policies)

virtual void deleteACL (const std::string &policies)

Completely delete an ACL.

Parameters:

policies

the name of the ACL. This is a comma-separated list of the access control policies to apply for each domain. For example "core:read-only,property:accept-all". Order does not matter (it will be sorted) but this access control list name is distict from just "core:read-only"!

virtual std::string getDefaultPolicy (Vobject *requester, const std::string &domain)
virtual std::string getDefaultPolicy (const std::string &domain="")
Get the policy that is applied by default if the requester's identity or groups were not found in any ACL.
This is also the policy applied to anonymous users (users with no identity.)

Parameters:

domain the policy domain you are interested in. If blank, returns a comma-separated list of the policy in each domain.
virtual void setDefaultPolicy (Vobject *requester, const std::string &policy)

virtual void setDefaultPolicy (const std::string &policy)

Set the default policy.

Parameters:

policy

the policy. This only affects the domains listed. For example, if your current default policy is "core:read-only,property:accept-all" and you call setDefaultPolicy("property:read-only") the resulting default policy will be "core:read-only,property:read-only".

virtual ACLIterator getAllACLs (Vobject *requester)
virtual ACLIterator getAllACLs ()
Returns:
all access control lists (ACL) that have been set.
void doAccessControlCheck (VobjectEvent &ve)
template<class AccessControlType> std::vector< AccessControlType * > getAccessControlsFor (Vobject *requester, PolicyDomain< AccessControlType > &accessControlPolicies)
virtual VUtil::vRef< VobjectBase > getVobjectBase ()
template<class C> VUtil::vRef< C > queryInterface ()
template<class C> C * queryExtension ()

Static Public Member Functions

template<class T> static void addMessageHandler (const std::string &method, void(T::*messageHandler)(Message *))
template<class T> static void addUpdateHandler (const std::string &method, void(T::*messageHandler)(Message *))
template<class T> static void removeMessageHandler (const std::string &method)
template<class T> static void removeUpdateHandler (const std::string &method)

Protected Member Functions

virtual void setURL (const VUtil::URL &u)
virtual void msgSendImpl (boost::mutex &usehandlers_mutex, HandlerMap &usehandlers, Message *msg)

Friends

class Site

Constructor & Destructor Documentation

virtual VOS::VobjectBase::~VobjectBase ( ) [virtual]

Member Function Documentation

virtual void VOS::VobjectBase::addChildListener	(	ChildChangeListener *	cl,
		bool	refresh = `true`
	)			`[inline, virtual]`

Adds some object callback to be notified when the child list changes.

The

Parameters:

	cl	The listener object.
	refresh	if true, will queue up notification callbacks on the listener fully describing the current state.

[Home]	[About]
[Screenshots]	[Download]
[News]	[Community]
[Documentation]	[Manual]
[Bugs & Requests]	[Wiki]

	domain	the policy domain of interest
	id	the identity requesting access

virtual void VOS::VobjectBase::addChildListener	(	Vobject *	requester,
		ChildChangeListener *	cl,
		bool	refresh = `true`
	)			`[virtual]`

static void VOS::VobjectBase::addMessageHandler	(	const std::string &	method,
		void(T::)(Message )	messageHandler
	)			`[inline, static]`

virtual void VOS::VobjectBase::addParentListener	(	ParentChangeListener *	pl,
		bool	refresh = `true`
	)			`[inline, virtual]`

	pl	the listener object
	refresh	if true, will queue up notification callbacks on the listener fully describing the current state.

virtual void VOS::VobjectBase::addToACL	(	const std::string &	ACLname,
		Group *	grp
	)			`[inline, virtual]`

virtual void VOS::VobjectBase::addType	(	Vobject *	requester,
		const std::string &	s
	)			`[virtual]`

virtual void VOS::VobjectBase::addTypeListener	(	TypeChangeListener *	tl,
		bool	refresh = `true`
	)			`[inline, virtual]`

static void VOS::VobjectBase::addUpdateHandler	(	const std::string &	method,
		void(T::)(Message )	messageHandler
	)			`[inline, static]`

virtual void VOS::VobjectBase::deleteACL	(	Vobject *	requester,
		const std::string &	policies
	)			`[virtual]`

	NoSuchObjectError	if the path is illegal
	AccessControlError	if a remote site reported the user is not allowed that information

virtual VUtil::vRef<ParentChildRelation> VOS::VobjectBase::findChild	(	Vobject *	requester,
		int	pos
	)			`[virtual]`

	NoSuchSiteError	The DNS lookup for the site failed, the site is not listening on the expected port, site peering failed, for whatever other reason the site could not be contacted. Only thrown if there is a site specified in the path.)
	NoSuchObjectError	if that object path does not exist on the site
	BadURLError	if there is a syntax error in the supplied URL
	AccessControlError	if a remote site reported that the user is not allowed that information

virtual VUtil::vRef<Vobject> VOS::VobjectBase::findObject	(	Vobject *	requester,
		const std::string &	path
	)			`[virtual]`

	NoSuchObjectError	if the object is NOT a parent
	AccessControlError	if a remote site reported the user is not allowed that information

std::vector< AccessControlType * > VOS::VobjectBase::getAccessControlsFor	(	Vobject *	requester,
		PolicyDomain< AccessControlType > &	accessControlPolicies
	)			`[inline]`

virtual StringIterator VOS::VobjectBase::getAvailablePolicies	(	Vobject *	requester,
		const std::string &	domain
	)			`[virtual]`

virtual ChildListIterator VOS::VobjectBase::getChildren	(	int	start = `0`,
		int	end = `-1`
	)			`[inline, virtual]`

	start	the position of the first child to return (inclusive)
	end	the position of th elast child to return (inclusive)

VOS::VobjectBase Class Reference [libvos]

Detailed Description

Public Member Functions

Static Public Member Functions

Protected Member Functions

Friends

Constructor & Destructor Documentation

Member Function Documentation

VOS::VobjectBase Class Reference
[libvos]

virtual std::string VOS::VobjectBase::getDefaultPolicy	(	Vobject *	requester,
		const std::string &	domain
	)			`[virtual]`

virtual StringIterator VOS::VobjectBase::getPolicy	(	const std::string &	domain,
		Identity *	id
	)			`[inline, virtual]`

virtual void VOS::VobjectBase::insertChild	(	int	position,
		const std::string &	contextual_name,
		Vobject *	child
	)			`[inline, virtual]`

	position	the position
	contextual_name	This is the name, specific to this parent-child relation, used for refering to this object by path.
	child	the child object, in question

virtual void VOS::VobjectBase::msgSendImpl	(	boost::mutex &	usehandlers_mutex,
		HandlerMap &	usehandlers,
		Message *	msg
	)			`[protected, virtual]`

virtual void VOS::VobjectBase::removeChild	(	ParentChildRelation *	pcr,
		bool	strict = `true`
	)			`[inline, virtual]`

	pcr	ParentChildRelation object describing the child entry to remove.
	strict	Should the position in the supplied parent child relation be strictly followed? If strict is false, then if the parent-child entry at the supplied position does NOT match the contextual name and/or child object, but there is exactly one other entry in the child list which does match the contextual name and child we want to remove, then that entry will be removed instead. If strict is true, an AccessControlError is raised in this situation.