webservices/wsframework/inc/senlayeredtransportproperties.h
changeset 0 62f9d29f7211
equal deleted inserted replaced
-1:000000000000 0:62f9d29f7211
       
     1 /*
       
     2 * Copyright (c) 2006 Nokia Corporation and/or its subsidiary(-ies).
       
     3 * All rights reserved.
       
     4 * This component and the accompanying materials are made available
       
     5 * under the terms of "Eclipse Public License v1.0"
       
     6 * which accompanies this distribution, and is available
       
     7 * at the URL "http://www.eclipse.org/legal/epl-v10.html".
       
     8 *
       
     9 * Initial Contributors:
       
    10 * Nokia Corporation - initial contribution.
       
    11 *
       
    12 * Contributors:
       
    13 *
       
    14 * Description:    Header declaration
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 
       
    20 
       
    21 
       
    22 
       
    23 
       
    24 
       
    25 #ifndef SEN_LAYERED_TRANSPORT_PROPERTIES_H
       
    26 #define SEN_LAYERED_TRANSPORT_PROPERTIES_H
       
    27 
       
    28 #include "senlayeredxmlproperties.h"
       
    29 
       
    30 class CSenLayeredTransportProperties : public CSenLayeredXmlProperties
       
    31     {
       
    32     public:
       
    33     public:
       
    34         IMPORT_C static CSenLayeredTransportProperties* NewL();
       
    35         IMPORT_C static CSenLayeredTransportProperties* NewLC();
       
    36 
       
    37         IMPORT_C static CSenLayeredTransportProperties* NewL(const TDesC8& aXmlUtf8, CSenXmlReader& aParser);
       
    38         IMPORT_C static CSenLayeredTransportProperties* NewLC(const TDesC8& aXmlUtf8, CSenXmlReader& aParser);
       
    39 
       
    40         IMPORT_C static CSenLayeredTransportProperties* NewL(const CSenElement& aElement);
       
    41         IMPORT_C static CSenLayeredTransportProperties* NewLC(const CSenElement& aElement);
       
    42 
       
    43         IMPORT_C static CSenLayeredTransportProperties* NewL(RStringPool& aStringPool);
       
    44         IMPORT_C static CSenLayeredTransportProperties* NewLC(RStringPool& aStringPool);
       
    45 
       
    46         IMPORT_C static CSenLayeredTransportProperties* NewL(const TDesC8& aXmlUtf8, CSenXmlReader& aParser, RStringPool& aStringPool);
       
    47         IMPORT_C static CSenLayeredTransportProperties* NewLC(const TDesC8& aXmlUtf8, CSenXmlReader& aParser, RStringPool& aStringPool);
       
    48 
       
    49         IMPORT_C static CSenLayeredTransportProperties* NewL(const CSenElement& aElement, RStringPool& aStringPool);
       
    50         IMPORT_C static CSenLayeredTransportProperties* NewLC(const CSenElement& aElement, RStringPool& aStringPool);
       
    51 
       
    52         // From MSenProperties 
       
    53         IMPORT_C virtual void SetReader(CSenXmlReader& aReader);
       
    54         IMPORT_C virtual TSenPropertiesClassType PropertiesClassType();
       
    55         IMPORT_C virtual void WriteToL(RWriteStream& aWriteStream);
       
    56         IMPORT_C virtual void ReadFromL(const TDesC8& aBuffer);
       
    57         IMPORT_C virtual HBufC8* AsUtf8L();
       
    58         IMPORT_C virtual HBufC8* AsUtf8LC();
       
    59         IMPORT_C virtual TInt SetPropertyL(const TDesC8& aName, const TDesC8& aValue);
       
    60         IMPORT_C virtual TInt PropertyL(const TDesC8& aName, TPtrC8& aValue);
       
    61         IMPORT_C virtual TInt SetIntPropertyL(const TDesC8& aName, const TInt aValue);
       
    62         IMPORT_C virtual TInt IntPropertyL(const TDesC8& aName, TInt& aValue);
       
    63         IMPORT_C virtual TInt SetBoolPropertyL(const TDesC8& aName, const TBool aValue);
       
    64         IMPORT_C virtual TInt BoolPropertyL(const TDesC8& aName, TBool& aValue);        
       
    65         IMPORT_C virtual TBool IsSafeToCast(TSenPropertiesClassType aClass);
       
    66         
       
    67         // From MSenLayeredProperties 
       
    68         IMPORT_C virtual void WriteToL(RWriteStream& aWriteStream, TSenPropertiesLayer aLayer);
       
    69         IMPORT_C virtual void ReadFromL(const TDesC8& aBuffer, TSenPropertiesLayer aLayer);
       
    70         IMPORT_C virtual HBufC8* AsUtf8L(TSenPropertiesLayer aLayer);
       
    71         IMPORT_C virtual HBufC8* AsUtf8LC(TSenPropertiesLayer aLayer);
       
    72         IMPORT_C virtual TInt ShrinkTo(TSenPropertiesLayer aLayer);
       
    73         IMPORT_C virtual void ExpandToL(TSenPropertiesLayer aLayer);
       
    74         IMPORT_C virtual TSenPropertiesLayer TopLayer();
       
    75         IMPORT_C virtual TInt SetPropertyL(const TDesC8& aName, const TDesC8& aValue, TSenPropertiesLayer aLayer);
       
    76         IMPORT_C virtual TInt PropertyL(const TDesC8& aName, TPtrC8& aValue, TSenPropertiesLayer aLayer);
       
    77         IMPORT_C virtual TInt PropertyL(const TDesC8& aName, MSenProperty*& aValue, TSenPropertiesLayer aLayer);
       
    78         IMPORT_C virtual TInt PropertyL(const TDesC8& aName, MSenProperty*& aValue);                               
       
    79         IMPORT_C virtual TInt PropertiesByTypeL(const TDesC8& aTypeName, RPointerArray<MSenProperty>& aArray);                                        
       
    80         IMPORT_C virtual TInt SetIntPropertyL(const TDesC8& aName, const TInt aValue, TSenPropertiesLayer aLayer);
       
    81         IMPORT_C virtual TInt IntPropertyL(const TDesC8& aName, TInt& aValue, TSenPropertiesLayer aLayer);
       
    82         IMPORT_C virtual MSenProperties* CloneL() const;
       
    83         IMPORT_C virtual MSenProperties* Clone(TInt& aOkOrError) const;
       
    84         IMPORT_C virtual TInt SetBoolPropertyL(const TDesC8& aName, const TBool aValue, TSenPropertiesLayer aLayer);
       
    85         IMPORT_C virtual TInt BoolPropertyL(const TDesC8& aName, TBool& aValue, TSenPropertiesLayer aLayer);
       
    86         IMPORT_C virtual TInt SetPropertyL(const TDesC8& aName, const TDesC8& aValue, const TDesC8& aType);
       
    87         IMPORT_C virtual TInt PropertyL(const TDesC8& aName, TPtrC8& aValue, TPtrC8& aType);  
       
    88         
       
    89         //common transport properties
       
    90          // New Functions       
       
    91         /**
       
    92         * Gets the IAP ID.
       
    93         * @param aCurrentIapId  A TUint32 reference to be filled in with the
       
    94         *                       value of the IAP ID.
       
    95         * @return               KErrNone if no error, or some of the system
       
    96         *                       wide error codes.
       
    97         */
       
    98         IMPORT_C virtual TInt IapIdL(TUint32& aCurrentIapId);
       
    99 
       
   100         /**
       
   101         * Gets the Proxy Port.
       
   102         * @param aProxyPort  A TInt reference to be filled in with the
       
   103         *                    value of the Proxy Port.
       
   104         * @return            KErrNone if no error, or some of the system
       
   105         *                    wide error codes.
       
   106         */
       
   107         IMPORT_C virtual TInt ProxyPortL(TInt& aProxyPort);
       
   108 
       
   109         /**
       
   110         * Gets the Proxy Host.
       
   111         * @param aProxyHost  A TPtrC8 reference to be filled in with the
       
   112         *                    value of the Proxy Host.
       
   113         * @return            KErrNone if no error, or some of the system
       
   114         *                    wide error codes.
       
   115         */
       
   116         IMPORT_C virtual TInt ProxyHostL(TPtrC8& aProxyHost);
       
   117 
       
   118         /**
       
   119         * Gets the Proxy Usage.
       
   120         * @param aProxyUsage A TBool reference to be filled in with the
       
   121         *                    value of the Proxy Usage.
       
   122         * @return            KErrNone if no error, or some of the system
       
   123         *                    wide error codes.
       
   124         */
       
   125         IMPORT_C virtual TInt ProxyUsageL(TBool& aProxyUsage);
       
   126 
       
   127         /**
       
   128         * Gets the IAP Dialog.
       
   129         * @param aIAPDialog A TBool reference to be filled in with the
       
   130         *                   value of the IAPDialog.
       
   131         * @return           KErrNone if no error, or some of the system
       
   132         *                   wide error codes.
       
   133         */
       
   134         IMPORT_C virtual TInt IAPDialogL(TBool& aIAPDialog);
       
   135 
       
   136         /**
       
   137         * Gets the UserAgent.
       
   138         * @param aUserAgent  A TPtrC8 reference to be filled in with the
       
   139         *                    value of the UserAgent.
       
   140         * @return            KErrNone if no error, or some of the system
       
   141         *                    wide error codes.
       
   142         */
       
   143         IMPORT_C virtual TInt UserAgentL(TPtrC8& aUserAgent);
       
   144         
       
   145         /**
       
   146         * Gets the Device ID.
       
   147         * @param aDeviceID   A TPtrC8 reference to be filled in with the
       
   148         *                    value of the DeviceId.
       
   149         * @return            KErrNone if no error, or some of the system
       
   150         *                    wide error codes.
       
   151         */
       
   152         IMPORT_C virtual TInt DeviceIDL(TPtrC8& aDeviceID);
       
   153         
       
   154         /**
       
   155         * Gets the Action of message
       
   156         * @param aAction A TPtrC8 reference to be filled in with the
       
   157         *                    value of the Action.
       
   158         * @return            KErrNone if no error, or some of the system
       
   159         *                    wide error codes.
       
   160         */
       
   161         IMPORT_C virtual TInt SoapActionL(TPtrC8& aAction);
       
   162         
       
   163         /**
       
   164         * Gets download folder for incoming BLOB (binary large objects)
       
   165         * @param aDownloadFolder - A TPtrC8 reference to be filled in with the
       
   166         *                    value of the shared, public folder for downloaded 
       
   167         *                    content
       
   168         * @return            KErrNone if no error, or some of the system
       
   169         *                    wide error codes.
       
   170         */
       
   171         IMPORT_C virtual TInt DownloadFolderL(TPtrC8& aDownloadFolder);
       
   172 
       
   173         /**
       
   174         * Gets filename of file attachment
       
   175         * @param aCid - cid for filename
       
   176         * @param aFileName - filename of file attachment with current cid
       
   177         * @return            KErrNone if no error, or some of the system
       
   178         *                    wide error codes.
       
   179         */
       
   180         IMPORT_C virtual TInt FileAttachmentL(const TDesC8& aCid, HBufC8*& aFileName);
       
   181         
       
   182         /**
       
   183         * Gets namespace of Microsoft schema
       
   184         * @param aMwsNamespace - namespace
       
   185         * @return            KErrNone if no error, or some of the system
       
   186         *                    wide error codes.
       
   187         */
       
   188         IMPORT_C virtual TInt MwsNamespaceL(TPtrC8& aMwsNamespace);
       
   189         
       
   190         IMPORT_C virtual TInt HeartbeatL(TInt& aHeartbeat);
       
   191 
       
   192         IMPORT_C virtual TInt MaxTimeToLiveL(TInt& aMax);
       
   193 
       
   194         IMPORT_C virtual TInt MinTimeToLiveL(TInt& aMin);
       
   195 		IMPORT_C virtual TInt SetMaxRetryTTLL(TInt aMaxRetryTTL);
       
   196 		IMPORT_C virtual TInt MaxRetryTTLL(TInt& aMaxRetryTTL);
       
   197 		IMPORT_C virtual TInt SetRetryDeltaTimeoutL(TInt aTimeout);
       
   198 		IMPORT_C virtual TInt RetryDeltaTimeoutL(TInt& aTimeout);
       
   199 		IMPORT_C virtual TInt SetMinRetryTTLL(TInt aMinRetryTTL);
       
   200 		IMPORT_C virtual TInt MinRetryTTLL(TInt& aMinRetryTTL);
       
   201 
       
   202         /**
       
   203         * Destructor.
       
   204         */
       
   205         IMPORT_C virtual ~CSenLayeredTransportProperties();
       
   206 
       
   207     protected: // base class functions
       
   208 
       
   209         IMPORT_C virtual void BaseConstructL(const TDesC8& aLocalname, 
       
   210                                     const TDesC8& aXml,
       
   211                                     CSenXmlReader* aParser = NULL,
       
   212                                     RStringPool* aStringPool = NULL);
       
   213 
       
   214         IMPORT_C virtual void BaseConstructL(const TDesC8& aNamespace, 
       
   215                                     const TDesC8& aLocalname, 
       
   216                                     const TDesC8& aXml,
       
   217                                     CSenXmlReader* aParser = NULL,
       
   218                                     RStringPool* aStringPool = NULL);
       
   219 
       
   220         IMPORT_C virtual void BaseConstructL(const TDesC8& aNamespace, 
       
   221                                     const TDesC8& aLocalname, 
       
   222                                     const TDesC8& aQualifiedName, 
       
   223                                     const TDesC8& aXml,
       
   224                                     CSenXmlReader* aParser = NULL,
       
   225                                     RStringPool* aStringPool = NULL);
       
   226 
       
   227         IMPORT_C virtual void BaseConstructL(const CSenElement& aElement, RStringPool* aStringPool = NULL);
       
   228 
       
   229 	public:
       
   230 	/**
       
   231         * Gets the SNAP ID.
       
   232         * @param aCurrentSnapId  A TUint32 reference to be filled in with the
       
   233         *                       value of the SNAP ID.
       
   234         * @return               KErrNone if no error, or some of the system
       
   235         *                       wide error codes.
       
   236         */
       
   237         IMPORT_C virtual TInt SnapIdL(TUint32& aCurrentSnapId);		
       
   238 
       
   239 	/**
       
   240         * Gets the SNAP Dialog.
       
   241         * @param aSNAPDialog A TBool reference to be filled in with the
       
   242         *                   value of the IAPDialog.
       
   243         * @return           KErrNone if no error, or some of the system
       
   244         *                   wide error codes.
       
   245         */
       
   246         IMPORT_C virtual TInt SnapDialogL(TBool& aSNAPDialog);		
       
   247     protected:
       
   248         /**
       
   249         * Constructor.
       
   250         */
       
   251         IMPORT_C CSenLayeredTransportProperties();
       
   252     };
       
   253 
       
   254 #endif // SEN_LAYERED_TRANSPORT_PROPERTIES_H
       
   255 
       
   256 // End of File
       
   257