realtimenetprots/sipfw/SIP/Codec/inc/sipauthenticationinfoheader.h
changeset 0 307788aac0a8
equal deleted inserted replaced
-1:000000000000 0:307788aac0a8
       
     1 /*
       
     2 * Copyright (c) 2005-2009 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:
       
    15 * Name          : sipauthenticationinfoheader.h
       
    16 * Part of       : SIP Codec
       
    17 * Version       : SIP/4.0 
       
    18 *
       
    19 */
       
    20 
       
    21 
       
    22 
       
    23 
       
    24 /**
       
    25  @internalComponent
       
    26 */
       
    27 
       
    28 
       
    29 #ifndef CSIPAUTHENTICATIONINFOHEADER_H
       
    30 #define CSIPAUTHENTICATIONINFOHEADER_H
       
    31 
       
    32 //  INCLUDES
       
    33 #include "sipparameterheaderbase.h"
       
    34 #include "_sipcodecdefs.h"
       
    35 
       
    36 // FORWARD DECLARATIONS
       
    37 class CSIPAuthenticationInfoHeaderParams;
       
    38 
       
    39 // CLASS DECLARATION
       
    40 /**
       
    41 * Class for a SIP Authentication-Info header.
       
    42 *
       
    43 * @lib sipcodec.lib
       
    44 */
       
    45 class CSIPAuthenticationInfoHeader : public CSIPHeaderBase
       
    46 	{
       
    47 	public:	// Constructors and destructor
       
    48 
       
    49 		/**
       
    50 		* Constructs a CSIPAuthenticationInfoHeader from textual representation
       
    51 		* of the header's value part.
       
    52 		* @param aValue a value part of the header
       
    53 		* @returns a new instance of CSIPAuthenticationInfoHeader
       
    54 		*/
       
    55 		IMPORT_C static CSIPAuthenticationInfoHeader* 
       
    56 			DecodeL(const TDesC8& aValue);
       
    57 
       
    58 		/**
       
    59 		* Destructor
       
    60 		*/
       
    61 		IMPORT_C ~CSIPAuthenticationInfoHeader();
       
    62 
       
    63 
       
    64 	public: // New functions
       
    65 
       
    66 		/**
       
    67 		* Gets the value of the given parameter
       
    68 		* @param aParam the name of the parameter
       
    69 		* @returns the parameter value
       
    70 		*/
       
    71 		IMPORT_C RStringF Value(RStringF aParam) const;
       
    72 
       
    73 		/**
       
    74 		* Gets the value of the given parameter stored as a descriptor.
       
    75 		* This is needed for parameters that have case sensitive values.
       
    76 		* @param aParam the name of the parameter
       
    77 		* @returns the parameter value
       
    78 		*/
       
    79 		IMPORT_C const TDesC8& DesValue(RStringF aParam) const;
       
    80 
       
    81 
       
    82 	public: // From CSIPHeaderBase
       
    83 
       
    84 		/**
       
    85 		* From CSIPHeaderBase CloneL
       
    86 		*/
       
    87 		IMPORT_C CSIPHeaderBase* CloneL() const;
       
    88 		
       
    89 		/**
       
    90 		* From CSIPHeaderBase Name
       
    91 		*/		
       
    92 		IMPORT_C RStringF Name() const;
       
    93 
       
    94 		/**
       
    95 		* From CSIPHeaderBase ToTextValueL
       
    96 		*/
       
    97 		IMPORT_C HBufC8* ToTextValueL() const;
       
    98 
       
    99 		/**
       
   100 		* From CSIPHeaderBase ExternalizeSupported
       
   101 		*/
       
   102 		IMPORT_C TBool ExternalizeSupported() const;
       
   103 
       
   104 
       
   105 	public: // From CSIPHeaderBase, for internal use
       
   106 	
       
   107         TBool EncodeMultipleToOneLine() const;
       
   108 		TPreferredPlace PreferredPlaceInMessage() const;
       
   109 
       
   110 	public: // New functions, for internal use
       
   111 
       
   112 		static RPointerArray<CSIPHeaderBase> BaseDecodeL(const TDesC8& aValue);
       
   113 
       
   114 	private: // Constructors
       
   115 
       
   116 		CSIPAuthenticationInfoHeader();
       
   117 		void ConstructL(const TDesC8& aValue);
       
   118 		void ConstructL(const CSIPAuthenticationInfoHeader& aHeader);
       
   119 
       
   120 	private: // Data
       
   121 
       
   122 		CSIPAuthenticationInfoHeaderParams* iParams;
       
   123 
       
   124 	private: // For testing purposes
       
   125 	
       
   126 		UNIT_TEST(CSIPAuthenticationInfoHeaderTest)
       
   127 	};
       
   128 
       
   129 #endif // CSIPAUTHENTICATIONINFOHEADER_H
       
   130 
       
   131 // End of File