epoc32/include/sipwwwauthenticateheader.h
author William Roberts <williamr@symbian.org>
Tue, 16 Mar 2010 16:12:26 +0000
branchSymbian2
changeset 2 2fe1408b6811
parent 0 061f57f2323e
permissions -rw-r--r--
Final list of Symbian^2 public API header files
     1 /*
     2 * Copyright (c) 2006-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          : sipwwwauthenticateheader.h
    16 * Part of       : SIP Codec
    17 * Version       : SIP/5.0 
    18 *
    19 */
    20 
    21 
    22 
    23 #ifndef CSIPWWWAUTHENTICATEHEADER_H
    24 #define CSIPWWWAUTHENTICATEHEADER_H
    25 
    26 //  INCLUDES
    27 #include "sipauthenticateheaderbase.h"
    28 #include "_sipcodecdefs.h"
    29 
    30 // CLASS DECLARATION
    31 /**
    32 * @publishedAll
    33 * @released
    34 *
    35 * Class for SIP WWW-Authenticate-header manipulation.
    36 *
    37 * @lib sipcodec.lib
    38 */
    39 class CSIPWWWAuthenticateHeader : public CSIPAuthenticateHeaderBase
    40 	{
    41 	public:	// Constructors and destructor
    42 
    43 		/**
    44 		* Constructs a CSIPWWWAuthenticateHeader from textual representation
    45 		* of the header's value part.
    46 		* @param aValue a value part of a "WWW-Authenticate"-header 
    47 		* @return a new instance of CSIPWWWAuthenticateHeader
    48 		*/
    49 		IMPORT_C static CSIPWWWAuthenticateHeader* 
    50 			DecodeL(const TDesC8& aValue);
    51 
    52 		/**
    53 		* Creates a new instance of CSIPWWWAuthenticateHeader
    54 		* @return a new instance of CSIPWWWAuthenticateHeader
    55 		*/
    56 		IMPORT_C static CSIPWWWAuthenticateHeader* 
    57 			NewL(RStringF aAuthScheme);
    58 
    59 		/**
    60 		* Creates a new instance of CSIPWWWAuthenticateHeader
    61 		* @return a new instance of CSIPWWWAuthenticateHeader
    62 		*/
    63 		IMPORT_C static CSIPWWWAuthenticateHeader* 
    64 			NewLC(RStringF aAuthScheme);
    65 
    66 		/**
    67 		* Destructor
    68 		*/
    69 		IMPORT_C ~CSIPWWWAuthenticateHeader();
    70 
    71 	public: // From CSIPHeaderBase
    72 
    73 		/**
    74 		* From CSIPHeaderBase CloneL
    75 		*/
    76 		IMPORT_C CSIPHeaderBase* CloneL() const;
    77 		
    78 		/**
    79 		* From CSIPHeaderBase Name
    80 		*/		
    81 		IMPORT_C RStringF Name() const;
    82 
    83 	public: // New functions, for internal use
    84 
    85 		static RPointerArray<CSIPHeaderBase> BaseDecodeL(const TDesC8& aValue);
    86 		static CSIPHeaderBase* InternalizeValueL(RReadStream& aReadStream);
    87 
    88 	private: // Constructors
    89 
    90 		CSIPWWWAuthenticateHeader();
    91 	
    92     private: // For testing purposes
    93 	
    94 		UNIT_TEST(CSIPWWWAuthenticateHeaderTest)
    95 	};
    96 
    97 #endif // CSIPWWWAUTHENTICATEHEADER_H
    98 
    99 // End of File