epoc32/include/sipauthorizationheader.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
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@2
     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
williamr@2
     6
* which accompanies this distribution, and is available
williamr@2
     7
* at the URL "http://www.symbianfoundation.org/legal/licencesv10.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
#include "_sipcodecdefs.h"
williamr@2
    29
williamr@2
    30
// CLASS DECLARATION
williamr@2
    31
/**
williamr@2
    32
* @publishedAll
williamr@2
    33
* @released
williamr@2
    34
*
williamr@2
    35
* Class for SIP Authorization-header manipulation.
williamr@2
    36
* @lib sipcodec.lib
williamr@2
    37
*/
williamr@2
    38
class CSIPAuthorizationHeader : public CSIPAuthorizationHeaderBase
williamr@2
    39
	{
williamr@2
    40
	public:	// Constructors and destructor
williamr@2
    41
williamr@2
    42
		/**
williamr@2
    43
		* Constructs a CSIPAuthorizationHeader 
williamr@2
    44
		* from textual representation of the header's value part.
williamr@2
    45
		* @param aValue a value part of a "Proxy-Authenticate"-header 
williamr@2
    46
		* @return a new instance of CSIPAuthorizationHeader
williamr@2
    47
		*/
williamr@2
    48
		IMPORT_C static CSIPAuthorizationHeader* 
williamr@2
    49
			DecodeL(const TDesC8& aValue);
williamr@2
    50
williamr@2
    51
		/**
williamr@2
    52
		* Creates a new instance of CSIPAuthorizationHeader
williamr@2
    53
		* @return a new instance of CSIPAuthorizationHeader
williamr@2
    54
		*/
williamr@2
    55
		IMPORT_C static CSIPAuthorizationHeader* 
williamr@2
    56
			NewL(RStringF aAuthScheme);
williamr@2
    57
williamr@2
    58
		/**
williamr@2
    59
		* Creates a new instance of CSIPAuthorizationHeader
williamr@2
    60
		* @return a new instance of CSIPAuthorizationHeader
williamr@2
    61
		*/
williamr@2
    62
		IMPORT_C static CSIPAuthorizationHeader* 
williamr@2
    63
			NewLC(RStringF aAuthScheme);
williamr@2
    64
williamr@2
    65
		/**
williamr@2
    66
		* Creates a deep-copy of a CSIPAuthorizationHeaderBase
williamr@2
    67
		* @param aAuthenticateHeaderBase to be copied
williamr@2
    68
		* @return a new instance of CSIPAuthorizationHeader
williamr@2
    69
		*/
williamr@2
    70
		IMPORT_C static CSIPAuthorizationHeader* 
williamr@2
    71
			NewL(const CSIPAuthorizationHeaderBase& aHeader);
williamr@2
    72
williamr@2
    73
		/**
williamr@2
    74
		* Creates a deep-copy of a CSIPAuthorizationHeaderBase
williamr@2
    75
		* @param aAuthenticateHeaderBase to be copied
williamr@2
    76
		* @return a new instance of CSIPAuthorizationHeader
williamr@2
    77
		*/
williamr@2
    78
		IMPORT_C static CSIPAuthorizationHeader* 
williamr@2
    79
			NewLC(const CSIPAuthorizationHeaderBase& aHeader);
williamr@2
    80
williamr@2
    81
		/**
williamr@2
    82
		* Destructor
williamr@2
    83
		*/
williamr@2
    84
		IMPORT_C ~CSIPAuthorizationHeader();
williamr@2
    85
williamr@2
    86
	public: // From CSIPHeaderBase
williamr@2
    87
williamr@2
    88
		/**
williamr@2
    89
		* From CSIPHeaderBase ExternalizeSupported
williamr@2
    90
		*/
williamr@2
    91
		IMPORT_C TBool ExternalizeSupported() const;
williamr@2
    92
williamr@2
    93
		/**
williamr@2
    94
		* From CSIPHeaderBase CloneL
williamr@2
    95
		*/
williamr@2
    96
		IMPORT_C CSIPHeaderBase* CloneL() const;
williamr@2
    97
		
williamr@2
    98
		/**
williamr@2
    99
		* From CSIPHeaderBase Name
williamr@2
   100
		*/		
williamr@2
   101
		IMPORT_C RStringF Name() const;
williamr@2
   102
williamr@2
   103
williamr@2
   104
	public: // New functions, for internal use
williamr@2
   105
williamr@2
   106
        /**
williamr@2
   107
        * @internalComponent
williamr@2
   108
        */
williamr@2
   109
		static RPointerArray<CSIPHeaderBase> BaseDecodeL(const TDesC8& aValue);
williamr@2
   110
		
williamr@2
   111
        /**
williamr@2
   112
        * @internalComponent
williamr@2
   113
        */		
williamr@2
   114
		static CSIPHeaderBase* InternalizeValueL(RReadStream& aReadStream);
williamr@2
   115
williamr@2
   116
	private: // Constructors
williamr@2
   117
williamr@2
   118
		CSIPAuthorizationHeader();
williamr@2
   119
williamr@2
   120
	private: // From CSIPHeaderBase
williamr@2
   121
williamr@2
   122
		void ExternalizeValueL(RWriteStream& aWriteStream) const;
williamr@2
   123
williamr@2
   124
    private: // For testing purposes
williamr@2
   125
williamr@2
   126
        UNIT_TEST(CSIPAuthorizationHeaderTest)
williamr@2
   127
	};
williamr@2
   128
williamr@2
   129
#endif // CSIPAUTHORIZATIONHEADER_H
williamr@2
   130
williamr@2
   131
// End of File