epoc32/include/mw/sipauthorizationheader.h
author William Roberts <williamr@symbian.org>
Wed, 31 Mar 2010 12:27:01 +0100
branchSymbian2
changeset 3 e1b950c65cb4
parent 2 epoc32/include/sipauthorizationheader.h@2fe1408b6811
child 4 837f303aceeb
permissions -rw-r--r--
Attempt to represent the S^2->S^3 header reorganisation as a series of "hg rename" operations
     1 /*
     2 * Copyright (c) 2007-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 the License "Symbian Foundation License v1.0" to Symbian Foundation members and "Symbian Foundation End User License Agreement v1.0" to non-members
     6 * which accompanies this distribution, and is available
     7 * at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
     8 *
     9 * Initial Contributors:
    10 * Nokia Corporation - initial contribution.
    11 *
    12 * Contributors:
    13 *
    14 * Description:
    15 * Name          : sipauthorizationheader.h
    16 * Part of       : SIP Codec
    17 * Version       : SIP/6.0 
    18 *
    19 */
    20 
    21 
    22 
    23 #ifndef CSIPAUTHORIZATIONHEADER_H
    24 #define CSIPAUTHORIZATIONHEADER_H
    25 
    26 //  INCLUDES
    27 #include "sipauthorizationheaderbase.h"
    28 #include "_sipcodecdefs.h"
    29 
    30 // CLASS DECLARATION
    31 /**
    32 * @publishedAll
    33 * @released
    34 *
    35 * Class for SIP Authorization-header manipulation.
    36 * @lib sipcodec.lib
    37 */
    38 class CSIPAuthorizationHeader : public CSIPAuthorizationHeaderBase
    39 	{
    40 	public:	// Constructors and destructor
    41 
    42 		/**
    43 		* Constructs a CSIPAuthorizationHeader 
    44 		* from textual representation of the header's value part.
    45 		* @param aValue a value part of a "Proxy-Authenticate"-header 
    46 		* @return a new instance of CSIPAuthorizationHeader
    47 		*/
    48 		IMPORT_C static CSIPAuthorizationHeader* 
    49 			DecodeL(const TDesC8& aValue);
    50 
    51 		/**
    52 		* Creates a new instance of CSIPAuthorizationHeader
    53 		* @return a new instance of CSIPAuthorizationHeader
    54 		*/
    55 		IMPORT_C static CSIPAuthorizationHeader* 
    56 			NewL(RStringF aAuthScheme);
    57 
    58 		/**
    59 		* Creates a new instance of CSIPAuthorizationHeader
    60 		* @return a new instance of CSIPAuthorizationHeader
    61 		*/
    62 		IMPORT_C static CSIPAuthorizationHeader* 
    63 			NewLC(RStringF aAuthScheme);
    64 
    65 		/**
    66 		* Creates a deep-copy of a CSIPAuthorizationHeaderBase
    67 		* @param aAuthenticateHeaderBase to be copied
    68 		* @return a new instance of CSIPAuthorizationHeader
    69 		*/
    70 		IMPORT_C static CSIPAuthorizationHeader* 
    71 			NewL(const CSIPAuthorizationHeaderBase& aHeader);
    72 
    73 		/**
    74 		* Creates a deep-copy of a CSIPAuthorizationHeaderBase
    75 		* @param aAuthenticateHeaderBase to be copied
    76 		* @return a new instance of CSIPAuthorizationHeader
    77 		*/
    78 		IMPORT_C static CSIPAuthorizationHeader* 
    79 			NewLC(const CSIPAuthorizationHeaderBase& aHeader);
    80 
    81 		/**
    82 		* Destructor
    83 		*/
    84 		IMPORT_C ~CSIPAuthorizationHeader();
    85 
    86 	public: // From CSIPHeaderBase
    87 
    88 		/**
    89 		* From CSIPHeaderBase ExternalizeSupported
    90 		*/
    91 		IMPORT_C TBool ExternalizeSupported() const;
    92 
    93 		/**
    94 		* From CSIPHeaderBase CloneL
    95 		*/
    96 		IMPORT_C CSIPHeaderBase* CloneL() const;
    97 		
    98 		/**
    99 		* From CSIPHeaderBase Name
   100 		*/		
   101 		IMPORT_C RStringF Name() const;
   102 
   103 
   104 	public: // New functions, for internal use
   105 
   106         /**
   107         * @internalComponent
   108         */
   109 		static RPointerArray<CSIPHeaderBase> BaseDecodeL(const TDesC8& aValue);
   110 		
   111         /**
   112         * @internalComponent
   113         */		
   114 		static CSIPHeaderBase* InternalizeValueL(RReadStream& aReadStream);
   115 
   116 	private: // Constructors
   117 
   118 		CSIPAuthorizationHeader();
   119 
   120 	private: // From CSIPHeaderBase
   121 
   122 		void ExternalizeValueL(RWriteStream& aWriteStream) const;
   123 
   124     private: // For testing purposes
   125 
   126         UNIT_TEST(CSIPAuthorizationHeaderTest)
   127 	};
   128 
   129 #endif // CSIPAUTHORIZATIONHEADER_H
   130 
   131 // End of File