epoc32/include/sipproxyauthorizationheader.h
author William Roberts <williamr@symbian.org>
Tue, 16 Mar 2010 16:12:26 +0000
branchSymbian2
changeset 2 2fe1408b6811
permissions -rw-r--r--
Final list of Symbian^2 public API header files
     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          : sipproxyauthorizationheader.h
    16 * Part of       : SIP Codec
    17 * Version       : SIP/6.0 
    18 *
    19 */
    20 
    21 
    22 
    23 #ifndef CSIPPROXYAUTHORIZATIONHEADER_H
    24 #define CSIPPROXYAUTHORIZATIONHEADER_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 Proxy-Authorization-header manipulation.
    36 *
    37 * @lib sipcodec.lib
    38 */
    39 class CSIPProxyAuthorizationHeader : public CSIPAuthorizationHeaderBase
    40 	{
    41 	public:	// Constructors and destructor
    42 
    43 		/**
    44 		* Constructs a CSIPProxyAuthorizationHeader 
    45 		* from textual representation of the header's value part.
    46 		* @param aValue a value part of a "Proxy-Authenticate"-header 
    47 		* @return a new instance of CSIPProxyAuthorizationHeader
    48 		*/
    49 		IMPORT_C static CSIPProxyAuthorizationHeader* 
    50 			DecodeL(const TDesC8& aValue);
    51 
    52 		/**
    53 		* Creates a new instance of CSIPProxyAuthorizationHeader
    54 		* @return a new instance of CSIPProxyAuthorizationHeader
    55 		*/
    56 		IMPORT_C static CSIPProxyAuthorizationHeader* 
    57 			NewL(RStringF aAuthScheme);
    58 
    59 		/**
    60 		* Creates a new instance of CSIPProxyAuthorizationHeader
    61 		* @return a new instance of CSIPProxyAuthorizationHeader
    62 		*/
    63 		IMPORT_C static CSIPProxyAuthorizationHeader* 
    64 			NewLC(RStringF aAuthScheme);
    65 
    66 		/**
    67 		* Creates a deep-copy of a CSIPAuthorizationHeaderBase
    68 		* @param aAuthenticateHeaderBase to be copied
    69 		* @return a new instance of CSIPProxyAuthorizationHeader
    70 		*/
    71 		IMPORT_C static CSIPProxyAuthorizationHeader* 
    72 			NewL(const CSIPAuthorizationHeaderBase& aHeader);
    73 
    74 		/**
    75 		* Creates a deep-copy of a CSIPAuthorizationHeaderBase
    76 		* @param aAuthenticateHeaderBase to be copied
    77 		* @return a new instance of CSIPProxyAuthorizationHeader
    78 		*/
    79 		IMPORT_C static CSIPProxyAuthorizationHeader* 
    80 			NewLC(const CSIPAuthorizationHeaderBase& aHeader);
    81 
    82 		/**
    83 		* Destructor
    84 		*/
    85 		IMPORT_C ~CSIPProxyAuthorizationHeader();
    86 
    87 	public: // From CSIPHeaderBase
    88 
    89 		/**
    90 		* From CSIPHeaderBase ExternalizeSupported
    91 		*/
    92 		IMPORT_C TBool ExternalizeSupported() const;
    93 
    94 		/**
    95 		* From CSIPHeaderBase CloneL
    96 		*/
    97 		IMPORT_C CSIPHeaderBase* CloneL() const;
    98 		
    99 		/**
   100 		* From CSIPHeaderBase Name
   101 		*/		
   102 		IMPORT_C RStringF Name() const;
   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 		CSIPProxyAuthorizationHeader();
   119 
   120 	private: // From CSIPHeaderBase
   121 
   122 		void ExternalizeValueL(RWriteStream& aWriteStream) const;
   123 
   124     private: // For testing purposes
   125 
   126         UNIT_TEST(CSIPProxyAuthorizationHeaderTest)
   127 	};
   128 
   129 #endif // CSIPPROXYAUTHORIZATIONHEADER_H
   130 
   131 // End of File