src/client-api/src/include/common/syncml/core/Chal.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
  36
  37 #ifndef INCL_CHAL
  38 #define INCL_CHAL
  39 /** @cond DEV */
  40
  41 #include "base/fscapi.h"
  42 #include "base/util/utils.h"
  43 #include "syncml/core/Constants.h"
  44 #include "syncml/core/Meta.h"
  45 #include "base/globalsdef.h"
  46
  47 BEGIN_NAMESPACE
  48
  49
  50
  51 class Chal {
  52
  53      // ------------------------------------------------------------ Private data
  54     private:
  55        Meta* meta;
  56        void initialize();
  57     // ---------------------------------------------------------- Protected data
  58     public:
  59
  60     Chal();
  61     ~Chal();
  62     /**
  63      * Constructs a new Chal object.
  64      *
  65      * @param meta The meta object - NOT NULL
  66      *
  67      */
  68     Chal (Meta* meta);
  69
  70     // ---------------------------------------------------------- Public methods
  71     /**
  72      * Gets the Meta property
  73      *
  74      * @return meta the Meta property
  75      */
  76     Meta* getMeta();
  77
  78     /**
  79      * Sets the Meta property
  80      *
  81      * @param meta the Meta property
  82      *
  83      */
  84     void setMeta(Meta* meta);
  85
  86     /**
  87      * Returns the nextNonce property or null
  88      *
  89      *  @return the nextNonce property or null
  90      */
  91     NextNonce* getNextNonce();
  92
  93     void setNextNonce(NextNonce* nextNonce);
  94     /**
  95      * Returns the authentication type
  96      *
  97      * @return authentication type.
  98      */
  99     const char* getType();
 100
 101     /**
 102      * Returns the authentication format
 103      *
 104      * @return format the authentication format
 105      */
 106     const char* getFormat();
 107
 108     /**
 109      * Creates a basic authentication challange.
 110      * This will have type = Cred.AUTH_TYPE_BASIC and
 111      * format = Constants.FORMAT_B64
 112      *
 113      * @return the newly created AuthenticationChallange
 114      */
 115     static Chal* getBasicChal();
 116
 117     /**
 118      * Creates a MD5 authentication challange.
 119      * This will have type = Cred.AUTH_TYPE_MD5 and
 120      * format = Constants.FORMAT_B64
 121      *
 122      * @return the newly created AuthenticationChallange
 123      */
 124     static Chal* getMD5Chal();
 125
 126     Chal* clone();
 127
 128 };
 129
 130
 131 END_NAMESPACE
 132
 133 /** @endcond */
 134 #endif