williamr@2: /*
williamr@2: * Copyright (c) 2004-2009 Nokia Corporation and/or its subsidiary(-ies).
williamr@2: * All rights reserved.
williamr@2: * This component and the accompanying materials are made available
williamr@4: * under the terms of "Eclipse Public License v1.0"
williamr@2: * which accompanies this distribution, and is available
williamr@4: * at the URL "http://www.eclipse.org/legal/epl-v10.html".
williamr@2: *
williamr@2: * Initial Contributors:
williamr@2: * Nokia Corporation - initial contribution.
williamr@2: *
williamr@2: * Contributors:
williamr@2: *
williamr@2: * Description:
williamr@2: * Name        : sipsecurityheaderbase.h
williamr@2: * Part of     : SIP Codec
williamr@2: * Interface   : SDK API, SIP Codec API
williamr@2: * Version     : SIP/4.0 
williamr@2: *
williamr@2: */
williamr@2: 
williamr@2: 
williamr@2: 
williamr@2: 
williamr@2: #ifndef CSIPSECURITYHEADERBASE_H
williamr@2: #define CSIPSECURITYHEADERBASE_H
williamr@2: 
williamr@2: //  INCLUDES
williamr@2: #include "sipparameterheaderbase.h"
williamr@2: 
williamr@2: // FORWARD DECLARATIONS
williamr@2: class CSIPSecurityHeaderBaseParams;
williamr@2: 
williamr@2: // CLASS DECLARATION
williamr@2: /**
williamr@2: * @publishedAll
williamr@2: * @released
williamr@2: *
williamr@2: * A base class for Security-Client, Security-Server and Security-Verify.
williamr@2: *
williamr@2: *  @lib sipcodec.lib
williamr@2: */
williamr@2: class CSIPSecurityHeaderBase : public CSIPParameterHeaderBase
williamr@2: 	{
williamr@2: 	public:	// Constructors and destructor
williamr@2: 
williamr@2: 		/**
williamr@2: 		* Destructor, deletes the resources of CSIPSecurityHeaderBase.
williamr@2: 		*/
williamr@2: 		IMPORT_C virtual ~CSIPSecurityHeaderBase();
williamr@2: 
williamr@2: 	public: // New functions
williamr@2: 
williamr@2: 		/**
williamr@2: 		* Gets the value of "q"-parameter
williamr@2: 		* @return the "q"-parameter value, zero if not present 
williamr@2: 		*/
williamr@2: 		IMPORT_C TReal PreferenceParam() const;
williamr@2: 
williamr@2: 		/**
williamr@2: 		* Sets the "q"-parameter value
williamr@2: 		* @param aPreferenceValue a "q"-parameter value to set
williamr@2: 		*/
williamr@2: 		IMPORT_C void SetPreferenceParamL(TReal aPreferenceValue);
williamr@2: 
williamr@2: 		/**
williamr@2: 		* Gets the Mechanism-Name from the Security header
williamr@2: 		* @return a Mechanism-Name
williamr@2: 		*/
williamr@2: 		IMPORT_C const TDesC8& MechanismName() const;
williamr@2: 
williamr@2: 		/**
williamr@2: 		* Sets the Mechanism-Name in the Security header
williamr@2: 		* @param aMechanismName a Mechanism-Name
williamr@2: 		*/
williamr@2: 		IMPORT_C void SetMechanismNameL(const TDesC8& aMechanismName);
williamr@2: 
williamr@2: 	public: // From CSIPHeaderBase, for internal use
williamr@2: 
williamr@2:         /**
williamr@2:         * @internalComponent
williamr@2:         */
williamr@2: 		TBool MoreThanOneAllowed() const;
williamr@2: 		
williamr@2:         /**
williamr@2:         * @internalComponent
williamr@2:         */		
williamr@2: 		TPreferredPlace PreferredPlaceInMessage() const;
williamr@2: 
williamr@2: 	protected: // Constructors
williamr@2: 
williamr@2: 		CSIPSecurityHeaderBase();
williamr@2: 		void ConstructL();
williamr@2: 		void ConstructL(const TDesC8& aMechanismName);
williamr@2: 		void ConstructL(const CSIPSecurityHeaderBase& aSecurityHeaderBase);
williamr@2: 	
williamr@2: 	protected: // New functions	
williamr@2: 		
williamr@2: 		void DoInternalizeValueL(RReadStream& aReadStream);
williamr@2: 
williamr@2: 	private: // From CSIPHeaderBase
williamr@2: 
williamr@2: 		void ExternalizeValueL(RWriteStream& aWriteStream) const;
williamr@2: 
williamr@2: 	private: // From CSIPParameterHeaderBase
williamr@2: 
williamr@2: 		HBufC8* ToTextMandatoryPartLC() const;
williamr@2: 		void ParseMandatoryPartL(const TDesC8& aMandatoryPart);
williamr@2: 		const CSIPParamContainerBase& Params() const;
williamr@2: 		CSIPParamContainerBase& Params();
williamr@2: 
williamr@2: 	private: // Data
williamr@2: 
williamr@2: 		HBufC8* iMechanismName;
williamr@2: 		CSIPSecurityHeaderBaseParams* iParams;
williamr@2: 
williamr@2: 	private: // For testing purposes
williamr@4: #ifdef CPPUNIT_TEST	
williamr@4: 		friend class CSIPSecurityHeaderBaseTest;
williamr@4: #endif
williamr@2: 	};
williamr@2: 
williamr@2: #endif // CSIPSECURITYHEADERBASE_H
williamr@2: 
williamr@2: // End of File