FCL/sf/mw/ipconnmgmt: comparison ipcm_plat/bearer_settings_plugin

equal deleted inserted replaced

-:fcbbe021d614
+:9c97ad6591ae
 /*
-* Copyright (c) 2006 Nokia Corporation and/or its subsidiary(-ies).
+* Copyright (c) 2006-2010 Nokia Corporation and/or its subsidiary(-ies).
 * All rights reserved.
 * This component and the accompanying materials are made available
 * under the terms of "Eclipse Public License v1.0"
 * which accompanies this distribution, and is available
 * at the URL "http://www.eclipse.org/legal/epl-v10.html".
 * Initial Contributors:
 * Nokia Corporation - initial contribution.
 *
 * Contributors:
 *
-* Description:  IF implementation class for connection method plugins.
+* Description:
+* IF implementation class for connection method plugins.
 *
 */
 #ifndef CMPLUGINBASEENG_H
 #define CMPLUGINBASEENG_H
 // INCLUDES
 #include <cmconnectionmethoddef.h>
 #include <e32std.h>
 #include <e32base.h>
-#include <ecom/ecom.h>        // For REComSession
+#include <ecom/ecom.h>
 #include <metadatabase.h>
-#include <CommsDatTypesV1_1.h>
+#include <commsdattypesv1_1.h>
+#include <cmmanagerdef.h>
+/**
+* Macro for getting element id from Iap Id.
+* @param iapRecId Record id of an Iap.
+*/
 #define IAP_ELEMENT_ID( iapRecId )  (KCDTIdIAPRecord | \
 KCDMaskShowFieldType | \
 (iapRecId << 8))
+/**
+* Macros for getting/setting diffrerent type of values from/to the records(CommsDat)
+* @param record Pointer to the record which has the field requested/to be set.
+* @param fieldId Id of the field to get/set the value.
+* @param ***Val Value to be set.
+* @return Returns the requested value in get operation.
+*/
 #define QUERY_HBUFC_FIELD( record, fieldId ) *STATIC_CAST(CommsDat::CMDBField<HBufC*>*, record->GetFieldByIdL( fieldId ))
 #define QUERY_UINT32_FIELD( record, fieldId ) *STATIC_CAST(CommsDat::CMDBField<TUint32>*, record->GetFieldByIdL( fieldId ))
 #define QUERY_INT_FIELD( record, fieldId ) *STATIC_CAST(CommsDat::CMDBField<TInt>*, record->GetFieldByIdL( fieldId ))
 #define SET_HBUFC_FIELD( record, fieldId, stringVal ) STATIC_CAST(CommsDat::CMDBField<TDesC>*, record->GetFieldByIdL( fieldId ))->SetL( stringVal->Des() )
 #define FIELD_TO_TDESC( field ) ( (const TDesC&)( field ) )
 // CONSTANTS
 const TInt32 KExtensionBaseLevel = 1;
-const TUint32 KDefAttrsArrayGranSize = 32;
+const TUint32 KMaxProxyServerNameLength = 1024;
-const TUint32 KMaxProxyServerNameLength = 1000;
 const TUint32 KDummyBearerType = 1;
+/**
+* Record indexes for generic iap records in the Client instance table.
+*/
+const TInt KIapRecordIndex = 0;
+const TInt KServiceRecordIndex = 1;
+const TInt KNetworkRecordIndex = 2;
+const TInt KWAPAPRecordIndex = 3;
+const TInt KWAPBearerRecordIndex = 4;
+const TInt KMetaDataRecordIndex = 5;
+const TInt KLocationRecordIndex = 6;
+const TInt KProxyRecordIndex = 7;
 // DATA TYPES
 typedef enum
 {
 ECmBool,
 * Marks the end of bearer
 * creation related attributes
 */
 };
-class CCmPluginBaseEng;
-class CCmPluginBase;
 /**
-* Validation function called before data is stored.
+* Flags for Iap metadata to indicate:
-* @param aThis 'this' pointer of the plugin instance
+* EMetaHighlight: If it's set it indicates that a connection method is
-* @param aAttribute attribute to be set
+*                 highlighted in Agent dialog. Only one connection
-* @param aValue value to be checked
+*                 method can have this flag set.
-* @return ETrue if value is stored.
+* EMetaHiddenAgent: If it's set it indicates that an connection method is
-*/
+*                   hidden connection method in Agent dialog.
-typedef TBool (*TValidationFunctionL)( CCmPluginBaseEng* aThis,
+*/
-TUint32 aAttribute,
-const TAny* aValue );
-/**
-* Structure of conversion table between CM attributes and
-* CommsDat ids. The first element must indicate the
-* range of the conversion table. iAttribId is the lowest Id,
-* iCommsDatId is the highest one. The last element is a
-* terminator. e.g. Proxy table:
-* static const TCmAttribConvTable SProxyConvTbl[] =
-*   {
-{ ECMProxyUsageEnabled, ECMProxyRangeMax, NULL }
-{ ECMProxyUseProxyServer, KCDTIdUseProxyServer, NULL },
-{ ECmProxyPortNumber, KCDTIdPortNumber, &CheckPortNumberValidityL },
-...
-{ 0, 0 }
-}
-*/
-typedef struct
-{
-TInt    iAttribId;
-TInt    iCommsDatId;
-TValidationFunctionL iValidFuncL;
-TInt    iTitleId;
-TInt    iMaxLength;
-TUint32 iAttribFlags;   // see TCmConvAttribFlags
-TInt    iDefSettingResId;
-TInt    iEditorResId;
-TInt    iDefValueResId;
-TAny*   iNotUsed1;
-TAny*   iNotUsed2;
-}TCmAttribConvTable;
-enum TCmConvAttribFlags
-{
-EConvNoZeroLength   = 0x00000001,   // Zero length NOT acceptable
-EConvCompulsory     = 0x00000002,
-EConv8Bits          = 0x00000004,
-EConvReadOnly       = 0x00000008,
-EConvNumber         = 0x00000010,
-EConvIPv4           = 0x00000020,
-EConvIPv6           = 0x00000040,
-EConvPassword       = 0x00000080,
-};
-typedef struct
-{
-CommsDat::CCDRecordBase*      *iRecord;
-TBool*              iEnabled;
-const TCmAttribConvTable* iConvTable;
-}TCmAttrConvArrayItem;
-typedef struct
-{
-TInt                iAttribId;
-TInt                iCommonAttribId;
-}TCmCommonAttrConvArrayItem;
 enum TCmMetaDataFields
 {
 EMetaHighlight    = 0x00000001,
 EMetaHiddenAgent  = 0x00000002
 };
