src/client-api/src/include/common/spds/DefaultConfigFactory.h

   1 /*
   2  * Funambol is a mobile platform developed by Funambol, Inc.
   3  * Copyright (C) 2003 - 2007 Funambol, Inc.
   4  *
   5  * This program is free software; you can redistribute it and/or modify it under
   6  * the terms of the GNU Affero General Public License version 3 as published by
   7  * the Free Software Foundation with the addition of the following permission
   8  * added to Section 15 as permitted in Section 7(a): FOR ANY PART OF THE COVERED
   9  * WORK IN WHICH THE COPYRIGHT IS OWNED BY FUNAMBOL, FUNAMBOL DISCLAIMS THE
  10  * WARRANTY OF NON INFRINGEMENT  OF THIRD PARTY RIGHTS.
  11  *
  12  * This program is distributed in the hope that it will be useful, but WITHOUT
  13  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  14  * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
  15  * details.
  16  *
  17  * You should have received a copy of the GNU Affero General Public License
  18  * along with this program; if not, see http://www.gnu.org/licenses or write to
  19  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
  20  * MA 02110-1301 USA.
  21  *
  22  * You can contact Funambol, Inc. headquarters at 643 Bair Island Road, Suite
  23  * 305, Redwood City, CA 94063, USA, or at email address info@funambol.com.
  24  *
  25  * The interactive user interfaces in modified source and object code versions
  26  * of this program must display Appropriate Legal Notices, as required under
  27  * Section 5 of the GNU Affero General Public License version 3.
  28  *
  29  * In accordance with Section 7(b) of the GNU Affero General Public License
  30  * version 3, these Appropriate Legal Notices must retain the display of the
  31  * "Powered by Funambol" logo. If the display of the logo is not reasonably
  32  * feasible for technical reasons, the Appropriate Legal Notices must display
  33  * the words "Powered by Funambol".
  34  */
  35 #ifndef INCL_DEF_CONFIG
  36 #define INCL_DEF_CONFIG
  37 /** @cond DEV */
  38
  39 #include "base/fscapi.h"
  40 #include "spds/AccessConfig.h"
  41 #include "spds/DeviceConfig.h"
  42 #include "spds/SyncSourceConfig.h"
  43 #include "spds/SyncManagerConfig.h"
  44 #include "base/globalsdef.h"
  45
  46 BEGIN_NAMESPACE
  47
  48 /**
  49  * This class is factory for other Config objects.
  50  * It can be inherited to define client specific Config parameters.
  51  */
  52 class DefaultConfigFactory {
  53
  54     public:
  55
  56         DefaultConfigFactory()         ;
  57         virtual ~DefaultConfigFactory();
  58
  59         /*
  60          * Returns a default generated AccessConfig.
  61          * This method can be overrided to get a default client-specific
  62          * AccessConfig.
  63          * @return: AccessConfig pointer allocated new, so it must
  64          *          be freed by the caller.
  65          */
  66         static AccessConfig*     getAccessConfig();
  67
  68         /*
  69          * Returns a default generated DeviceConfig.
  70          * This method should be overrided to get a default client-specific
  71          * DeviceConfig.
  72          * @return: DeviceConfig pointer allocated new, so it must
  73          *          be freed by the caller.
  74          */
  75         static DeviceConfig*     getDeviceConfig();
  76
  77         /*
  78          * Returns a default generated SyncSourceConfig.
  79          * This method should be overrided to get a default client-specific
  80          * SyncSourceConfig.
  81          * @return: SyncSourceConfig pointer allocated new, so it must
  82          *          be freed by the caller.
  83          */
  84         static SyncSourceConfig* getSyncSourceConfig(const char*  name);
  85 };
  86
  87
  88 END_NAMESPACE
  89
  90 /** @endcond */
  91 #endif