vos/corelibs/vos/localvobject.hh

Go to the documentation of this file.

/*
    This file is part of the Virtual Object System of
    the Interreality project (http://interreality.org).

    Copyright (C) 2001-2003 Peter Amstutz

    This library is free software; you can redistribute it and/or
    modify it under the terms of the GNU Lesser General Public
    License as published by the Free Software Foundation; either
    version 2 of the License, or (at your option) any later version.

    This library is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
    Lesser General Public License for more details.

    You should have received a copy of the GNU Lesser General Public
    License along with this library; if not, write to the Free Software
    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307  USA

    Peter Amstutz <tetron@interreality.org>
*/
#ifndef _LOCALVOBJECT_HH_
#define _LOCALVOBJECT_HH_

/** @file
    Defines LocalVobject
*/

#include <vos/corelibs/vos/vosdefs.hh>
#include <vos/corelibs/vos/vobject.hh>

namespace VOS
{
    class Message;
    class MessageBlock;
    class LocalSite;
    class RemoteSite;
    class VobjectAccessControl;
    class URL;
    class VobjectEvent;


/** @class LocalVobject localvobject.hh vos/corelibs/vos/localvobject.hh
 *
 * This class contains the code to respond to messages from remote
    objects inquiring about the Vobject's state.
*/
class VOS_API LocalVobject : public virtual VobjectImplementation
{
private:
    //map<string, Message*> waitForNonces;
    deque<VobjectAccessControl*> accesscontrols;

    void findObjectHandler(Message* m);
    void getTypesHandler(Message* m);
    void getParentsHandler(Message* m);
    void addChildHandler(Message* m);
    void removeChildHandler(Message* m);
    void startListeningHandler(Message* m);
    void stopListeningHandler(Message* m);
    void typeAddHandler(Message* m);
public:
    LocalVobject(const string& name, LocalSite* s, VobjectAccessControl* accesscontrol);
    virtual void sendMessage(Message* m);
    virtual void sendMessage(MessageBlock* m);
    virtual void setURL(const URL& u) { url = u; }

    /** Block until a message bearing a specific nonce is received,
        and return that message.
        @param nonce the nonce string to wait for
        @param timeout maximum time to wait, in seconds, before failing (will throw a TimeoutError)
        @param from the remote site the message is expected from.
        @throw TimeoutError
        @returns the message which matched this nonce.   NOTE YOU MUST CALL release() WHEN DONE OR USE A pREF() BLOCK
    */
    Message* waitFor(const string& nonce, RemoteSite* from, double timeout = VOS_DEFAULT_TIMEOUT);

    /** Insert a new policy into the access policy list.  The access
        policy list is traversed from beginning to end, calling each
        access control policy in order until either a policy returns
        false (deny) or the end of the list is reached.  If access is
        denied, list traversal immediately stops and the requested
        action is denied.  If the end of the list is reached without a
        denial, the requested action is permitted.

        @param pos The position to be inserted into.  As with most
        other parts of VOS, a positive value counts from the beginning
        and a negative value counts from the end.  In particular, a
        position of 0 will insert at the head of the list, making it
        the the first policy to be consulted.  A position of -1 will
        insert at the end of the list, making it the last policy to be
        consulted.

        @param ac the access control policy
    */
    virtual void insertAccessControl(int pos, VobjectAccessControl* ac);

    /** Add a named policy.
        @see VobjectAccessControl::getPolicy
    */
    virtual void insertAccessControl(int pos, const string& policyname);

    /** Remove the access policy at the specified position.
        @param pos the position of the policy in the policy list
        @see insertAccessControl */
    virtual void removeAccessControl(int pos);

    /** Remove all instances of the specified access policy from the policy list.
        @param m the access control policy to remove
        @see insertAccessControl */
    virtual void removeAccessControl(VobjectAccessControl* m);

    /** Remove all policies matching this name. */
    virtual void removeAccessControl(const string& policyname);

    /** @return the current access control policy list.
        @see insertAccessControl */
    virtual const deque<VobjectAccessControl*>& getAccessControls();

    /** Traverse the access policy list and determine whether to allow this event
        @param e the event to permit
        @return true if the event is permitted, false to deny this event
     */
    virtual bool validateAccess(VobjectEvent& e, string& message);

    /** Convenience function which initializes various message fields when
        replying to a message.
        @param v the 'from' object
        @param reply the message whose fields will be filled in
        @param m the message we're replying to, to set the 'to' field
        @param method the method to use
        @note Here is what this method actually does:
        @code
        reply->setType("update");
        reply->setMethod(method);
        reply->setTo(m->getFrom());
        reply->setFrom(v->getURL().getString());
        reply->setNonce(m->getNonce());
        @endcode
        See also RemoteVobject::initReply()
    */
    static void initReply(Vobject* v, Message* reply, Message* m, const string& method);

    virtual void addType(const string& s);

    virtual void setChild(int position, const string& contextual_name, Vobject* child)
        throw (AccessControlError, RemoteError);

    virtual void insertChild(int position, const string& contextual_name, Vobject* child)
        throw (AccessControlError, RemoteError);

    virtual void removeChild(int position)
        throw (AccessControlError, RemoteError);

};
}

#endif

---