-// FUNCTION PROTOTYPES
+// FORWARD DECLARATIONS
+class CCmPluginBaseEng;
+class CCDIAPMetadataRecord;
+// CLASS DECLARATION
 /**
-* TValidationFunctionL functions.
+* Initialisation instance for plugin creation. Used in plugin
-*/
+* construction phase.
+*/
-/**
-* Function should be called if client tries to set attribute that is read-only
-* @param aThis 'this' pointer of the plugin instance
-* @param aAttribute not used
-* @param aValue not used
-* @leave KErrNotSupported in every cases
-*/
-IMPORT_C TBool ReadOnlyAttributeL( CCmPluginBaseEng* aThis,
-TUint32 aAttribute,
-const TAny* aValue );
-/**
-* Function to check if the passed IPv4 address is valid.
-* @param aThis 'this' pointer of the plugin instance
-* @param aAttribute attribute client wants to set
-* @param aValue TDesC* IPv4 address buffer to be checked
-*/
-IMPORT_C TBool CheckIPv4ValidityL( CCmPluginBaseEng* aThis,
-TUint32 aAttribute,
-const TAny* aValue );
-/**
-* Function to check if the passed IPv6 address is valid.
-* @param aThis 'this' pointer of the plugin instance
-* @param aAttribute attribute client wants to set
-* @param aValue TDesC* IPv6 address buffer to be checked
-*/
-IMPORT_C TBool CheckIPv6ValidityL( CCmPluginBaseEng* aThis,
-TUint32 aAttribute,
-const TAny* aValue );
-/**
-* Function to check if the passed port number is valid.
-* @param aThis 'this' pointer of the plugin instance
-* @param aAttribute attribute client wants to set
-* @param aValue TUint32 the port number to be check
-*/
-IMPORT_C TBool CheckPortNumberValidityL( CCmPluginBaseEng* aThis,
-TUint32 aAttribute,
-const TAny* aValue );
-/**
-* Function to check if the passed record is valid.
-* @param aThis 'this' pointer of the plugin instance
-* @param aAttribute attribute client wants to set
-* @param aValue TUint32 the record id to be checked
-*/
-IMPORT_C TBool CheckRecordIdValidityL( CCmPluginBaseEng* aThis,
-TUint32 aAttribute,
-const TAny* aValue );
-/**
-* Function to check if the passed WAPWspOption is valid.
-* @param aThis 'this' pointer of the plugin instance
-* @param aAttribute attribute client wants to set
-* @param TUint32 the WPSOption to be checked
-*/
-IMPORT_C TBool CheckWAPWspOptionValidityL( CCmPluginBaseEng* aThis,
-TUint32 aAttribute,
-const TAny* aValue );
-/**
-* @param aThis 'this' pointer of the plugin instance
-* @param aAttribute attribute client wants to set
-* @param TUint32 the WPSOption to be checked
-*/
-IMPORT_C TBool SetProxyServerNameL( CCmPluginBaseEng* aThis,
-TUint32 aAttribute,
-const TAny* aValue );
-/**
-* Miscellaneous utility functions.
-*/
-/**
-* Check if the passed IP address is '0.0.0.0' or empty string
-* @param aIpAddress IP address to be checked
-*/
-IMPORT_C TBool IsUnspecifiedIPv4Address( const TDesC& aIpv4Address );
-/**
-* Check if the passed IP address is one of these:
-* - empty string    -
-* - '0:0:0:0:0:0:0:0'
-* - 'fec0:000:0000:ffff::1'
-* - 'fec0:000:0000:ffff::2'
-* @param aIpAddress IP address to be checked
-*/
-IMPORT_C CMManager::TIPv6Types ClassifyIPv6Address( const TDesC& aIpv6Address );
-// FORWARD DECLARATIONS
-class CCmDestinationImpl;
-class CCmManagerImpl;
-class CCDIAPMetadataRecord;
-class CCmTransactionHandler;
-class CCmPluginBasePrivate;
-// CLASS DECLARATION
 NONSHARABLE_CLASS(TCmPluginInitParam)
 {
 public:
+/**
-TCmPluginInitParam( CCmManagerImpl& aCmMgr );
+* Constructor.
+* @param aSessionRef Reference for open Session handle to CommsDat.
+*/
+IMPORT_C TCmPluginInitParam( CommsDat::CMDBSession& aSessionRef );
 public:
+/**
-CCmManagerImpl&     iCmMgr;
+* Reference to CommsDat session handle.
-TUint32             iParentDest;// Parent destination
+*/
+CommsDat::CMDBSession& iSessionRef;
+/**
+* Reserved for future.
+*/
 TAny*               iNotused1;
 TAny*               iNotused2;
 };
