/*

* Copyright (c) 2007-2009 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:

* Name        : sipconcreteprofile.h

* Part of     : SIP / SIP Profile Agent / SIP Concrete Profile

* Version     : %version: 2.1.3 %

*

*/

#ifndef CSIPCONCRETEPROFILE_H

#define CSIPCONCRETEPROFILE_H

//  INCLUDES

#include <e32base.h>

#include <badesca.h>

#include <s32strm.h>

#include <uri8.h>

#include <sipprofiletypeinfo.h>

// FORWARD DECLARATIONS

class CSIPProfileParameter;

class TExtensionIntParam;

class TExtensionBoolParam;

class CExtensionDescrParam;

class CExtensionDescrArrayParam;

// CLASS DECLARATION

/**

* @publishedPartner

* @released

*

* A container for SIP profile data for one SIP profile. 

* Provides functions for setting and getting profile parameters and

* serializing the profile data to a write stream and 

* reading the data from a read stream.

*

* @lib sipprofile.lib

*/

class CSIPConcreteProfile : public CBase

    {

    public: // Enumerations

        /** Profile states */

        enum TStatus

            {

            /** Unregistered */

            EUnregistered = 1,

            /** Unregistration in progress*/

            EUnregistrationInProgress,

            /** Registration is in progress */

            ERegistrationInProgress,

            /** Registered */

            ERegistered

            };

    public: // Constructors and destructor 

        /**

        * Constructs an object of type CSIPConcreteProfile.

        * @return new instance

        */

        IMPORT_C static CSIPConcreteProfile* NewL();

        /**

        * Constructs an object of type CSIPConcreteProfile 

        * and adds a pointer to it to the cleanup stack.

        * @return new instance

        */

        IMPORT_C static CSIPConcreteProfile* NewLC();

        /**

        * Clones profile. All non-dynamic values except profile id are copied.

        * @return new instance, the ownership is transferred

        */

        IMPORT_C CSIPConcreteProfile* CloneL() const;

        /**

        * Clones profile. All values are copied.

        * @return new instance, the ownership is transferred

        */

		IMPORT_C CSIPConcreteProfile* CloneWithDynamicValuesL() const;

        /**

        * Destructor.

        */

        IMPORT_C ~CSIPConcreteProfile();

    public: // New functions

        /**

        * Sets the profile id

        * @param aProfileId profile id

        */

        IMPORT_C void SetId(TUint32 aProfileId);

        /**

        * Gets the profile Id

        * @return profile Id

        */

        IMPORT_C TUint32 Id() const;

        /*

        * Sets the profile type

        * @param aProfileType the type of the profile

        */

        IMPORT_C void SetProfileType(const TSIPProfileTypeInfo& aProfileType);

        /**

        * Gets profile type.

        * @return profile type

        */

        IMPORT_C const TSIPProfileTypeInfo& ProfileType() const;

        /**

        * Sets the provider's name

        * @param aProviderName provider's name

        */

        IMPORT_C void SetProviderNameL(const TDesC8& aProviderName);

        /**

        * Gets the provider's name

        * @return provider's name, KNullDesC8 if not defined

        */

        IMPORT_C const TDesC8& ProviderName() const;

        /**

        * Sets the IAP ID for the connection

        * @param aIapId a IAP ID

        */

        IMPORT_C void SetIapId(TUint32 aIapId);

        /**

        * Gets the IAP ID used by the profile

        * @return IAP ID

        */

        IMPORT_C TUint32 IapId() const;

        /**

        * Sets the AOR (public user identity) used for the profile

        * @aAOR AORs to bet set

        */

        IMPORT_C void SetAORL(const TDesC8& aAOR);

        /**

        * Gets the AOR (public user identity) used for the profile

        * @return the AOR

        */

        IMPORT_C const TDesC8& AOR() const;

        /**

        * Gets the AOR used for the profile parsed as a URI

        * @return the AOR as a URI

        */

        IMPORT_C const TUriC8& AORUri8() const;

        /**

        * Enables/disables the usage of SigComp

        * @param aOn ETrue enables SigComp for the profile,

        *        EFalse disables it

        */

        IMPORT_C void EnableSigComp(TBool aOn=ETrue);

        /**

        * Checks if the profile uses SigComp

        * @return ETrue if it uses, EFalse if not

        */

        IMPORT_C TBool IsSigCompEnabled() const;

        /**

        * Enables/disables the usage of security negotiation

        * @param aOn ETrue enables security negotiation for the

        *        profile, EFalse disables it.

        */

        IMPORT_C void EnableSecurityNegotiation(TBool aOn=ETrue);

        /**

        * Checks if the profile uses SIP security negotiation

        * @return ETrue if it uses, EFalse if not

        */

        IMPORT_C TBool IsSecurityNegotiationEnabled() const;

        /**

        * Enables/disables auto registration

        * @param aOn ETrue enables profile auto-registration,

        *        EFalse disables it.

        */

        IMPORT_C void SetAutoRegistrationEnabled(TBool aOn=ETrue);

        /**

        * Checks if the profile is marked for auto-registration

        * @return ETrue if marked, EFalse otherwise

        */

        IMPORT_C TBool IsAutoRegistrationEnabled() const;

        /**

        * Sets the server's URI

        * @param aServer the type of the server

        * @param aURI a server address as a URI

        */

        IMPORT_C void SetServerL(

            TUint32 aServer,

            const TDesC8& aURI);

        /**

        * Gets the server's URI

        * @param aServer the type of the server

        * @return server's URI, KNullDesC8 if not defined

        */

        IMPORT_C const TDesC8& Server(TUint32 aServer) const;

        /**

        * Sets a server's parameter

        * @param aServer the type of the server

        * @param aServerParam the type of the parameter

        * @param aValue parameter's value

        */

        IMPORT_C void SetServerParameterL(

            TUint32 aServer,

            TUint32 aServerParam,

            const TDesC8& aValue);

        /**

        * Gets a server's parameter

        * @param aServer the type of the server

        * @param aServerParam the type of the parameter

        * @return parameter's value, KNullDesC8 if not defined

        */

        IMPORT_C const TDesC8& ServerParameter(

            TUint32 aServer,

            TUint32 aServerParam) const;

        /**

        * Sets a server's extension parameter

        * @param aServer the type of the server

        * @param aName the parameter's name

        * @param aValue parameter's value

        */

        IMPORT_C void SetServerExtensionParameterL(

            TUint32 aServer,

            const TDesC8& aName,

            const TDesC8& aValue);

        /**

        * Gets a server's extension parameter

        * @param aServer the type of the server

        * @param aName the parameter's name

        * @return parameter's value, KNullDesC8 if not defined

        */

        IMPORT_C const TDesC8& ServerExtensionParameter(

            TUint32 aServer,

            const TDesC8& aName) const;

        /**

        * Sets Contact-header parameters for the profile.

        * Each array element contains one parameter.

        * @param aParams parameters to set

        */

        IMPORT_C void SetContactHeaderParamsL(const MDesC8Array& aParams);

        /**

        * Gets all the Contact-header params defined for the profile.

        * Each array element contains one parameter.

        * @return array of Contact-header parameters

        */

        IMPORT_C const MDesC8Array& ContactHeaderParams() const;

        /**

        * Sets extra SIP headers for the profile.

        * Each array element contains one header including 

        * the name and the value, for example "HeaderName: value".

        * @param aParams parameters to set

        */

        IMPORT_C void SetSIPHeadersL(const MDesC8Array& aHeaders);

        /**

        * Gets all extra SIP headers defined for the profile.

        * Each array element contains one header including 

        * the name and the value, for example "HeaderName: value".

        * @return array of params

        */

        IMPORT_C const MDesC8Array& SIPHeaders() const;

        /**

        * Sets the user's private identity

        * @param aPrivateIdentity user's private identity

        */

        IMPORT_C void SetPrivateIdentityL(

            const TDesC8& aPrivateIdentity);

        /**

        * Gets the user private identity

        * @return user's private identity, KNullDesC8 if not defined

        */

        IMPORT_C const TDesC8& PrivateIdentity() const;

        /**

        * Sets an extension parameter of type TUint32.

        * @param aID parameter identifier

        * @param aValue parameter value

        */

        IMPORT_C void SetExtensionParameterL(

            TUint32 aID,

            TUint32 aValue);

        /**

        * Gets an extension parameter of type TUint32.

        * @param aID parameter identifier

        * @param aParam OUT: parameter's value, if found.

        * @return KErrNone If parameter value was retrieved

        *          KErrNotFound If no such parameter exists

        */

        IMPORT_C TInt ExtensionParameter(

            TUint aID,

            TUint32& aValue) const;

        /**

        * Sets an extension parameter of type TBool.

        * @param aID parameter identifier

        * @param aValue parameter value

        */

        IMPORT_C void SetExtensionParameterL(

            TUint32 aID,

            TBool aValue);

        /**

        * Gets an extension parameter of type TBool.

        * @param aID parameter identifier

        * @param aParam OUT: parameter's value, if found.

        * @return KErrNone If parameter value was retrieved

        *          KErrNotFound If no such parameter exists

        */

        IMPORT_C TInt ExtensionParameter(

            TUint aID,

            TBool& aValue) const;

        /**

        * Sets an extension parameter that is of descriptor type.

        * Empty descriptor removes the parameter.

        * @param aID parameter identifier

        * @param aValue parameter value

        */             

        IMPORT_C void SetExtensionParameterL(

            TUint32 aID,

            const TDesC8& aValue);

        /**

        * Gets an extension parameter that is of descriptor type.

        * @param aID parameter identifier

        * @param aParam OUT: parameter's value, if found.

        * @return KErrNone If parameter value was retrieved

        *          KErrNotFound If no such parameter exists

        */

        IMPORT_C TInt ExtensionParameter(

            TUint aID,

            TDesC8 const *& aValue) const;

        /**

        * Sets an extension parameters that is of descriptor array type.

        * @param aID parameter identifier

        * @param aValue parameter value

        */             

        IMPORT_C void SetExtensionParameterL(

            TUint32 aID,

            const MDesC8Array& aValue);

        /**

        * Gets an extension parameter that is of descriptor array type.

        * @param aID parameter identifier

        * @param aParam OUT: parameter's value, if found.

        * @return KErrNone If parameter value was retrieved

        *          KErrNotFound If no such parameter exists

        */

        IMPORT_C TInt ExtensionParameter(

            TUint aID,

            MDesC8Array const *& aValue) const;

        /**

        * Deserializes the profile from the stream

        * @param aReadStream stream holding serialized profile

        * @param aAll ETrue, if all values deserialized, 

        *         EFalse, if only non-dynamic values

        * @return new instance, the ownership is transferred

        */

        IMPORT_C static CSIPConcreteProfile* InternalizeL(

            RReadStream& aReadStream, 

            TBool aAll = ETrue);

        /**

        * Gets the size of the serialized profile

        * @param aAll ETrue, if all values serialized, 

        *        EFalse, if only non-dynamic values

        * @return size needed to serialize profile

        */

        IMPORT_C TUint ExternalizedSizeL(TBool aAll = ETrue) const;

        /**

        * Serializes the profile to the stream

        * @param aWriteStream stream where profile is to be serialized

        * @param aAll ETrue, if all values serialized, 

        *        EFalse, if only non-dynamic values

        */

        IMPORT_C void ExternalizeL(

            RWriteStream& aWriteStream, 

            TBool aAll = ETrue) const;

        /**

        * Sets/resets the profile to be the default one.

        * @param aOn ETrue sets the profile as default,

        *        EFalse removes the setting

        */

        IMPORT_C void SetDefault(TBool aOn=ETrue);

        /**

        * Checks if the profile is the default one

        * @return ETrue if the profile is the default one, EFalse if not

        */

        IMPORT_C TBool IsDefault() const;

        /**

        * Sets the negotiated security mechanism in use

        * @param aMechanism negotiated security mechanism

        */

        IMPORT_C void SetNegotiatedSecurityMechanismL(const TDesC8& aMechanism);

        /**

        * Gets the negotiated security mechanism

        * @return negotiated security mechanism

        */

        IMPORT_C const TDesC8& NegotiatedSecurityMechanism() const;

        /**

        * Sets the dynamic proxy address in use.

        * Dynamic proxy address is discovered on run-time, 

        * for eaxmple using DHCP.

        * @param aDynamicProxy proxy address

        */

        IMPORT_C void SetDynamicProxyL(const TDesC8& aDynamicProxy);

        /**

        * Gets the dynamic proxy address in use.

        * Dynamic proxy address is discovered on run-time, 

        * for eaxmple using DHCP.        

        * @return proxy address in use

        */

        IMPORT_C const TDesC8& DynamicProxy() const;

        /**

        * Sets dynamically registered AORs for the profile

        * @param aAORs AORs to set

        */

        IMPORT_C void SetRegisteredAORsL(const MDesC8Array& aAORs);

        /**

        * Gets dynamically registered AORs defined for the profile

        * @return array of AORs

        */

        IMPORT_C const MDesC8Array& RegisteredAORs() const;

        /**

        * Deserialize registered AORs into profile from stream

        * @param aReadStream stream holding serialized profile

        */

        IMPORT_C void InternalizeRegisteredAORsL(RReadStream& aReadStream);

        /**

        * Serialize registered AORs from profile to stream

        * @param aWriteStream stream where profile is to be serialized

        */

        IMPORT_C void ExternalizeRegisteredAORsL(

            RWriteStream& aWriteStream) const;

        /**

        * Get size of serialized registered AORs from profile 

        * @return size needed to serialize profile

        */

        IMPORT_C TUint ExternalizedRegisteredAORsSizeL() const;

        /**

        * Sets the status of the profile

        * @param aStatus status of the profile

        */

        IMPORT_C void SetStatus(CSIPConcreteProfile::TStatus aStatus);

        /**

        * Gets the status of the profile

        * @return status of the profile

        */

        IMPORT_C CSIPConcreteProfile::TStatus Status() const;

        /**

        * Sets the internal registration context id of the profile.

        * In practice this is the value of MSIPRegistrationContext::ContextId()

        * for a CSIPRegistrationBinding related to the profile.

        * @param aId context id

        */

        IMPORT_C void SetContextId(TUint32 aId);

        /**

        * Gets the internal registration context id of the profile.

        * In practice this is the value of MSIPRegistrationContext::ContextId()

        * for a CSIPRegistrationBinding related to the profile.        

        * @return context id

        */

        IMPORT_C TUint32 ContextId() const;

        /**

        * Sets last occurred error during registration

        * @param aError occurred error code

        */

        IMPORT_C void SetLastRegistrationError(TInt aError);

        /**

        * Gets last occurred error during registration

        * @return last occurred error code, KErrNone if no error

        */

        IMPORT_C TInt LastRegistrationError() const;