Oracle® Fusion Middleware C++ API Reference for Oracle Coherence
12c (12.1.3.0.0)
E47891-01

coherence/net/ConfigurableAddressProviderFactory.hpp

/*
* ConfigurableAddressProviderFactory.hpp
*
* Copyright (c) 2000, 2014, Oracle and/or its affiliates. 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_CONFIGURABLE_ADDRESS_PROVIDER_FACTORY_HPP
#define COH_CONFIGURABLE_ADDRESS_PROVIDER_FACTORY_HPP

#include "coherence/lang.ns"

#include "coherence/net/AddressProvider.hpp"
#include "coherence/net/AddressProviderFactory.hpp"
#include "coherence/run/xml/XmlConfigurable.hpp"
#include "coherence/run/xml/XmlElement.hpp"

COH_OPEN_NAMESPACE2(coherence,net)

using coherence::run::xml::XmlConfigurable;
using coherence::run::xml::XmlElement;


/**
* An AddressProviderFactory implementation that creates instances of a
* AddressProvider class configured using an XmlElement of the following structure:
* <pre>
*   &lt;!ELEMENT ... (socket-address+ | address-provider)&gt;
*   &lt;!ELEMENT address-provider 
*     (class-name | (class-factory-name, method-name), init-params?&gt;
*   &lt;!ELEMENT socket-address (address, port)&gt;
* </pre>
*
* @author wl  2012.04.04
* @since Coherence 12.1.2
*/
class COH_EXPORT ConfigurableAddressProviderFactory
    : public class_spec<ConfigurableAddressProviderFactory,
        extends<Object>,
        implements<AddressProviderFactory, XmlConfigurable> >
    {
    friend class factory<ConfigurableAddressProviderFactory>;

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

    protected:
        /**
        * Create a new ConfigurableAddressProviderFactory instance.
        */
        ConfigurableAddressProviderFactory();


    // ----- ConfigurableAddressProviderFactory interface -------------------

    public:
        /**
        * Instantiate an AddressProvider configured according to the specified XML.
        * The passed XML has to conform to the following format:
        * <pre>
        *   &lt;!ELEMENT ... (socket-address+ | address-provider)&gt;
        *   &lt;!ELEMENT address-provider
        *     (class-name | (class-factory-name, method-name), init-params?&gt;
        *   &lt;!ELEMENT socket-address (address, port)&gt;
        * </pre>
        *
        * @param vLoader  the optional ClassLoader with which to configure the
        *                 new AddressProvider.
        *
        * @return an instance of the corresponding AddressProvider
        *         implementation.
        */
        virtual AddressProvider::Handle createAddressProvider(ClassLoader::View vLoader = NULL);
    

    // ----- XmlConfigurable interface---------------------------------------

    public:
        /**
        * {@inheritDoc}
        */
        virtual void setConfig(XmlElement::View xml);

        /**
        * {@inheritDoc}
        */
        virtual XmlElement::View getConfig() const;


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

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


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

    protected:
        /**
        * XML configuration for this ConfigurableAddressProviderFactory.
        */
        FinalView<XmlElement> f_vXmlConfig;
    };

COH_CLOSE_NAMESPACE2

#endif // COH_CONFIGURABLE_ADDRESS_PROVIDER_FACTORY_HPP

Copyright © 2000, 2014, Oracle and/or its affiliates. All rights reserved.