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