+// CLASS DECLARATION
 /**
-*  CCmPluginBaseEng is base class for every connection method plugin
+* This defines the data object used for moving data between
+* cmm server and plugins.
+*/
+NONSHARABLE_CLASS( CCmClientPluginInstance ): public CBase
+{
+public:
+/**
+* Two-phase constructor. Returns pointer to the new
+* CCmClientPluginInstance object.
+*/
+IMPORT_C static CCmClientPluginInstance* NewL();
+/**
+* Two-phase constructor. Returns pointer to the new
+* CCmClientPluginInstance object.
+*/
+IMPORT_C static CCmClientPluginInstance* NewLC();
+/**
+* Destructor
+*/
+IMPORT_C ~CCmClientPluginInstance();
+private:
+/**
+* Default constructor.
+*/
+CCmClientPluginInstance();
+/**
+* Second phase constructor.
+*/
+void ConstructL();
+public:
+/**
+* Pointer array for generic record pointers. Those are copies
+* from CommsDat versions for the client usage.
+*/
+RPointerArray<CommsDat::CCDRecordBase> iGenRecordArray;
+/**
+* Pointer array for bearer specific record pointers. Those are copies
+* from CommsDat versions for the client usage. These are asked from
+* the different plugins.
+*/
+RPointerArray<CommsDat::CCDRecordBase> iBearerSpecRecordArray;
+/** Naming way of the CM. e.g. ENamingUnique */
+CMManager::TNamingMethod               iNamingMethod;
+/** Boolean to keep the information if location is enabled */
+TBool                                  iLocationEnabled;
+/** Iap Record id of this Connection Method */
+TUint32                                iIapId;
+};
+/**
+*  CCmPluginBaseEng is base class for every connection method plugin.
+*  It handles all the generic iap informations e.g. record handling
+*  and attribute reaquests to generic records.
 *
-*  @lib cmmanager.lib
+*  @lib cmmpluginbase.lib
-*  @since S60 v3.2
+*  @since S60 v5.2
 */
 class CCmPluginBaseEng : public CBase
 {
 public:
+/**
-/** Destructor. */
+* Destructor.
-IMPORT_C virtual ~CCmPluginBaseEng();
-/**
-* Create a new instance of the given bearer type plugin.
-* Used from framework to avoid using slow ECom framework.
-* @param aInitParam initialization data
 */
+IMPORT_C virtual ~CCmPluginBaseEng();
+/**
+* Create a new instance of the given bearer type plugin.
+* Used from CMM server to avoid using slow ECom framework.
+* @param aInitParam initialization data
+* @return Returns CCmPluginBaseEng type pointer which represents pure
+* bearer instance for the CMM server.
+*/
 virtual CCmPluginBaseEng*
 CreateInstanceL( TCmPluginInitParam& aInitParam ) const = 0;
-public: // Attribute handlers
+/**
+* Following GetBearerInfoXXXL methods return the values of the
-/**
+* requested attributes. These values are bearerspecific so they
-* Gets the value for a TInt attribute.
+* don't vary between CMs with same bearer type.
-* @param aAttribute Identifies the attribute to be retrived.
+* @param aAttribute An attribute identifier.
-* @return contains the requested TInt attribute.
+* @return Returns the value requested. If not found leaves with
-*/
+* KErrNotFound error code.
-IMPORT_C virtual TUint32
+*/
-GetIntAttributeL( const TUint32 aAttribute ) const;
+IMPORT_C virtual TUint32 GetBearerInfoIntL(
+TUint32 aAttribute ) const = 0;
-/**
-* Gets the value for a TBool attribute.
+IMPORT_C virtual TBool GetBearerInfoBoolL(
-* @param aAttribute Identifies the attribute to be retrived.
+TUint32 aAttribute ) const = 0;
-* @return contains the requested TBool attribute.
-*/
+IMPORT_C virtual HBufC* GetBearerInfoStringL(
-IMPORT_C virtual TBool
+TUint32 aAttribute ) const = 0;
-GetBoolAttributeL( const TUint32 aAttribute ) const;
+IMPORT_C virtual HBufC8* GetBearerInfoString8L(
-/**
+TUint32 aAttribute ) const = 0;
-* Gets the value for a String16 attribute.
-* @param aAttribute Identifies the attribute to be retrived.
+/**
-* @return copy of the requested attribute. Ownership is passed.
+* Checks if the plug-in can handle the Connection Method identified
-*/
+* with parameter aIapId.
-IMPORT_C virtual HBufC*
+* @param aIapId IAPId of the AP to be checked
-GetStringAttributeL( const TUint32 aAttribute ) const;
+* @return ETrue if plug-in can handle the IAP, otherwise EFalse.
+*/
-/**
+virtual TBool CanHandleIapIdL( TUint32 aIapId ) const = 0;
-* Gets the value for a String8 attribute.
-* @param aAttribute Identifies the attribute to be retrived.
+/**
-* @return copy of the requested attribute. Ownership is passed.
+* Checks if the plug-in can handle the given IAP record.
-*/
+* @param aIapRecord IAP record to be checked
-IMPORT_C virtual HBufC8*
+* @return ETrue if plug-in can handle the IAP, otherwise EFalse.
-GetString8AttributeL( const TUint32 aAttribute ) const;
+*/
+virtual TBool CanHandleIapIdL(
-/**
+CommsDat::CCDIAPRecord* aIapRecord ) const = 0;
-* Sets the value for a TInt attribute.
-* @param aAttribute Identifies the attribute to be set.
+public: // Client interface
-* @param aValue The value to be set.
+/**
-* @return None.
+* Loads all the records belonging to this Connection Method.
-*/
+* @param aIapId Id of the IAP record. Identifies the CM
-IMPORT_C virtual void SetIntAttributeL(
+* related records to load.
-const TUint32 aAttribute, TUint32 aValue );
+*/
+IMPORT_C void LoadL( TUint32 aIapId );
-/**
-* Sets the value for a TBool attribute.
+/**
-* @param aAttribute Identifies the attribute to be set.
+* Resets and loads all the records belonging to this Connection Method.
-* @param aValue The value to be set.
+*/
-* @return None.
+IMPORT_C void ReLoadL();
-*/
-IMPORT_C virtual void SetBoolAttributeL(
+/**
-const TUint32 aAttribute, TBool aValue );
+* Creates a new Connection Method in memory. Call UpdateL() to store
+* it in CommsDat. No CommsDat transaction operation is needed for this.
-/**
+* @param aCmId Predefined iapid to be used when saving to CommsDat.
-* Sets the value for a String16 attribute.
+*       0 means that CommsDat gives the id.
-* @param aAttribute Identifies the attribute to be set.
+*/
-* @param aValue The value to be set.
+IMPORT_C void CreateNewL( TUint32 aCmId );
-* @return None.
-*/
+/**
-IMPORT_C virtual void SetStringAttributeL(
+* Creates a copy of an existing Connection Method.
-const TUint32 aAttribute, const TDesC16& aValue );
+* @param aClientPluginInstance The source data to create the copy from.
+* @return CCmPluginBaseEng type pointer to an object which represents
-/**
+* the new plugin to the CMM server.
-* Sets the value for a String8 attribute.
+*/
-* @param aAttribute Identifies the attribute to be set.
+IMPORT_C CCmPluginBaseEng* CreateCopyL(
-* @param aValue The value to be set.
+CCmClientPluginInstance* aClientPluginInstance );
-* @return None.
-*/
+/**
-IMPORT_C virtual void SetString8AttributeL(
+* Updates all records to commsdat. Data is copied from the client's copy
-const TUint32 aAttribute, const TDesC8& aValue );
+* to the original data.
+* This method does not open/rollback/commit transaction to CommsDat.
-/**
+* Caller must handle transactions.
-* Restore the original value of the attribute from commsdat field.
+*/
-* Base implementation can be used only with attributes
+IMPORT_C virtual void UpdateL(
-* stored directly in commsdat.
+CCmClientPluginInstance* aClientPluginInstance );
-* @param aAttribute attribute to be restored
-*/
-IMPORT_C virtual void RestoreAttributeL( const TUint32 aAttribute );
-/**
-* Returns the CCmDestinationImpl* if this is an
-* embedded destination CM. Otherwise returns NULL.
-* @return embedded destination object or NULL
-*/
-IMPORT_C virtual CCmDestinationImpl* Destination() const;
-/**
-* Update or if this is a new CM, creates CM in CommsDat.
-* - OpenTransactionLC()
-* - PrepareToUpdateRecordsL()
-* - UpdateChargeCardRecordL()
-* - UpdateServiceRecordL()
-* - UpdateIAPRecordL()
-*   - UpdateLocationRecordL()
-*   - BearerRecordIdLC()
-*   - UpdateNetworkRecordL()
-*   - UpdateWapRecordL()
-*   - UpdateProxyRecordL()
-*   - UpdateConnPrefSettingL()
-* - UpdateAdditionalRecordsL()
-* - CommitTransactionL()
-* @return None.
-*/
-IMPORT_C virtual void UpdateL();
 /*
-* Delete from the database if this CM has no more reference
+* Deletes all the records of this CM from the database.
-* from the DN_IAP table.
+* All the preventing conditions must be checked before calling this.
-* - IsMultipleReferencedL()
+* This method does not open/rollback/commit transaction to CommsDat.
-* - OpenTransactionLC()
+* Caller must handle transactions.
-* - PrepareToDeleteL()
+*/
-* - Delete records (in this order)
+IMPORT_C virtual void DeleteL();
-*   - IAP
-*   - Proxy
+/**
-*   - Service
+* Creates a copy of all plugin data( most of them are CommsDat data ) for a client.
-*   - ChargeCard
+* @param aClientPluginInstance An object where to copy the data.
-*   - Network
+*/
-*   - Location
+IMPORT_C void GetPluginDataL( CCmClientPluginInstance* aClientPluginInstance );
-*   - WapAP
-*   - WapBearer
+/**
-* - DeleteAdditionalRecordsL()
+* Following GetXXXXAttributeL methods return the values of the
-* - CommitTransactionL()
+* requested attributes. Attributes are returned from the client's
-* @param aForced forced delete doesn't check referencies
+* copy of the data. These values are CM specific.
-* @param aOneRefsAllowed ETrue if one reference from a destination is
+* @param aAttribute An attribute identifier.
-*           acceptable to delete this connection method.
+* @param aClientPluginInstance Client's copy of the data where
-*/
+* to get the return value.
-IMPORT_C virtual TBool DeleteL( TBool aForced,
+* @return Returns the value requested. If not found leaves with
-TBool aOneRefAllowed = ETrue );
+* KErrNotFound error code.
+*/
-/**
+IMPORT_C TUint32 GetIntAttributeL(
-* Performs the basic loading of records related
+TUint32 aAttribute,
-* to this connection method:
+CCmClientPluginInstance* aClientPluginInstance );
-* - OpenTransactionLC();
-* - PrepareToLoadRecordsL()
+IMPORT_C TBool GetBoolAttributeL(
-* - LoadIAPRecordL();
+TUint32 aAttribute,
-*       - load IAP
+CCmClientPluginInstance* aClientPluginInstance );
-*       - load WAP (AP & IP Bearer)
-*       - load proxy
+IMPORT_C HBufC* GetStringAttributeL(
-*       - load charge card
+TUint32 aAttribute,
-*       - load network
+CCmClientPluginInstance* aClientPluginInstance );
-*       - load location
-* - LoadServiceSettingL();
+IMPORT_C HBufC8* GetString8AttributeL(
-* - LoadAdditionalRecordsL();
+TUint32 aAttribute,
-*/
+CCmClientPluginInstance* aClientPluginInstance );
-IMPORT_C virtual void LoadL( TUint32 aIapId );
+/**
-/**
+* Following SetXXXXAttributeL methods set the given values
-* Create a new connection method in memory.
+* identified with attributes. Attributes are set to the
-* Call UpdateL() to store it in CommsDat.
+* client's copy of the data.
-* No transaction operation is performed.
+* @param aAttribute An attribute identifier.
-* - Creates new WAP, IAP, Network records
+* @param aValue Value to set.
-* - CreateNewServiceRecordL()
+* @param aClientPluginInstance Client's copy of the data where
-* - CreateAdditionalRecordsL()
+* to set the given value.
-* - Loads default AP name from resource
+*/
-*       (R_CMMANAGERENG_DEFAULT_AP_NAME)
+IMPORT_C void SetIntAttributeL( TUint32 aAttribute, TUint32 aValue,
-*/
+CCmClientPluginInstance* aClientPluginInstance );
-IMPORT_C virtual void CreateNewL();
+IMPORT_C void SetBoolAttributeL( TUint32 aAttribute, TBool aValue,
-/**
+CCmClientPluginInstance* aClientPluginInstance );
-* Create a copy of the connection method:
-* - CreateInstanceL()
+IMPORT_C void SetStringAttributeL( TUint32 aAttribute, const TDesC16& aValue,
-* - CreateNewL()
+CCmClientPluginInstance* aClientPluginInstance );
-* - PrepareToCopyDataL()
-* - Copies data:
+IMPORT_C void SetString8AttributeL( TUint32 aAttribute, const TDesC8& aValue,
-*   - name
+CCmClientPluginInstance* aClientPluginInstance );
-*   - bearer type
-*   - records added to the convertion table
+/**
-* - Calls CopyAdditionalDataL().
+* Requests CommsDat table ids to be observed for changes by the cmm
-*/
+* server. This is only for generic iap related tables.
-IMPORT_C virtual CCmPluginBaseEng* CreateCopyL() const;
+* @param aTableIdArray A reference to an array where iap related generic
+* table ids are added.
-/*
+*/
-* Returns true if the CM has more than one parent destination
+IMPORT_C void GetGenericTableIdsToBeObserved( RArray<TUint32>& aTableIdArray ) const;
-*/
-IMPORT_C virtual TInt NumOfConnMethodReferencesL();
+/**
+* Requests CommsDat table ids to be observed for changes by the cmm
-public:
+* server. If a table used is not mentioned to be modified a bearer
+* shouldn't return this. Bearers do not reset the array before adding
-/**
+* ids.
-* Returns a pointer to the cmmanager
+* @param aTableIdArray A reference to an array where plugin must add
-* @return a pointer to the cmmanager
+* the ids of the tables it want's to be observed.
 */
-CCmManagerImpl& CmMgr() const { return iCmMgr; };
+IMPORT_C virtual void GetBearerTableIdsToBeObservedL(
+RArray<TUint32>& aTableIdArray ) const = 0;
-IMPORT_C CommsDat::CMDBSession& Session() const;
+public: // plugin interface
 /**
-* Launches the settings dialog of the plugin
+* Creates a copy of all bearer specific CommsDat data for the client.
-*
+* Called as result of GetPluginDataL().
-* @since S60 3.2
+* @param aRecordArray An array where the copy the records. Only
-* @return soft key selection
+* the bearer specific implementation knows the amount and order
-*/
+* of these records in the array.
-virtual TInt RunSettingsL() = 0;
+*/
+virtual void GetBearerSpecificRecordsL(
-/**
+RPointerArray<CommsDat::CCDRecordBase>& aRecordArray ) = 0;
-* Called on a newly created connection method to initialize it properly
-* with user interaction (e.g. APN setting for a packet data-, WEP-key
+/**
-* setting for a WLAN connection method, etc.).
+* Following GetBearerXXXXAttribute methods get only the
-* Note: each plug-in should set its name (i.e. ECmName) in this
+* fields in records in pointer arrays(parameters).
-* function call.
+* @param aAttribute Identifier of the requested value.
-*
+* @param aGenRecordArray An array containing pointers to generic
-* @since S60 3.2
+* records of the Connection Method.
-* @param aManuallyConfigure let's the plugin know if a plugin should
+* @param aBearerSpecRecordArray An array containing pointers to bearer
-*                           be configured manually or automatically
+* specific records of the Connection Method. aAttribute
-* @return ETrue if initialization was successful and wasn't cancelled.
+* parameter should identify one field(integer, boolean string)
-* EFalse, if initialization process was cancelled (i.e. user pressed
+* in one of these records.
-* Cancel button).
+* @return Returns the requested value. In error case leaves with
-*/
+* system-wide error code.
-virtual TBool InitializeWithUiL( TBool aManuallyConfigure ) = 0;
+*/
-/**
+virtual TUint32 GetBearerIntAttributeL(
-* Checks if the plug-in can handle the given AP.
+TUint32 aAttribute,
-* @param aIapId IAPId of the AP to be checked
+RPointerArray<CommsDat::CCDRecordBase>& aGenRecordArray,
-* @return ETrue if plug-in can handle the IAP
+RPointerArray<CommsDat::CCDRecordBase>& aBearerSpecRecordArray ) = 0;
-*/
-virtual TBool CanHandleIapIdL( TUint32 aIapId ) const = 0;
+virtual TBool GetBearerBoolAttributeL(
+TUint32 aAttribute,
-/**
+RPointerArray<CommsDat::CCDRecordBase>& aGenRecordArray,
-* Checks if the plug-in can handle the given AP.
+RPointerArray<CommsDat::CCDRecordBase>& aBearerSpecRecordArray ) = 0;
-* @param aIapRecord IAP record to be checked
-* @return ETrue if plug-in can handle the IAP
+virtual HBufC* GetBearerStringAttributeL(
-*/
+TUint32 aAttribute,
-virtual TBool CanHandleIapIdL( CommsDat::CCDIAPRecord* aIapRecord ) const = 0;
+RPointerArray<CommsDat::CCDRecordBase>& aGenRecordArray,
+RPointerArray<CommsDat::CCDRecordBase>& aBearerSpecRecordArray ) = 0;
-/**
-* Return the parent destination of this connection method.
+virtual HBufC8* GetBearerString8AttributeL(
-* @return parent destination of this connection method
+TUint32 aAttribute,
-*/
+RPointerArray<CommsDat::CCDRecordBase>& aGenRecordArray,
-IMPORT_C CCmDestinationImpl* ParentDestination() const;
+RPointerArray<CommsDat::CCDRecordBase>& aBearerSpecRecordArray ) = 0;
 /**
-* Calls FeatureManager::FeatureSupported directly.
+* Following SetBearerXXXXAttribute methods set only the
-* @param aFeature feature ID
+* fields in records in pointer arrays(parameters). They are not
-* @return feature support status
+* allowed to update the original records in plugins.
-* @since 3.2
+* @param aAttribute Identifier of the field to set.
-*/
+* @param aValue The value to set.
-IMPORT_C static TBool FeatureSupported( TInt aFeature );
+* @param aGenRecordArray An array containing pointers to generic
+* records of the Connection Method.
-/**
+* @param aBearerSpecRecordArray An array containing pointers to bearer
-* Function should be overriden by virtual bearer type plugins.
+* specific records of the Connection Method. aAttribute
-* Returns if the passed IAP id is linked to that connection method.
+* parameter should identify one field(integer, boolean string)
-* @param aIapId IAP id to be checked
+* in one of these records.
-* @return ETrue if the passed IAP id is linked to that connection method.
+* @return None.
 */
-virtual TBool IsLinkedToIap( TUint32 /*aIapId*/ ){ return EFalse; }
+virtual void SetBearerIntAttributeL(
-/**
+TUint32 aAttribute,
-* Function should be overriden by virtual bearer type plugins.
+TUint32 aValue,
-* Returns if the passed SNAP id is linked to that connection method.
+RPointerArray<CommsDat::CCDRecordBase>& aGenRecordArray,
-* @param aSnapId SNAP id to be checked
+RPointerArray<CommsDat::CCDRecordBase>& aBearerSpecRecordArray ) = 0;
-* @return ETrue if the passed SNAP id is linked to that connection method.
-*/
+virtual void SetBearerBoolAttributeL(
-virtual TBool IsLinkedToSnap( TUint32 /*aSnapId*/ ){ return EFalse; }
+TUint32 aAttribute,
+TBool aValue,
-/**
+RPointerArray<CommsDat::CCDRecordBase>& aGenRecordArray,
-* Increments the reference counter. Used by the object pool.
+RPointerArray<CommsDat::CCDRecordBase>& aBearerSpecRecordArray ) = 0;
-*/
-void IncrementRefCounter();
+virtual void SetBearerStringAttributeL(
-/**
+TUint32 aAttribute,
-* Increments the reference counter. Used by the object pool.
+const TDesC16& aValue,
-*/
+RPointerArray<CommsDat::CCDRecordBase>& aGenRecordArray,
-void DecrementRefCounter();
+RPointerArray<CommsDat::CCDRecordBase>& aBearerSpecRecordArray ) = 0;
-/**
-* Returns the reference counter. Used by the object pool.
+virtual void SetBearerString8AttributeL(
-* @return TInt
+TUint32 aAttribute,
-*/
+const TDesC8& aValue,
-TInt GetRefCounter();
+RPointerArray<CommsDat::CCDRecordBase>& aGenRecordArray,
+RPointerArray<CommsDat::CCDRecordBase>& aBearerSpecRecordArray ) = 0;
-/**
-* Appends uids of connection methods - which were also created during connection method
+/**
-* creation - to the array given as parameter
+* Inherited class can make some preraration before CCmPluginBaseEng
-* @param aIapIds the array the additonal cm uids are appended to
+* would start loading bearer specific records.
 */
-IMPORT_C virtual void GetAdditionalUids( RArray<TUint32>& aIapIds );
+virtual void PreparePluginToLoadRecordsL() = 0;
-protected: // Conversion table API
+/**
+* Gives the plugin a possibility to do some preparing operations
-IMPORT_C void AddConverstionTableL(
+* if needed.
-CommsDat::CCDRecordBase* *aRecord,
+* @param aCopyInstance Client side data instance.
-TBool* aEnabled,
+*/
-const TCmAttribConvTable* aConvTable );
+virtual void PrepareToCopyDataL( CCmPluginBaseEng* aCopyInstance ) = 0;
-IMPORT_C void AddCommonConversionTableL(
+/**
-const TCmCommonAttrConvArrayItem* aConvTable );
+* Inherited class can make some preraration before CCmPluginBaseEng
+* would start to update all the records.
-IMPORT_C void RemoveConversionTable(
+* @param aGenRecordArray Reference to generic records pointer array.
-const TCmAttribConvTable* aConvTable );
+* @param aBearerSpecRecordArray Reference to bearer specific records
+* pointer array.
-IMPORT_C void RemoveCommonConversionTable(
+*/
-const TCmCommonAttrConvArrayItem* aConvTable );
+virtual void PreparePluginToUpdateRecordsL(
+RPointerArray<CommsDat::CCDRecordBase>& aGenRecordArray,
-protected: // Resource handling
+RPointerArray<CommsDat::CCDRecordBase>& aBearerSpecRecordArray ) = 0;
 /**
-* Add file name to the resource file array.
+* Plugin can prepare to delete the Connection Method with this
-* Open it and/or increment reference count.
+* function. Called from DeleteL() before any record would be
-* @param aName resource file name
+* deleted. No records are deleted here.
 */
-IMPORT_C void AddResourceFileL( const TDesC& aName );
+virtual void PrepareToDeleteRecordsL(){};
 /**
-* Remove file name from the resource file name array.
+* Loads the service record. Service record type is known and loaded by
-* Close the resource file and/or decrement the reference count.
+* plugin(bearer specific) part of the implementation even if the record
-* @param aName resource file name
+* is saved to the generic side. Service record is linked to IAP record.
 */
-IMPORT_C void RemoveResourceFile( const TDesC& aName );
+virtual void LoadServiceRecordL() = 0;
 /**
-* Read string from resource file. Resource file has to be
+* Creates the service records.
-* opened prior this by calling AddResourceFileL().
+*/
-*/
+virtual void CreateServiceRecordL() = 0;
-IMPORT_C HBufC* AllocReadL( TInt aResourceId ) const;
+/**
+* Update service record.
+* @param aGenRecordArray Reference to generic records pointer array.
+* @param aBearerSpecRecordArray Reference to bearer specific records
+* pointer array.
+*/
+virtual void UpdateServiceRecordL(
+RPointerArray<CommsDat::CCDRecordBase>& aGenRecordArray,
+RPointerArray<CommsDat::CCDRecordBase>& aBearerSpecRecordArray ) = 0;
+/**
+* Copies the service record. Bearer specific part knows the type of it's
+* service record.
+* @return Returns the service record pointer.
+*/
+virtual CommsDat::CCDRecordBase* CopyServiceRecordL() = 0;
+/**
+* Returns the service record id of the Connection Method.
+* @return Returns the id of the service record id of the Connection Method.
+*/
+virtual TUint32 ServiceRecordId() const = 0;
+/**
+* Returns the service record name of the Connection Method.
+* @param aServiceName Name of the service record the CM's iap record
+* points to.
+*/
+virtual void ServiceRecordNameLC( HBufC* &aServiceName ) = 0;
+/**
+* Inherited class loads all the bearer specific records after
+* loading generic records. Called from LoadL().
+*/
+virtual void LoadBearerRecordsL() = 0;
+/**
+* Creates bearer specific records.
+*/
+virtual void CreateBearerRecordsL(){};
+/**
+* Update bearer specific records.
+* @param aGenRecordArray Reference to generic records pointer array.
+* @param aBearerSpecRecordArray Reference to bearer specific records
+*/
+virtual void UpdateBearerRecordsL(
+RPointerArray<CommsDat::CCDRecordBase>& aGenRecordArray,
+RPointerArray<CommsDat::CCDRecordBase>& aBearerSpecRecordArray ) = 0;
+/**
+* Plugin(generic part) can delete bearer specific records
+* with this function. Called from DeleteL().
+*/
+virtual void DeleteBearerRecordsL() = 0;
+/**
+* Resets the bearer specific records.
+*/
+virtual void ResetBearerRecords() = 0;
+/**
+* Copies the bearer specific records to copy instance given as
+* parameter.
+* @param aCopyInstance Pointer to instance where to copy.
+*/
+virtual void CopyBearerRecordsL( CCmPluginBaseEng* aCopyInstance ) = 0;
+/**
+* Returns the bearer record id of the Connection Method.
+* @param aRecordId Id of the bearer record this CM's iap record
+* points to.
+*/
+virtual void BearerRecordIdL( TUint32& aRecordId ) = 0;
+/**
+* Returns the bearer record name of the Connection Method.
+* @param aBearerName Name of the bearer record this CM's iap record
+* points to.
+*/
+virtual void BearerRecordNameLC( HBufC* &aBearerName ) = 0;
 protected:
+/**
-/** Constructor */
+* Constructor
+*/
 IMPORT_C CCmPluginBaseEng( TCmPluginInitParam *aInitParam );
-/** Second phase constructor */
+/**
+* Second phase constructor
+*/
 IMPORT_C virtual void ConstructL();
-/** Open transaction */
+/**
-void OpenTransactionLC();
+* Checks if the ECmName attribute was set since the last update.
+* If so, name is updated in passed record
-/**
+* @param aSrcRecord record to be checked against
-* Commit transaction.
+* @param aDestRecord record to be checked against aSrcRecord
-* @param aError - error id
+*/
-*/
+IMPORT_C void CheckIfNameModifiedL(
-void CommitTransactionL( TInt aError );
+CommsDat::CCDRecordBase* aSrcRecord,
+CommsDat::CCDRecordBase* aDestRecord ) const;
-/**
-* Rollback transaction.
+/**
-*/
+* Plugins can check DNS setting with this function.
-void RollbackTransaction();
+* Suggested to be called from PrepareToUpdateRecordsL().
+* It checked the DNS server addresses, moves secord into
-/** Make a reset on this class. */
+* first if first is dynamic, and update DNSFromServer field
-IMPORT_C void Reset();
+* according to address values.
+* @param aIPv6 passed DNS server address are in IPv6 form
-/**
+* @param aDNS1 first DNS server address
-* Plug-in implementation can make its on
+* @param aDNS1 secord DNS server address
-* cleanup in this function.
+* @param aDNSFromServer DNS address from server flag
-* Always called from LoadL() and
+*/
-* should be called from plugin's destructor.
+IMPORT_C void CheckDNSServerAddressL(
-*/
+TBool aIPv6,
-virtual void AdditionalReset() = 0;
+CommsDat::CMDBField<TDesC>& aDNS1,
+CommsDat::CMDBField<TDesC>& aDNS2,
-/**
+CommsDat::CMDBField<TBool>& aDNSFromServer );
-* Check if there's connection established with
-* this connection method (IAP id).
-*/
-IMPORT_C virtual TBool CheckIfAlreadyConnected() const;
-protected:  // virtual loader function
-/**
-* Inherited class can make some preraration
-* before CCmPluginBaseEng would start loading
-* records from tables.
-*/
-IMPORT_C virtual void PrepareToLoadRecordsL();
-/**
-* Inherited class can load any additional
-* records after CCmPluginBaseEng finished.
-*/
-virtual void LoadAdditionalRecordsL(){};
-/**
-* Load service record. Default implementation can
-* create only factory supported record instances.
-*/
-IMPORT_C virtual void LoadServiceSettingL();
-protected:  // virtual update functions
-/**
-* Check if connection method data is valid, before
-* it would be persisted to commsdat.
-* If invalid data found, set its attribute id in
-* iInvalidAttribute.
-* Base class implementation must be called from
-* overridden one.
-*/
-IMPORT_C virtual void PrepareToUpdateRecordsL();
-/**
-* Inherited class can update its additional
-* records here.
-*/
-virtual void UpdateAdditionalRecordsL(){};
-/**
-* Update service record.
-*/
-IMPORT_C virtual void UpdateServiceRecordL();
-/**
-* Return the service table name and record id
-* of this connection in the service table.
-* @param - aServiceName name of the service table
-*           this connection method points to.
-* @param - aRecordId record id in the service table.
-*/
-virtual void ServiceRecordIdLC( HBufC* &aServiceName,
-TUint32& aRecordId ) = 0;
-/**
-* Return the bearer table name and record id
-* of this connection in the bearer table.
-* @param - aBearerName name of the bearer table
-*           this connection method points to.
-* @param - aRecordId record id in the bearer table.
-*/
-virtual void BearerRecordIdLC( HBufC* &aBearerName,
-TUint32& aRecordId ) = 0;
-protected:  // virtual delete function
-/**
-* Plugin can prepare to delete the connection method
-* with this function. Called from DeleteL() before
-* any record would be deleted. Do NOT delete any
-* record here.
-*/
-virtual void PrepareToDeleteRecordsL(){};
-/**
-* Plugin can delete additional, bearer specific record
-* with this function. Called from DeleteL().
-*/
-virtual void DeleteAdditionalRecordsL(){};
-protected:  // virtual create function
-/**
-* Plugin has to create and initialize its bearer specific object
-* that points to the service record here. Pointer has to be stored in
-* iServiceRecord data member.
-* Do NOT store service record in CommsDat yet.
-*/
-virtual void CreateNewServiceRecordL() = 0;
-/**
-* Plugin can create and initialize its bearer specific record(s) here.
-* Do NOT store them in CommsDat yet.
-*/
-virtual void CreateAdditionalRecordsL(){};
-protected:
-/**
-* Called from CreateCopyL().
-* Plugin can prepare for copying every records
-* added to the conversion tables.
-*
-* @param aDestInst copy attributes into this plugin instance
-*/
-virtual void PrepareToCopyDataL( CCmPluginBaseEng& /*aDestInst*/ ) const {};
-/**
-* Copy data of the connection method that is not
-* added to the conversion table. (e.g. bearer specific
-* flags)
-*
-* @param aDestInst copy attributes into this plugin instance
-*/
-virtual void CopyAdditionalDataL( CCmPluginBaseEng& /*aDestInst*/ ) const {};
 private:
+/**
+* Handles all the Connection Method data copying to instance given as
+* parameter. This is called from CreateCopyL().
+* @ param aCopyInstance Pointer to plugin to copy the data.
+*/
+void CopyDataL( CCmPluginBaseEng* aCopyInstance );
+/**
+* Handles all the Connection Method related record copying. Called from
+* CopyDataL().
+* @ param aCopyInstance Pointer to plugin to copy the data.
+*/
+void CopyRecordsL( CCmPluginBaseEng* aCopyInstance );
+/**
+* Copies the record identified by aRecordIdentifier to copy instance.
+* @param aRecordIdentifier Identifies the record which is copied copy.
+* @param aCopyInstance Pointer to plugin to copy the data.
+*/
+void CopyRecordDataL( TUint32 aRecordIdentifier,
+CCmPluginBaseEng* aCopyInstance );
+/**
+* Creates proxy record and sets the proxy settings enabled for this
+* Connection Method.
+*/
 void EnableProxyL( TBool aEnable );
-void EnableChargeCardL( TBool aEnable );
+/**
+* Creates location record and sets the location enabled for this
+* Connection Method.
+*/
 void EnableLocationL( TBool aEnable );
-// Loader functions
+/**
+* Calls all the loading methods.
+*/
 void DoLoadL( TUint32 aIapId );
+/**
+* Loads IAP record.
+* @param aIapId Identifies the IAP record to load.
+*/
 void LoadIAPRecordL( TUint32 aIapId );
-void LoadChargeCardSettingL( TUint32 aChargeCardId );
-void LoadProxySettingL();
+/**
-void LoadNetworkSettingL();
+* Loads proxy record related to this IAP. This is called as a result
-void LoadLocationSettingL();
+* of calling LoadL().
+*/
+void LoadProxyRecordL();
+/**
+* Loads network record related to this IAP. This is called as a result
+* of calling LoadL().
+*/
+void LoadNetworkRecordL();
+/**
+* Loads location record related to this IAP. This is called as a result
+* of calling LoadL().
+*/
+void LoadLocationRecordL();
+/**
+* Loads WAP AP and WAP IP records related to this IAP. This is called as a result
+* of calling LoadL().
+*/
 void LoadWapRecordL();
-void LoadSeamlessnessRecordL();
+/**
-// Updater functions
+* Loads iap metadata record related to this IAP. This is called as a result
-void UpdateIAPRecordL();
+* of calling LoadL().
-void UpdateProxyRecordL();
+*/
-void UpdateChargeCardRecordL();
+void LoadMetadataRecordL();
+/**
+* Following methods are called as a result of calling method UpdateL().
+* Each method overwrites the original data in memory with the client copy
+* of that data. Client data has all the possible changes set by client.
+* After overwrite the data is written to CommsDat.
+* @param aClientPluginInstance The client copy of the original data with the
+* possible changes.
+*/
+void UpdateIAPRecordL( CCmClientPluginInstance* aClientPluginInstance );
+void UpdateProxyRecordL( CCmClientPluginInstance* aClientPluginInstance );
 void UpdateConnPrefSettingL();
-void UpdateNetworkRecordL();
+void UpdateNetworkRecordL( CCmClientPluginInstance* aClientPluginInstance );
-void UpdateLocationRecordL();
+void UpdateLocationRecordL( CCmClientPluginInstance* aClientPluginInstance );
-void UpdateWapRecordL();
+void UpdateWapRecordL( CCmClientPluginInstance* aClientPluginInstance );
-void UpdateSeamlessnessRecordL();
+void UpdateMetadataRecordL( CCmClientPluginInstance* aClientPluginInstance );
+void UpdateServiceRecordL( CCmClientPluginInstance* aClientPluginInstance );
-/**
-* No WAP record found in load process,
+/**
-* but client wants to set start page.
+* Creates new wap records.
 */
 void NewWapRecordL();
 /**
-* Create a new metadata record.
+* Searches the WAP records related to this iap. This is called as a
-* @param aSetDef ETrue if setting default seamlessness valud is needed
+* result of LoadL().
-* @return create metadata record point
+* @return Returns pointer to WAP IP record. If it's not found NULL is
+* returned.
+*/
+CommsDat::CCDWAPIPBearerRecord* FindWAPRecordL();
+/**
+* Creates a new metadata record.
+* @param aSetDef ETrue if setting default seamlessness value is needed
+* @return Returns metadata record pointer.
 */
-CCDIAPMetadataRecord* NewSeamlessnessRecordL( TBool aSetDef );
+CCDIAPMetadataRecord* NewMetadataRecordL( TBool aSetDef );
-CommsDat::CCDWAPIPBearerRecord* FindWAPRecordL();
+/**
-CCDIAPMetadataRecord* FindSeamlessnessRecordL();
+* Searches the metadata record belonging to this iap. This is called as a
+* result of LoadL().
-/**
+* @return Returns pointer to WAP IP record. If it's not found NULL is
-* Set attribute flag on the given record
+* returned.
-* @param aRecord record to be set
+*/
-* @param aAttribute e.g. ECDHidden
+CCDIAPMetadataRecord* FindMetadataRecordL();
+/**
+* Set attribute flag on the given record.
+* @param aRecord Record to be set.
+* @param aAttribute Attribute to be set.
 * @param aSet ETrue to set, EFalse to clear
 */
 void SetAttribute( CommsDat::CCDRecordBase* aRecord,
 TUint32 aAttribute,
 TBool aSet );
 * @param ADstRecord record of which attributes are set
 */
 void CopyAttributes( CommsDat::CCDRecordBase* aSrcRecord,
 CommsDat::CCDRecordBase* aDstRecord );
-/**
-* Find field element associated with the passed attribute.
+/**
-* @param aAttribute aatribute to find
+* Returns the default location record id.
-* @aType type of the attribute (e.g. bool, int or string)
+* @return Returns the default location record id.
-*/
-TValidationFunctionL FindFieldL( TUint32 aAttribute,
-TCMFieldTypes aType,
-CommsDat::CMDBElement* &aElement ) const;
-/**
-* Return Location id
-* @return location id
 */
 TUint32 GetLocationIdL() const;
-/**
+private:
-* Search for common attribute and convert it to plugin specific one.
-* @param aAttribute common attribute id
+/**
-* @return bearer specific attribute id
+* Gives a possibility to make some prerarations before
-*/
+* starting to load bearer specific records.
-TUint32 CheckForCommonAttribute( const TUint32 aAttribute ) const;
+*/
+void PrepareToLoadRecordsL();
-/**
-* Returns the common attribute for the bearer specific attribute.
+/**
-* Panics if there is no matching common attribute.
+* Gives a possibility to make some prerarations before
-* @param aAttribute bearer specific attribute
+* starting to update bearer specific records.
-* @return common attribute
+*/
-*/
+void PrepareToUpdateRecordsL(
-TUint32 CommonAttribute( const TUint32 aAttribute ) const;
+CCmClientPluginInstance* aClientPluginInstance );
-public: // Util functions
+/**
+* Returns the element id of the iap record.
-IMPORT_C CommsDat::TMDBElementId IAPRecordElementId() const;
+* @return Returns the element id of the iap record.
+*/
-IMPORT_C TBool IsProtected() const;
+CommsDat::TMDBElementId IAPRecordElementId() const;
-TBool SetProxyServerNameL( const TDesC& aProxyServer );
+/**
+* Checks the protection attribute of the IAP.
-/**
+* @return Returns ETrue if the IAP is protected. Otherwise returns
-* Return the coversion table item of the attribute
+* EFalse.
-* @param aAttribute attribute of which conversion item is requested
+*/
-* @return conversion table item
+TBool IsProtected() const;
-*/
-IMPORT_C const TCmAttribConvTable* ConvTableItem( TUint32 aAttribute );
+/**
+* Sets the name of the proxy server to proxy record. If name's
-/**
+* length is 0, proxyport is set to 0 and proxyserver usage
-* Function to set up DNS addresses and DNS address from server flag.
+* boolean is set to EFalse. If the name is longer than 0,
-* Can be used with both IPv4 and IPv6 attribute.
+* boolean is set to ETrue.
-* Passed bearer specific attributes must be defined in common conversion
+* @param aProxyServer Address to be set.
-* table.
+* @param Record pointer where to set.
-* @param aSrv1Attr first DNS server address attribute
+*/
-* @param aSrv1 DNS first DNS server address
+void SetProxyServerNameL( const TDesC& aProxyServer,
-* @param aSrv2Attr second DNS server address
+CommsDat::CCDRecordBase* aProxyRecord );
-* @param aSrv2 DNS second DNS server address attribute
-* @param aAddrFromSrvAttr DNS address from server flag attribute
+/**
-* @param aIPv6 ETrue if passed addresses are in IPv6 form
+* Sets a name to IAP.
-*/
+* @param aName Name to set.
-IMPORT_C void SetDNSServerAddressL( TUint32 aSrv1Attr,
+* @param aClientPluginInstance Client copy of data where to set the
-const TDesC& aSrv1,
+* name. UpdateL() updates the name to the CommsDat.
-TUint32 aSrv2Attr,
+*/
-const TDesC& aSrv2,
+void SetNameL( const TDesC& aName,
-TUint32 aAddrFromSrvAttr,
+CommsDat::CCDRecordBase* aIapRecord,
-TBool aIPv6  );
+const CMManager::TNamingMethod aNamingMethod );
 /**
-* Plugins can check DNS setting with this function.
+* Following methods are called as a result of SetNameL() to
-* Suggested to be called from PrepareToUpdateRecordsL().
+* make a valid name of the given string.
-* It checked the DNS server addresses, moves secord into
+*/
-* first if first is dynamic, and update DNSFromServer field
+HBufC* DoMakeValidNameL( const TDesC& aName,
-* according to address values.
+const TUint32& aIapId );
-* @param aIPv6 passed DNS server address are in IPv6 form
-* @param aDNS1 first DNS server address
-* @param aDNS1 secord DNS server address
-* @param aDNSFromServer DNS address from server flag
-*/
-IMPORT_C void CheckDNSServerAddressL( TBool aIPv6,
-CommsDat::CMDBField<TDesC>& aDNS1,
-CommsDat::CMDBField<TDesC>& aDNS2,
-CommsDat::CMDBField<TBool>& aDNSFromServer );
-protected:
-/**
-* Checks if the ECmName attribute was set since the last update.
-* If so, name is updated in passed record
-* @param aRecord record to be checked against iIapRecord
-*/
-IMPORT_C void CheckIfNameModifiedL( CommsDat::CCDRecordBase* aRecord ) const;
-/**
-* Returns the global priority of the passed bearer type
-* @param aServiceType bearer type of which priority is requested
-* @return global bearer priority
-*/
-IMPORT_C TInt GlobalBearerPriority( const TDesC& aServiceType ) const;
-/**
-* Returns the global UI priority of the passed bearer type
-* @param aServiceType bearer type of which priority is requested
-* @return global UI bearer priority
-*/
-IMPORT_C TInt GlobalUiBearerPriority( const TDesC& aServiceType ) const;
-private: // Util functions
-HBufC* DoMakeValidNameL( const TDesC& aName );
 HBufC* EnsureMaxLengthLC( const TDesC& aName,
 TBool& aChanged );
 TPtrC GetPrefix( const TDesC& aName );
 TInt GetPostfix( const TDesC& aName, const TDesC& aPrefix );
+TBool IsValidNameL( const TDesC& aNameText,
-TBool IsValidNameL( const TDesC& aNameText );
+const TUint32& aIapId );
 HBufC* EscapeTextLC( const TDesC& aLiteral );
+void SetDefaultNameL( const TDesC& aName );
-void SetNameL( const TDesC& aName );
+/**
-TCmAttrConvArrayItem* ConversionTable( TUint32 aAttribute ) const;
+* Check if the passed IP address is '0.0.0.0' or empty string
-CommsDat::CMDBElement& FieldByAttributeL( const TCmAttrConvArrayItem* aItem,
+* @param aIpAddress IP address to be checked
-const TUint32 aAttribute,
-TInt& aIndex ) const;
-/**
-* Writes the passed text into the passed attribute.
-* @param aAttribute The attribute to write into
-* @param aValue The value to write
 */
-void GenericStringWriterL( const TUint32 aAttribute,
+TBool IsUnspecifiedIPv4Address( const TDesC& aIpv4Address );
-const TDesC16& aValue );
+/**
-/**
+* Check if the passed IP address is one of these:
-* Returns the common attribute for the bearer specific attribute, if
+* - empty string    -
-* it is mapped to any. Otherwise, it returns the original attribute.
+* - '0:0:0:0:0:0:0:0'
-* @param aAttribute bearer specific attribute
+* - 'fec0:000:0000:ffff::1'
-* @return common/original attribute
+* - 'fec0:000:0000:ffff::2'
+* @param aIpAddress IP address to be checked
 */
-TUint32 MappedCommonAttribute( const TUint32 aAttribute ) const;
+CMManager::TIPv6Types ClassifyIPv6Address( const TDesC& aIpv6Address );
-public:
-/**
-* Indicates if the Id is valid or if this is a new object which sitll
-* haven't been updated.
-* Used by the object pool.
-* @return TBool
-*/
-TBool IdIsValid();
-/**
-* Sets iIdIsValid attribute
-* Used by the object pool.
-*/
-void SetIdValidity(TBool validity);
-/**
-* Scans aDests for destinations that may be valid parents
-* for this plugin and removes those that may not. The function may be
-* overriden by virtual bearer type plugins.
-* @param aDests The array of destination IDs to be filtered.
-*/
-virtual void FilterPossibleParentsL( RArray<TUint32>& /*aDests*/ ) {}
-/**
-* Sets the predefined id for the plugin. This should only be
-* used by cmmanager framework.
-*/
-IMPORT_C void SetPreDefinedId( const TUint32 aPreDefId );
-public:
-/**
-* Check if there is space to save record
-* @return ETrue if space is available; otherwise leave with KLeaveWithoutAlert
-*/
-IMPORT_C TBool CheckSpaceBelowCriticalLevelL() const;
 public: // Data
 // Required attribute for the framework
 // (An identifier used during destruction)
-TUid iDtor_ID_Key;
+TUid    iDtor_ID_Key;
+TUint32 iBearerType;
 protected:
+/**
-CCmManagerImpl&     iCmMgr;         //< Not owned
+* Reference to cmm's session handle. Initialised at the construction
-TUint32             iParentDest;    // id of the parent destinaton
+* phase.
+*/
-// IAP id of the CM. 0 means that this is a newly
+CommsDat::CMDBSession& iSession;
-// created one.
+/**
+* Generic record pointers.
+*/
+CommsDat::CCDIAPRecord*             iIapRecord;
+CommsDat::CCDProxiesRecord*         iProxyRecord;
+CommsDat::CCDRecordBase*            iServiceRecord;
+CommsDat::CCDNetworkRecord*         iNetworkRecord;
+CommsDat::CCDLocationRecord*        iLocationRecord;
+CommsDat::CCDWAPAccessPointRecord*  iWapAPRecord;
+CommsDat::CCDWAPIPBearerRecord*     iWapIPBearerRecord;
+CCDIAPMetadataRecord*               iMetaDataRecord;
+private:
+/**
+* IAP record id of the CM. 0 means that this is not stored to CommsDat
+* yet. If in UpdateL phase iap record has an id but iIapId == 0 -->
+* predefined iap id
+*/
 TUint32         iIapId;
-TUint32         iBearerType;        //< Should be set by plugin
-//< constructor
+/**
+* Naming method of the CM.
-CommsDat::CCDIAPRecord*           iIapRecord;         // created by base class
+*/
-CommsDat::CCDProxiesRecord*       iProxyRecord;       // optional
+CMManager::TNamingMethod    iNamingMethod;
-CommsDat::CCDRecordBase*          iServiceRecord;     // created by plugin
-CommsDat::CCDChargecardRecord*    iChargeCardRecord;  // optional
+/**
-CommsDat::CCDNetworkRecord*       iNetworkRecord;     // created by base class
+* Table id of the iap metadata table.
-CommsDat::CCDLocationRecord*      iLocationRecord;    // optional
+*/
+CommsDat::TMDBElementId     iMetadataTableId;
-TBool           iChargeCardEnabled;
-TBool           iLocationEnabled;
+/**
+* Identifies if the location is enabled.
-TUint32         iInvalidAttribute;
+*/
+TBool                       iLocationEnabled;
-private: // Data
-CCmPluginBasePrivate* iPriv;
-//Reference counter for the object pool
-	    TInt                  iRefCounter;
-//indicates if the Id is valid or not (for the object pool)
-TBool                 iIdIsValid;
-// Predefined connection method id(iap id)
-TUint32               iPreDefIapId;
-	    friend class CCmPluginBase;
 };
 #endif // CMPLUGINBASEENG_H

changeset 20	9c97ad6591ae
parent 0	5a93021fdf25
child 27	489cf6208544