williamr@2: /*
williamr@2: * Copyright (c) 2004-2009 Nokia Corporation and/or its subsidiary(-ies).
williamr@2: * All rights reserved.
williamr@2: * This component and the accompanying materials are made available
williamr@4: * under the terms of "Eclipse Public License v1.0"
williamr@2: * which accompanies this distribution, and is available
williamr@4: * at the URL "http://www.eclipse.org/legal/epl-v10.html".
williamr@2: *
williamr@2: * Initial Contributors:
williamr@2: * Nokia Corporation - initial contribution.
williamr@2: *
williamr@2: * Contributors:
williamr@2: *
williamr@2: * Description:
williamr@2: * Name        : sipsecurityclientheader.h
williamr@2: * Part of     : SIP Codec
williamr@2: * Interface   : SDK API, SIP Codec API
williamr@2: * Version     : SIP/4.0 
williamr@2: *
williamr@2: */
williamr@2: 
williamr@2: 
williamr@2: 
williamr@2: 
williamr@2: #ifndef CSIPSECURITYCLIENTHEADER_H
williamr@2: #define CSIPSECURITYCLIENTHEADER_H
williamr@2: 
williamr@2: //  INCLUDES
williamr@2: #include "sipsecurityheaderbase.h"
williamr@2: 
williamr@2: // CLASS DECLARATION
williamr@2: /**
williamr@2: * @publishedAll
williamr@2: * @released
williamr@2: *
williamr@2: * Class provides functions for setting and getting SIP "Security-Client"
williamr@2: * header fields.
williamr@2: *
williamr@2: *  @lib sipcodec.lib
williamr@2: */
williamr@2: class CSIPSecurityClientHeader : public CSIPSecurityHeaderBase
williamr@2: 	{
williamr@2: 	public:	// Constructors and destructor
williamr@2: 
williamr@2: 		/**
williamr@2: 		* Constructs a CSIPSecurityClientHeader from textual representation
williamr@2: 		* of the header's value part.
williamr@2: 		* @param aValue a value part of a "Security-Client"-header
williamr@2: 		* @return an array containing 1..n instances of CSIPSecurityClientHeader
williamr@2: 		*/
williamr@2: 		IMPORT_C static RPointerArray<CSIPSecurityClientHeader> 
williamr@2: 			DecodeL(const TDesC8& aValue);
williamr@2: 
williamr@2: 		/**
williamr@2: 		* Creates a new instance of CSIPSecurityClientHeader
williamr@2: 		* @param aMechanism a Mechanism-Name parameter 
williamr@2: 		*        in the "Security-Client" header
williamr@2: 		* @return a new instance of CSIPSecurityClientHeader
williamr@2: 		*/
williamr@2: 		IMPORT_C static CSIPSecurityClientHeader* 
williamr@2: 			NewL(const TDesC8& aMechanism);
williamr@2: 
williamr@2: 		/**
williamr@2: 		* Creates a new instance of CSIPSecurityClientHeader 
williamr@2: 		* and puts it to CleanupStack
williamr@2: 		* @param aMechanism a Mechanism-Name parameter 
williamr@2: 		* in the "Security-Client" header
williamr@2: 		* @return a new instance of CSIPSecurityClientHeader
williamr@2: 		*/
williamr@2: 		IMPORT_C static CSIPSecurityClientHeader* 
williamr@2: 			NewLC(const TDesC8& aMechanism);
williamr@2: 
williamr@2: 		/**
williamr@2: 		* Destructor, deletes the resources of CSIPSecurityClientHeader.
williamr@2: 		*/
williamr@2: 		IMPORT_C ~CSIPSecurityClientHeader();
williamr@2: 
williamr@2: 
williamr@2: 	public: // New functions
williamr@2: 
williamr@2: 		/**
williamr@2: 		* Constructs an instance of a CSIPSecurityClientHeader 
williamr@2: 		* from a RReadStream
williamr@2: 		* @param aReadStream a stream containing the value of the
williamr@2: 		*        externalized object (header name not included). 
williamr@2: 		* @return an instance of a CSIPSecurityClientHeader
williamr@2: 		*/
williamr@2: 
williamr@2: 		IMPORT_C static CSIPHeaderBase* 
williamr@2: 			InternalizeValueL(RReadStream& aReadStream);
williamr@2: 
williamr@2: 
williamr@2: 	public: // From CSIPHeaderBase
williamr@2: 
williamr@2: 		/**
williamr@2: 		* From CSIPHeaderBase CloneL
williamr@2: 		*/
williamr@2: 		IMPORT_C CSIPHeaderBase* CloneL() const;
williamr@2: 
williamr@2: 		/**
williamr@2: 		* From CSIPHeaderBase Name
williamr@2: 		*/
williamr@2: 		IMPORT_C RStringF Name() const;
williamr@2: 
williamr@2: 
williamr@2: 	public: // New functions, for internal use
williamr@2: 
williamr@2: 		static RPointerArray<CSIPHeaderBase> BaseDecodeL(const TDesC8& aValue);
williamr@2: 
williamr@2: 	private: // New functions
williamr@2: 
williamr@2: 		CSIPSecurityClientHeader() ;
williamr@2: 
williamr@2: 	private: // For testing purposes
williamr@4: #ifdef CPPUNIT_TEST	
williamr@4: 		friend class CSIPSecurityHeaderBaseTest;
williamr@4: #endif
williamr@2:     };
williamr@2: 
williamr@2: #endif // CSIPSECURITYCLIENTHEADER_H
williamr@2: 
williamr@2: // End of File