williamr@2: /*
williamr@2: * Copyright (c) 2006-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@2: * under the terms of the License "Symbian Foundation License v1.0" to Symbian Foundation members and "Symbian Foundation End User License Agreement v1.0" to non-members
williamr@2: * which accompanies this distribution, and is available
williamr@2: * at the URL "http://www.symbianfoundation.org/legal/licencesv10.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          : sipauthheaderbase.h
williamr@2: * Part of       : SIP Codec
williamr@2: * Version       : SIP/5.0 
williamr@2: *
williamr@2: */
williamr@2: 
williamr@2: 
williamr@2: 
williamr@2: #ifndef CSIPAUTHHEADERBASE_H
williamr@2: #define CSIPAUTHHEADERBASE_H
williamr@2: 
williamr@2: //  INCLUDES
williamr@2: #include "sipheaderbase.h"
williamr@2: #include "_sipcodecdefs.h"
williamr@2: 
williamr@2: // FORWARD DECLARATIONS
williamr@2: class CSIPParamContainerBase;
williamr@2: 
williamr@2: // CLASS DECLARATION
williamr@2: /**
williamr@2: * @publishedAll
williamr@2: * @released
williamr@2: *
williamr@2: * A base class for SIP Authorization-, Proxy-Authenticate-, 
williamr@2: * Proxy-Authorization- and WWW-Authenticate-headers
williamr@2: *
williamr@2: * @lib sipcodec.lib
williamr@2: */
williamr@2: class CSIPAuthHeaderBase : public CSIPHeaderBase
williamr@2: 	{
williamr@2: 	public: // Constructors and destructor
williamr@2: 
williamr@2: 		/**
williamr@2: 		* Destructor.
williamr@2: 		*/
williamr@2: 		IMPORT_C virtual ~CSIPAuthHeaderBase();
williamr@2: 
williamr@2: 
williamr@2: 	public:	// New functions
williamr@2: 
williamr@2: 		/**
williamr@2: 		* @return the value of the auth-scheme
williamr@2: 		*/
williamr@2: 		IMPORT_C RStringF AuthScheme() const;
williamr@2: 
williamr@2: 		/**
williamr@2: 		* Checks if a parameter is present
williamr@2: 		* @param aName the name of the parameter
williamr@2: 		* @return ETrue if present, otherwise EFalse
williamr@2: 		*/
williamr@2: 		IMPORT_C TBool HasParam(RStringF aName) const;
williamr@2: 
williamr@2: 		/**
williamr@2: 		* Gets a parameter value
williamr@2: 		* @pre HasParam(aName) == ETrue
williamr@2: 		* @param aName the name of the parameter
williamr@2: 		* @return the parameter value if present,
williamr@2: 		*         otherwise a zero-length length value.
williamr@2: 		*/
williamr@2: 		IMPORT_C RStringF ParamValue(RStringF aName) const;
williamr@2: 
williamr@2: 		/**
williamr@2: 		* Gets a parameter value stored as a descriptor
williamr@2: 		* @pre HasParam(aName) == ETrue
williamr@2: 		* @param aName the name of the parameter
williamr@2: 		* @return the parameter value if present,
williamr@2: 		*         otherwise a zero-length length value.
williamr@2: 		*/
williamr@2: 		IMPORT_C const TDesC8& DesParamValue(RStringF aName) const;
williamr@2: 
williamr@2: 		/**
williamr@2: 		* Sets a parameter with a value. 
williamr@2: 		* Takes copies of the name and value,
williamr@2: 		* so if the RStringFs have been dynamically allocated,
williamr@2: 		* they can be closed if necessary after the function returns.
williamr@2: 		* @pre HasParam(aName) == EFalse
williamr@2: 		* @param aName the name of the parameter
williamr@2: 		* @param aValue the parameter value to set
williamr@2: 		*/
williamr@2: 		IMPORT_C void SetParamL(RStringF aName, RStringF aValue);
williamr@2: 
williamr@2: 		/**
williamr@2: 		* Sets a parameter with a value. 
williamr@2: 		* Takes copies of the name 
williamr@2: 		* so if the RStringF have been dynamically allocated,
williamr@2: 		* they can be closed if necessary after the function returns.
williamr@2: 		* Stores the parameter value as a descriptor, so that the 
williamr@2: 		* case-sensitivity is not lost in RStringF-descriptor conversions. 
williamr@2: 		* @pre HasParam(aName) == EFalse
williamr@2: 		* @param aName the name of the parameter
williamr@2: 		* @param aValue the parameter value to set
williamr@2: 		*/
williamr@2: 		IMPORT_C void SetDesParamL(RStringF aName, const TDesC8& aValue);
williamr@2: 
williamr@2: 		/**
williamr@2: 		* Sets a parameter with a value and adds double quotes 
williamr@2: 		* as the first and the last character in the value.
williamr@2: 		* Takes copy of the name,
williamr@2: 		* so if the RStringF has been dynamically allocated,
williamr@2: 		* it can be closed if necessary after the function returns.
williamr@2: 		* @pre HasParam(aName) == EFalse
williamr@2: 		* @param aName the name of the parameter
williamr@2: 		* @param aValue the parameter value 
williamr@2: 		*        to which the double quotes will be added
williamr@2: 		*/
williamr@2: 		IMPORT_C void SetParamAndAddQuotesL(RStringF aName,
williamr@2: 			                                const TDesC8& aValue);
williamr@2: 
williamr@2: 		/**
williamr@2: 		* Deletes a parameter
williamr@2: 		* @param aName the parameter name to delete
williamr@2: 		*/
williamr@2: 		IMPORT_C void DeleteParam(RStringF aName);
williamr@2: 
williamr@2: 
williamr@2: 	public: // From CSIPHeaderBase
williamr@2: 
williamr@2: 		/**
williamr@2: 		* From CSIPHeaderBase ExternalizeSupported
williamr@2: 		*/
williamr@2: 		IMPORT_C virtual TBool ExternalizeSupported() const;
williamr@2: 
williamr@2: 
williamr@2: 	public: // From CSIPHeaderBase, for internal use
williamr@2: 
williamr@2: 		TBool EncodeMultipleToOneLine() const;
williamr@2: 		TBool MoreThanOneAllowed() const;
williamr@2: 		TPreferredPlace PreferredPlaceInMessage() const;
williamr@2:         virtual HBufC8* ToTextValueL() const;
williamr@2: 
williamr@2: 	protected: // Constructors
williamr@2: 
williamr@2: 		CSIPAuthHeaderBase();
williamr@2: 		void ConstructL(RStringF aAuthScheme);
williamr@2: 
williamr@2: 	protected: // New functions
williamr@2: 
williamr@2: 		void SetAuthSchemeL(const TDesC8& aAuthScheme);
williamr@2:         void ParseL(const TDesC8& aValue);
williamr@2:         virtual const CSIPParamContainerBase& Params() const = 0;
williamr@2:         virtual CSIPParamContainerBase& Params() = 0;
williamr@2: 
williamr@2: 	private: // Data
williamr@2: 
williamr@2: 		RStringF iAuthScheme;
williamr@2:         TChar iSeparator;
williamr@2: 	};
williamr@2: 
williamr@2: #endif // CSIPAUTHHEADERBASE_H
williamr@2: 
williamr@2: // End of File