1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/os/ossrv/genericservices/httputils/inc/Authority16.h Fri Jun 15 03:10:57 2012 +0200
1.3 @@ -0,0 +1,199 @@
1.4 +// Copyright (c) 2001-2009 Nokia Corporation and/or its subsidiary(-ies).
1.5 +// All rights reserved.
1.6 +// This component and the accompanying materials are made available
1.7 +// under the terms of "Eclipse Public License v1.0"
1.8 +// which accompanies this distribution, and is available
1.9 +// at the URL "http://www.eclipse.org/legal/epl-v10.html".
1.10 +//
1.11 +// Initial Contributors:
1.12 +// Nokia Corporation - initial contribution.
1.13 +//
1.14 +// Contributors:
1.15 +//
1.16 +// Description:
1.17 +// This file contains the API definition for the classes TAuthorityC16 and
1.18 +// CAuthority16. These classes provide non-modifying (TAuthorityC16) and
1.19 +// modifying (CAuthority16) functionality for the components of an
1.20 +// Authority as described in RFC2396.
1.21 +//
1.22 +//
1.23 +
1.24 +/**
1.25 + @file Authority16.h
1.26 + @publishedAll
1.27 + @deprecated Deprecated in 9.1
1.28 +*/
1.29 +
1.30 +#ifndef __AUTHORITY16_H__
1.31 +#define __AUTHORITY16_H__
1.32 +
1.33 +// System includes
1.34 +//
1.35 +#include <e32base.h>
1.36 +#include <authoritycommon.h>
1.37 +
1.38 +
1.39 +/**
1.40 +Dependencies : TAuthorityComponent.
1.41 +Comments : Provides non-modifying functionality on the components of an authority
1.42 +object as defined in RFC2396. There are 3 components; userinfo, host and port.
1.43 +
1.44 +The object holds descriptor pointers to the parsed authority components and a descriptor
1.45 +pointer to the authority. It is non-owning. It uses 16-bit descriptors.
1.46 +
1.47 +The functionality provided by this API allows the authority components to be extracted
1.48 +from the parsed authority, checked for their presence in the authority and be compared
1.49 +with those in another TAuthorityC16 object.
1.50 +@publishedAll
1.51 +@deprecated Deprecated in 9.1
1.52 +@since 6.0
1.53 +*/
1.54 +class TAuthorityC16
1.55 + {
1.56 +public: // Methods
1.57 +
1.58 + IMPORT_C const TDesC16& Extract(TAuthorityComponent aComponent) const;
1.59 + IMPORT_C TBool IsPresent(TAuthorityComponent aComponent) const;
1.60 + IMPORT_C TInt Compare(const TAuthorityC16& aAuthority, TAuthorityComponent aComponent) const;
1.61 + IMPORT_C const TDesC16& AuthorityDes() const;
1.62 + IMPORT_C HBufC* DisplayFormL(TAuthorityComponent aComponent = EAuthorityComplete ) const;
1.63 +
1.64 +protected: // Methods
1.65 +
1.66 +
1.67 + IMPORT_C TAuthorityC16();
1.68 +
1.69 + void Reset();
1.70 +
1.71 +protected: // Attributes
1.72 +
1.73 + /**
1.74 + The array of descriptor pointers to the authority components.
1.75 + */
1.76 + TPtrC16 iComponent[EAuthorityMaxComponents];
1.77 +
1.78 + /**
1.79 + The descriptor pointer to the authority.
1.80 + */
1.81 + TPtrC16 iAuthorityDes;
1.82 +
1.83 +/**
1.84 + A friend class.
1.85 + @see CAuthority16
1.86 + @since 6.0
1.87 + */
1.88 + friend class CAuthority16;
1.89 +
1.90 +/**
1.91 + A friend class used for testing.
1.92 + @see TAuthorityC16StateAccessor
1.93 + @since 6.0
1.94 + */
1.95 + friend class TAuthorityC16StateAccessor;
1.96 +
1.97 + };
1.98 +
1.99 +/**
1.100 +Dependencies : TAuthorityC16
1.101 +Comments : Provides functionality to parse a descriptor into the components of an
1.102 +authority as defined in RFC2396. There are 3 components; userinfo, host and port.
1.103 +
1.104 +This uses 16-bit descriptors.
1.105 +
1.106 +Format of an authority is; [userinfo@]host[:port]
1.107 +
1.108 +@warning The descriptor that is parsed by an object of this class will be referenced
1.109 +by that object. If the original descriptor is no longer in scope there will be undefined
1.110 +behaviour.
1.111 +@publishedAll
1.112 +@deprecated Deprecated in 9.1. Use UriUtils::CreateAuthorityL() instead
1.113 +@since 6.0
1.114 +*/
1.115 +class TAuthorityParser16 : public TAuthorityC16
1.116 + {
1.117 +public: // Methods
1.118 +
1.119 + IMPORT_C TAuthorityParser16();
1.120 + IMPORT_C TInt Parse(const TDesC16& aAuthority);
1.121 +
1.122 + };
1.123 +
1.124 +/**
1.125 +Dependencies : CBase, TAuthorityC16.
1.126 +Comments : Provides modifying functionality on the components of an authority object, as
1.127 +defined in RFC2396. There are 3 components; userinfo, host and port.
1.128 +
1.129 +The object holds parsed authority information. It is owning. It uses 16-bit descriptors.
1.130 +
1.131 +The functionality provided by this API allows the authority components to be set or removed
1.132 +from this parsed authority. Also, it provides a reference to TAuthorityC16 object so that
1.133 +the non-modifying functionality can be used.
1.134 +@publishedAll
1.135 +@deprecated Deprecated in 9.1
1.136 +@since 6.0
1.137 +*/
1.138 +class CAuthority16 : public CBase
1.139 + {
1.140 +public: // Methods
1.141 +
1.142 + IMPORT_C static CAuthority16* NewL(const TAuthorityC16& aAuthority);
1.143 + IMPORT_C static CAuthority16* NewLC(const TAuthorityC16& aAuthority);
1.144 + IMPORT_C static CAuthority16* NewL();
1.145 + IMPORT_C static CAuthority16* NewLC();
1.146 + IMPORT_C ~CAuthority16();
1.147 +
1.148 + IMPORT_C const TAuthorityC16& Authority() const;
1.149 + IMPORT_C void SetComponentL(const TDesC16& aData, TAuthorityComponent aComponent);
1.150 + IMPORT_C void SetAndEscapeComponentL(const TDesC16& aData, TAuthorityComponent aComponent);
1.151 + IMPORT_C void RemoveComponentL(TAuthorityComponent aComponent);
1.152 +
1.153 +private: // Methods
1.154 +
1.155 + CAuthority16(const TAuthorityC16& aAuthority);
1.156 +
1.157 + void ConstructL();
1.158 +
1.159 + void FormAuthorityL();
1.160 +
1.161 +private: // Attributes
1.162 +
1.163 + /**
1.164 + The descriptor buffer that contains the authority.
1.165 + */
1.166 + HBufC16* iAuthorityBuf;
1.167 +
1.168 + /**
1.169 + The parsed authority object.
1.170 + */
1.171 + TAuthorityC16 iAuthority;
1.172 +
1.173 +/**
1.174 + A friend class used for testing.
1.175 + @see TAuthority16StateAccessor
1.176 + @since 6.0
1.177 + */
1.178 + friend class TAuthority16StateAccessor;
1.179 +
1.180 + };
1.181 +/**
1.182 +Do not use. Use TAuthorityC8 instead
1.183 +@publishedAll
1.184 +@deprecated Deprecated in 9.1
1.185 + */
1.186 +typedef TAuthorityC16 TAuthorityC;
1.187 +
1.188 +/**
1.189 +Do not use. Use TAuthorityParser8 instead
1.190 +@publishedAll
1.191 +@deprecated Deprecated in 9.1
1.192 + */
1.193 +typedef TAuthorityParser16 TAuthorityParser;
1.194 +
1.195 +/**
1.196 +Do not use. Use CAuthority8 instead
1.197 +@publishedAll
1.198 +@deprecated Deprecated in 9.1
1.199 + */
1.200 +typedef CAuthority16 CAuthority;
1.201 +
1.202 +#endif // __AUTHORITY16_H__