1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/os/ossrv/genericservices/httputils/inc/Authority8.h Fri Jun 15 03:10:57 2012 +0200
1.3 @@ -0,0 +1,176 @@
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 TAuthorityC8 and
1.18 +// CAuthority8. These classes provide non-modifying (TAuthorityC8) and
1.19 +// modifying (CAuthority8) functionality for the components of an
1.20 +// Authority as described in RFC2396.
1.21 +//
1.22 +//
1.23 +
1.24 +/**
1.25 + @file Authority8.h
1.26 + @publishedAll
1.27 + @released
1.28 +*/
1.29 +
1.30 +#ifndef __AUTHORITY8_H__
1.31 +#define __AUTHORITY8_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 8-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 TAuthorityC8 object.
1.50 +@publishedAll
1.51 +@released
1.52 +@since 6.0
1.53 +*/
1.54 +class TAuthorityC8
1.55 + {
1.56 +public: // Methods
1.57 +
1.58 + IMPORT_C const TDesC8& Extract(TAuthorityComponent aComponent) const;
1.59 + IMPORT_C TBool IsPresent(TAuthorityComponent aComponent) const;
1.60 + IMPORT_C TInt Compare(const TAuthorityC8& aAuthority, TAuthorityComponent aComponent) const;
1.61 + IMPORT_C const TDesC8& AuthorityDes() const;
1.62 + IMPORT_C HBufC* DisplayFormL(TAuthorityComponent aComponent = EAuthorityComplete ) const;
1.63 +
1.64 +protected: // Methods
1.65 +
1.66 + IMPORT_C TAuthorityC8();
1.67 + void Reset();
1.68 +
1.69 +protected: // Attributes
1.70 +
1.71 + /**
1.72 + The array of descriptor pointers to the authority components.
1.73 + */
1.74 + TPtrC8 iComponent[EAuthorityMaxComponents];
1.75 +
1.76 + /**
1.77 + The descriptor pointer to the authority.
1.78 + */
1.79 + TPtrC8 iAuthorityDes;
1.80 +
1.81 +/**
1.82 + A friend class.
1.83 + @see CAuthority8
1.84 + @since 6.0
1.85 + */
1.86 + friend class CAuthority8;
1.87 +
1.88 +/**
1.89 + A friend class used for testing.
1.90 + @see TAuthorityC8StateAccessor
1.91 + @since 6.0
1.92 + */
1.93 + friend class TAuthorityC8StateAccessor;
1.94 +
1.95 + };
1.96 +
1.97 +/**
1.98 +Dependencies : TAuthorityC8
1.99 +Comments : Provides functionality to parse a descriptor into the components of an
1.100 +authority as defined in RFC2396. There are 3 components; userinfo, host and port.
1.101 +
1.102 +This uses 8-bit descriptors.
1.103 +
1.104 +
1.105 +Format of an authority is; [userinfo@]host[:port]
1.106 +
1.107 +@warning The descriptor that is parsed by an object of this class will be referenced
1.108 +by that object. If the original descriptor is no longer in scope there will be undefined
1.109 +behaviour.
1.110 +@publishedAll
1.111 +@released
1.112 +@since 6.0
1.113 +*/
1.114 +class TAuthorityParser8 : public TAuthorityC8
1.115 + {
1.116 +public: // Methods
1.117 +
1.118 + IMPORT_C TAuthorityParser8();
1.119 + IMPORT_C TInt Parse(const TDesC8& aAuthority);
1.120 +
1.121 + };
1.122 +
1.123 +/**
1.124 +Dependencies : CBase, TAuthorityC8.
1.125 +Comments : Provides modifying functionality on the components of an authority object, as
1.126 +defined in RFC2396. There are 3 components; userinfo, host and port.
1.127 +
1.128 +The object holds parsed authority information. It is owning. It uses 8-bit descriptors.
1.129 +
1.130 +The functionality provided by this API allows the authority components to be set or removed
1.131 +from this parsed authority. Also, it provides a reference to TAuthorityC8 object so that
1.132 +the non-modifying functionality can be used.
1.133 +@publishedAll
1.134 +@released
1.135 +@since 6.0
1.136 +*/
1.137 +class CAuthority8 : public CBase
1.138 + {
1.139 +public: // Methods
1.140 +
1.141 + IMPORT_C static CAuthority8* NewL(const TAuthorityC8& aAuthority);
1.142 + IMPORT_C static CAuthority8* NewLC(const TAuthorityC8& aAuthority);
1.143 + IMPORT_C static CAuthority8* NewL();
1.144 + IMPORT_C static CAuthority8* NewLC();
1.145 + IMPORT_C ~CAuthority8();
1.146 +
1.147 + IMPORT_C const TAuthorityC8& Authority() const;
1.148 + IMPORT_C void SetComponentL(const TDesC8& aData, TAuthorityComponent aComponent);
1.149 + IMPORT_C void SetAndEscapeComponentL(const TDesC8& aData, TAuthorityComponent aComponent);
1.150 + IMPORT_C void RemoveComponentL(TAuthorityComponent aComponent);
1.151 +
1.152 +private: // Methods
1.153 +
1.154 + CAuthority8(const TAuthorityC8& aAuthority);
1.155 + void ConstructL();
1.156 + void FormAuthorityL();
1.157 +
1.158 +private: // Attributes
1.159 +
1.160 + /**
1.161 + The descriptor buffer that contains the authority.
1.162 + */
1.163 + HBufC8* iAuthorityBuf;
1.164 +
1.165 + /**
1.166 + The parsed authority object.
1.167 + */
1.168 + TAuthorityC8 iAuthority;
1.169 +
1.170 +/**
1.171 + A friend class used for testing.
1.172 + @see TAuthority8StateAccessor
1.173 + @since 6.0
1.174 + */
1.175 + friend class TAuthority8StateAccessor;
1.176 +
1.177 + };
1.178 +
1.179 +#endif // __AUTHORITY8_H__