epoc32/include/mw/sipwwwauthenticateheader.h
author William Roberts <williamr@symbian.org>
Wed, 31 Mar 2010 12:33:34 +0100
branchSymbian3
changeset 4 837f303aceeb
parent 3 e1b950c65cb4
permissions -rw-r--r--
Current Symbian^3 public API header files (from PDK 3.0.h)
This is the epoc32/include tree with the "platform" subtrees removed, and
all but a selected few mbg and rsg files removed.
     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 "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          : 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 
    29 // CLASS DECLARATION
    30 /**
    31 * @publishedAll
    32 * @released
    33 *
    34 * Class for SIP WWW-Authenticate-header manipulation.
    35 *
    36 * @lib sipcodec.lib
    37 */
    38 class CSIPWWWAuthenticateHeader : public CSIPAuthenticateHeaderBase
    39 	{
    40 	public:	// Constructors and destructor
    41 
    42 		/**
    43 		* Constructs a CSIPWWWAuthenticateHeader from textual representation
    44 		* of the header's value part.
    45 		* @param aValue a value part of a "WWW-Authenticate"-header 
    46 		* @return a new instance of CSIPWWWAuthenticateHeader
    47 		*/
    48 		IMPORT_C static CSIPWWWAuthenticateHeader* 
    49 			DecodeL(const TDesC8& aValue);
    50 
    51 		/**
    52 		* Creates a new instance of CSIPWWWAuthenticateHeader
    53 		* @return a new instance of CSIPWWWAuthenticateHeader
    54 		*/
    55 		IMPORT_C static CSIPWWWAuthenticateHeader* 
    56 			NewL(RStringF aAuthScheme);
    57 
    58 		/**
    59 		* Creates a new instance of CSIPWWWAuthenticateHeader
    60 		* @return a new instance of CSIPWWWAuthenticateHeader
    61 		*/
    62 		IMPORT_C static CSIPWWWAuthenticateHeader* 
    63 			NewLC(RStringF aAuthScheme);
    64 
    65 		/**
    66 		* Destructor
    67 		*/
    68 		IMPORT_C ~CSIPWWWAuthenticateHeader();
    69 
    70 	public: // From CSIPHeaderBase
    71 
    72 		/**
    73 		* From CSIPHeaderBase CloneL
    74 		*/
    75 		IMPORT_C CSIPHeaderBase* CloneL() const;
    76 		
    77 		/**
    78 		* From CSIPHeaderBase Name
    79 		*/		
    80 		IMPORT_C RStringF Name() const;
    81 
    82 	public: // New functions, for internal use
    83 
    84 		static RPointerArray<CSIPHeaderBase> BaseDecodeL(const TDesC8& aValue);
    85 		static CSIPHeaderBase* InternalizeValueL(RReadStream& aReadStream);
    86 
    87 	private: // Constructors
    88 
    89 		CSIPWWWAuthenticateHeader();
    90 	
    91     private: // For testing purposes
    92 #ifdef CPPUNIT_TEST	
    93 		friend class CSIPWWWAuthenticateHeaderTest;
    94 #endif
    95 	};
    96 
    97 #endif // CSIPWWWAUTHENTICATEHEADER_H
    98 
    99 // End of File