sl@0: // Copyright (c) 2001-2009 Nokia Corporation and/or its subsidiary(-ies). sl@0: // All rights reserved. sl@0: // This component and the accompanying materials are made available sl@0: // under the terms of "Eclipse Public License v1.0" sl@0: // which accompanies this distribution, and is available sl@0: // at the URL "http://www.eclipse.org/legal/epl-v10.html". sl@0: // sl@0: // Initial Contributors: sl@0: // Nokia Corporation - initial contribution. sl@0: // sl@0: // Contributors: sl@0: // sl@0: // Description: sl@0: // This file contains the API definition for the classes TAuthorityC16 and sl@0: // CAuthority16. These classes provide non-modifying (TAuthorityC16) and sl@0: // modifying (CAuthority16) functionality for the components of an sl@0: // Authority as described in RFC2396. sl@0: // sl@0: // sl@0: sl@0: /** sl@0: @file Authority16.h sl@0: @publishedAll sl@0: @deprecated Deprecated in 9.1 sl@0: */ sl@0: sl@0: #ifndef __AUTHORITY16_H__ sl@0: #define __AUTHORITY16_H__ sl@0: sl@0: // System includes sl@0: // sl@0: #include sl@0: #include sl@0: sl@0: sl@0: /** sl@0: Dependencies : TAuthorityComponent. sl@0: Comments : Provides non-modifying functionality on the components of an authority sl@0: object as defined in RFC2396. There are 3 components; userinfo, host and port. sl@0: sl@0: The object holds descriptor pointers to the parsed authority components and a descriptor sl@0: pointer to the authority. It is non-owning. It uses 16-bit descriptors. sl@0: sl@0: The functionality provided by this API allows the authority components to be extracted sl@0: from the parsed authority, checked for their presence in the authority and be compared sl@0: with those in another TAuthorityC16 object. sl@0: @publishedAll sl@0: @deprecated Deprecated in 9.1 sl@0: @since 6.0 sl@0: */ sl@0: class TAuthorityC16 sl@0: { sl@0: public: // Methods sl@0: sl@0: IMPORT_C const TDesC16& Extract(TAuthorityComponent aComponent) const; sl@0: IMPORT_C TBool IsPresent(TAuthorityComponent aComponent) const; sl@0: IMPORT_C TInt Compare(const TAuthorityC16& aAuthority, TAuthorityComponent aComponent) const; sl@0: IMPORT_C const TDesC16& AuthorityDes() const; sl@0: IMPORT_C HBufC* DisplayFormL(TAuthorityComponent aComponent = EAuthorityComplete ) const; sl@0: sl@0: protected: // Methods sl@0: sl@0: sl@0: IMPORT_C TAuthorityC16(); sl@0: sl@0: void Reset(); sl@0: sl@0: protected: // Attributes sl@0: sl@0: /** sl@0: The array of descriptor pointers to the authority components. sl@0: */ sl@0: TPtrC16 iComponent[EAuthorityMaxComponents]; sl@0: sl@0: /** sl@0: The descriptor pointer to the authority. sl@0: */ sl@0: TPtrC16 iAuthorityDes; sl@0: sl@0: /** sl@0: A friend class. sl@0: @see CAuthority16 sl@0: @since 6.0 sl@0: */ sl@0: friend class CAuthority16; sl@0: sl@0: /** sl@0: A friend class used for testing. sl@0: @see TAuthorityC16StateAccessor sl@0: @since 6.0 sl@0: */ sl@0: friend class TAuthorityC16StateAccessor; sl@0: sl@0: }; sl@0: sl@0: /** sl@0: Dependencies : TAuthorityC16 sl@0: Comments : Provides functionality to parse a descriptor into the components of an sl@0: authority as defined in RFC2396. There are 3 components; userinfo, host and port. sl@0: sl@0: This uses 16-bit descriptors. sl@0: sl@0: Format of an authority is; [userinfo@]host[:port] sl@0: sl@0: @warning The descriptor that is parsed by an object of this class will be referenced sl@0: by that object. If the original descriptor is no longer in scope there will be undefined sl@0: behaviour. sl@0: @publishedAll sl@0: @deprecated Deprecated in 9.1. Use UriUtils::CreateAuthorityL() instead sl@0: @since 6.0 sl@0: */ sl@0: class TAuthorityParser16 : public TAuthorityC16 sl@0: { sl@0: public: // Methods sl@0: sl@0: IMPORT_C TAuthorityParser16(); sl@0: IMPORT_C TInt Parse(const TDesC16& aAuthority); sl@0: sl@0: }; sl@0: sl@0: /** sl@0: Dependencies : CBase, TAuthorityC16. sl@0: Comments : Provides modifying functionality on the components of an authority object, as sl@0: defined in RFC2396. There are 3 components; userinfo, host and port. sl@0: sl@0: The object holds parsed authority information. It is owning. It uses 16-bit descriptors. sl@0: sl@0: The functionality provided by this API allows the authority components to be set or removed sl@0: from this parsed authority. Also, it provides a reference to TAuthorityC16 object so that sl@0: the non-modifying functionality can be used. sl@0: @publishedAll sl@0: @deprecated Deprecated in 9.1 sl@0: @since 6.0 sl@0: */ sl@0: class CAuthority16 : public CBase sl@0: { sl@0: public: // Methods sl@0: sl@0: IMPORT_C static CAuthority16* NewL(const TAuthorityC16& aAuthority); sl@0: IMPORT_C static CAuthority16* NewLC(const TAuthorityC16& aAuthority); sl@0: IMPORT_C static CAuthority16* NewL(); sl@0: IMPORT_C static CAuthority16* NewLC(); sl@0: IMPORT_C ~CAuthority16(); sl@0: sl@0: IMPORT_C const TAuthorityC16& Authority() const; sl@0: IMPORT_C void SetComponentL(const TDesC16& aData, TAuthorityComponent aComponent); sl@0: IMPORT_C void SetAndEscapeComponentL(const TDesC16& aData, TAuthorityComponent aComponent); sl@0: IMPORT_C void RemoveComponentL(TAuthorityComponent aComponent); sl@0: sl@0: private: // Methods sl@0: sl@0: CAuthority16(const TAuthorityC16& aAuthority); sl@0: sl@0: void ConstructL(); sl@0: sl@0: void FormAuthorityL(); sl@0: sl@0: private: // Attributes sl@0: sl@0: /** sl@0: The descriptor buffer that contains the authority. sl@0: */ sl@0: HBufC16* iAuthorityBuf; sl@0: sl@0: /** sl@0: The parsed authority object. sl@0: */ sl@0: TAuthorityC16 iAuthority; sl@0: sl@0: /** sl@0: A friend class used for testing. sl@0: @see TAuthority16StateAccessor sl@0: @since 6.0 sl@0: */ sl@0: friend class TAuthority16StateAccessor; sl@0: sl@0: }; sl@0: /** sl@0: Do not use. Use TAuthorityC8 instead sl@0: @publishedAll sl@0: @deprecated Deprecated in 9.1 sl@0: */ sl@0: typedef TAuthorityC16 TAuthorityC; sl@0: sl@0: /** sl@0: Do not use. Use TAuthorityParser8 instead sl@0: @publishedAll sl@0: @deprecated Deprecated in 9.1 sl@0: */ sl@0: typedef TAuthorityParser16 TAuthorityParser; sl@0: sl@0: /** sl@0: Do not use. Use CAuthority8 instead sl@0: @publishedAll sl@0: @deprecated Deprecated in 9.1 sl@0: */ sl@0: typedef CAuthority16 CAuthority; sl@0: sl@0: #endif // __AUTHORITY16_H__