coherence/io/pof/SystemPofContext.hpp

/*
* SystemPofContext.hpp
*
* Copyright 2001-2008 by Oracle. All rights reserved.
*
* Oracle is a registered trademarks of Oracle Corporation and/or its
* affiliates.
*
* This software is the confidential and proprietary information of Oracle
* Corporation. You shall not disclose such confidential and proprietary
* information and shall use it only in accordance with the terms of the
* license agreement you entered into with Oracle.
*
* This notice may not be removed or altered.
*/
#ifndef COH_SYSTEM_POF_CONTEXT_HPP
#define COH_SYSTEM_POF_CONTEXT_HPP

#include "coherence/lang.ns"

#include "coherence/io/ReadBuffer.hpp"
#include "coherence/io/WriteBuffer.hpp"
#include "coherence/io/pof/PofContext.hpp"
#include "coherence/io/pof/PofSerializer.hpp"
#include "coherence/io/pof/PortableObjectSerializer.hpp"
#include "coherence/io/pof/TypedSerializer.hpp"
#include "coherence/util/LongArray.hpp"
#include "coherence/util/Map.hpp"
#include "coherence/util/ThreadGate.hpp"

COH_OPEN_NAMESPACE3(coherence,io,pof)

using coherence::io::ReadBuffer;
using coherence::io::WriteBuffer;
using coherence::util::LongArray;
using coherence::util::Map;
using coherence::util::ThreadGate;


/**
* System-wide {@link PofContext} implementation that allows POF user types to
* be registered programatically.
*
* @author jh  2008.02.21
*/
class COH_EXPORT SystemPofContext
    : public class_spec<SystemPofContext,
        extends<Object>,
        implements<PofContext> >
    {
    friend class factory<SystemPofContext>;

    // ----- constructors ---------------------------------------------------

    private:
        /**
        * @internal
        */
        using this_spec::create;

        /**
        * @internal
        */
        SystemPofContext();


    // ----- SystemPofContext interface -------------------------------------

    public:
        /**
        * Associate a user type with a type identifier and
        * {@link PofSerializer}.
        *
        * @param nTypeId      the type identifier of the specified user type;
        *                     must be greater or equal to 0
        * @param vClass       the user type to register with this PofContext;
        *                     must not be NULL
        * @param vSerializer  the PofSerializer that will be used to
        *                     serialize and deserialize objects of the
        *                     specified class; must not be NULL
        *
        * @throws coherence::lang::IllegalArgumentException on invalid type
        *         identifer, class, or PofSerializer
        */
        virtual void registerUserType(int32_t nTypeId, Class::View vClass,
                PofSerializer::View vSerializer);

        /**
        * Unregister a user type previously registered using the specified
        * type identifier.
        *
        * @param nTypeId  the type identifier of the user type to unregister
        *
        * @throws coherence::lang::IllegalArgumentException  if the specified
        *         user type identifier is unknown to this PofContext
        */
        virtual void unregisterUserType(int32_t nTypeId);


    // ----- PofContext interface -------------------------------------------

    public:
        /**
        * {@inheritDoc}
        */
        virtual PofSerializer::View getPofSerializer(int32_t nTypeId) const;

        /**
        * {@inheritDoc}
        */
        virtual int32_t getUserTypeIdentifier(Object::View v) const;

        /**
        * {@inheritDoc}
        */
        virtual int32_t getUserTypeIdentifier(Class::View vClass) const;

        /**
        * {@inheritDoc}
        */
        virtual int32_t getUserTypeIdentifier(String::View vsClass) const;

        /**
        * {@inheritDoc}
        */
        virtual String::View getClassName(int32_t nTypeId) const;

        /**
        * {@inheritDoc}
        */
        virtual Class::View getClass(int32_t nTypeId) const;

        /**
        * {@inheritDoc}
        */
        virtual bool isUserType(Object::View v) const;

        /**
        * {@inheritDoc}
        */
        virtual bool isUserType(Class::View vClass) const;

        /**
        * {@inheritDoc}
        */
        virtual bool isUserType(String::View vsClass) const;


    // ----- Serializer interface -------------------------------------------

    public:
        /**
        * {@inheritDoc}
        */
        virtual void serialize(WriteBuffer::BufferOutput::Handle hOut,
                Object::View v) const;

        /**
        * {@inheritDoc}
        */
        virtual Object::Holder deserialize(
                ReadBuffer::BufferInput::Handle hIn) const;


    // ----- Object interface -----------------------------------------------

    public:
        /**
        * {@inheritDoc}
        */
        virtual void toStream(std::ostream& out) const;


    // ----- internal methods -----------------------------------------------

    protected:
        /**
        * Ensure that the given user type identifier is valid.
        *
        * @param nTypeId  the user type identifier to validate
        *
        * @throws coherence::lang::IllegalArgumentException if the given user
        *         type identifier is negative
        */
        virtual void validateTypeId(int32_t nTypeId) const;


    // ----- data members ---------------------------------------------------

    protected:
        /**
        * A LongArray of user types, indexed by type identifier.
        */
        const LongArray::Handle m_hlaClass;

        /**
        * A LongArray of PofSerializer objects, indexed by type identifier.
        */
        const LongArray::Handle m_hlaSerializer;

        /**
        * A Map that contains mappings from a registered user type to type
        * identifier.
        */
        const Map::Handle m_hMapTypeId;

        /**
        * ThreadGate used to synchronize access to this PofContext.
        */
        mutable ThreadGate::Handle m_hGate;


    // ----- constants ------------------------------------------------------

    public:
        /**
        * Return the SystemPofContext singleton instance.
        *
        * @return the global SystemPofContext
        */
        static Handle getInstance();
    };


// ----- helper macros ------------------------------------------------------

/**
* Register a PofSerializer with the system PofContext. The call will also
* register the class with the SystemClassLoader.
*
* @param POF_TYPE_ID     the POF type identifier
* @param CLASS           the associated class to register
* @param POF_SERIALIZER  the PofSerializer instance to register
*/
#define COH_REGISTER_POF_SERIALIZER(POF_TYPE_ID, CLASS, POF_SERIALIZER) \
    COH_STATIC_INIT(coherence::io::pof::SystemPofContext::getInstance()-> \
        registerUserType(POF_TYPE_ID, \
            coherence::lang::SystemClassLoader::getInstance()-> \
            registerClass(CLASS), POF_SERIALIZER))

/**
* Register a PortableObject implementation with the system ClassLoader and
* PofContext.
*
* @param POF_TYPE_ID  the POF type identifier
* @param TYPE         the class type to register
*/
#define COH_REGISTER_PORTABLE_CLASS(POF_TYPE_ID, TYPE) \
    COH_REGISTER_POF_SERIALIZER(POF_TYPE_ID, \
        coherence::lang::TypedClass<TYPE >::create(), \
        coherence::io::pof::PortableObjectSerializer::create(POF_TYPE_ID))

/**
* Register a Managed object implementation with the system ClassLoader and
* PofContext.
*
* @param POF_TYPE_ID  the POF type identifier
* @param TYPE         the class type to register
*/
#define COH_REGISTER_MANAGED_CLASS(POF_TYPE_ID, TYPE) \
    COH_REGISTER_POF_SERIALIZER(POF_TYPE_ID, \
        coherence::lang::TypedClass<coherence::lang::Managed<TYPE > >::create(), \
        coherence::io::pof::TypedSerializer<coherence::lang::Managed<TYPE > >::create())

COH_CLOSE_NAMESPACE3

#endif // COH_SYSTEM_POF_CONTEXT_HPP

Copyright (c) 2000-2008 Oracle. All rights reserved.