|
sl@0
|
1 |
// Copyright (c) 2001-2009 Nokia Corporation and/or its subsidiary(-ies).
|
|
sl@0
|
2 |
// All rights reserved.
|
|
sl@0
|
3 |
// This component and the accompanying materials are made available
|
|
sl@0
|
4 |
// under the terms of "Eclipse Public License v1.0"
|
|
sl@0
|
5 |
// which accompanies this distribution, and is available
|
|
sl@0
|
6 |
// at the URL "http://www.eclipse.org/legal/epl-v10.html".
|
|
sl@0
|
7 |
//
|
|
sl@0
|
8 |
// Initial Contributors:
|
|
sl@0
|
9 |
// Nokia Corporation - initial contribution.
|
|
sl@0
|
10 |
//
|
|
sl@0
|
11 |
// Contributors:
|
|
sl@0
|
12 |
//
|
|
sl@0
|
13 |
// Description:
|
|
sl@0
|
14 |
// This file contains the API definition for the classes TAuthorityC8 and
|
|
sl@0
|
15 |
// CAuthority8. These classes provide non-modifying (TAuthorityC8) and
|
|
sl@0
|
16 |
// modifying (CAuthority8) functionality for the components of an
|
|
sl@0
|
17 |
// Authority as described in RFC2396.
|
|
sl@0
|
18 |
//
|
|
sl@0
|
19 |
//
|
|
sl@0
|
20 |
|
|
sl@0
|
21 |
/**
|
|
sl@0
|
22 |
@file Authority8.h
|
|
sl@0
|
23 |
@publishedAll
|
|
sl@0
|
24 |
@released
|
|
sl@0
|
25 |
*/
|
|
sl@0
|
26 |
|
|
sl@0
|
27 |
#ifndef __AUTHORITY8_H__
|
|
sl@0
|
28 |
#define __AUTHORITY8_H__
|
|
sl@0
|
29 |
|
|
sl@0
|
30 |
// System includes
|
|
sl@0
|
31 |
//
|
|
sl@0
|
32 |
#include <e32base.h>
|
|
sl@0
|
33 |
#include <authoritycommon.h>
|
|
sl@0
|
34 |
|
|
sl@0
|
35 |
|
|
sl@0
|
36 |
/**
|
|
sl@0
|
37 |
Dependencies : TAuthorityComponent.
|
|
sl@0
|
38 |
Comments : Provides non-modifying functionality on the components of an authority
|
|
sl@0
|
39 |
object as defined in RFC2396. There are 3 components; userinfo, host and port.
|
|
sl@0
|
40 |
|
|
sl@0
|
41 |
The object holds descriptor pointers to the parsed authority components and a descriptor
|
|
sl@0
|
42 |
pointer to the authority. It is non-owning. It uses 8-bit descriptors.
|
|
sl@0
|
43 |
|
|
sl@0
|
44 |
The functionality provided by this API allows the authority components to be extracted
|
|
sl@0
|
45 |
from the parsed authority, checked for their presence in the authority and be compared
|
|
sl@0
|
46 |
with those in another TAuthorityC8 object.
|
|
sl@0
|
47 |
@publishedAll
|
|
sl@0
|
48 |
@released
|
|
sl@0
|
49 |
@since 6.0
|
|
sl@0
|
50 |
*/
|
|
sl@0
|
51 |
class TAuthorityC8
|
|
sl@0
|
52 |
{
|
|
sl@0
|
53 |
public: // Methods
|
|
sl@0
|
54 |
|
|
sl@0
|
55 |
IMPORT_C const TDesC8& Extract(TAuthorityComponent aComponent) const;
|
|
sl@0
|
56 |
IMPORT_C TBool IsPresent(TAuthorityComponent aComponent) const;
|
|
sl@0
|
57 |
IMPORT_C TInt Compare(const TAuthorityC8& aAuthority, TAuthorityComponent aComponent) const;
|
|
sl@0
|
58 |
IMPORT_C const TDesC8& AuthorityDes() const;
|
|
sl@0
|
59 |
IMPORT_C HBufC* DisplayFormL(TAuthorityComponent aComponent = EAuthorityComplete ) const;
|
|
sl@0
|
60 |
|
|
sl@0
|
61 |
protected: // Methods
|
|
sl@0
|
62 |
|
|
sl@0
|
63 |
IMPORT_C TAuthorityC8();
|
|
sl@0
|
64 |
void Reset();
|
|
sl@0
|
65 |
|
|
sl@0
|
66 |
protected: // Attributes
|
|
sl@0
|
67 |
|
|
sl@0
|
68 |
/**
|
|
sl@0
|
69 |
The array of descriptor pointers to the authority components.
|
|
sl@0
|
70 |
*/
|
|
sl@0
|
71 |
TPtrC8 iComponent[EAuthorityMaxComponents];
|
|
sl@0
|
72 |
|
|
sl@0
|
73 |
/**
|
|
sl@0
|
74 |
The descriptor pointer to the authority.
|
|
sl@0
|
75 |
*/
|
|
sl@0
|
76 |
TPtrC8 iAuthorityDes;
|
|
sl@0
|
77 |
|
|
sl@0
|
78 |
/**
|
|
sl@0
|
79 |
A friend class.
|
|
sl@0
|
80 |
@see CAuthority8
|
|
sl@0
|
81 |
@since 6.0
|
|
sl@0
|
82 |
*/
|
|
sl@0
|
83 |
friend class CAuthority8;
|
|
sl@0
|
84 |
|
|
sl@0
|
85 |
/**
|
|
sl@0
|
86 |
A friend class used for testing.
|
|
sl@0
|
87 |
@see TAuthorityC8StateAccessor
|
|
sl@0
|
88 |
@since 6.0
|
|
sl@0
|
89 |
*/
|
|
sl@0
|
90 |
friend class TAuthorityC8StateAccessor;
|
|
sl@0
|
91 |
|
|
sl@0
|
92 |
};
|
|
sl@0
|
93 |
|
|
sl@0
|
94 |
/**
|
|
sl@0
|
95 |
Dependencies : TAuthorityC8
|
|
sl@0
|
96 |
Comments : Provides functionality to parse a descriptor into the components of an
|
|
sl@0
|
97 |
authority as defined in RFC2396. There are 3 components; userinfo, host and port.
|
|
sl@0
|
98 |
|
|
sl@0
|
99 |
This uses 8-bit descriptors.
|
|
sl@0
|
100 |
|
|
sl@0
|
101 |
|
|
sl@0
|
102 |
Format of an authority is; [userinfo@]host[:port]
|
|
sl@0
|
103 |
|
|
sl@0
|
104 |
@warning The descriptor that is parsed by an object of this class will be referenced
|
|
sl@0
|
105 |
by that object. If the original descriptor is no longer in scope there will be undefined
|
|
sl@0
|
106 |
behaviour.
|
|
sl@0
|
107 |
@publishedAll
|
|
sl@0
|
108 |
@released
|
|
sl@0
|
109 |
@since 6.0
|
|
sl@0
|
110 |
*/
|
|
sl@0
|
111 |
class TAuthorityParser8 : public TAuthorityC8
|
|
sl@0
|
112 |
{
|
|
sl@0
|
113 |
public: // Methods
|
|
sl@0
|
114 |
|
|
sl@0
|
115 |
IMPORT_C TAuthorityParser8();
|
|
sl@0
|
116 |
IMPORT_C TInt Parse(const TDesC8& aAuthority);
|
|
sl@0
|
117 |
|
|
sl@0
|
118 |
};
|
|
sl@0
|
119 |
|
|
sl@0
|
120 |
/**
|
|
sl@0
|
121 |
Dependencies : CBase, TAuthorityC8.
|
|
sl@0
|
122 |
Comments : Provides modifying functionality on the components of an authority object, as
|
|
sl@0
|
123 |
defined in RFC2396. There are 3 components; userinfo, host and port.
|
|
sl@0
|
124 |
|
|
sl@0
|
125 |
The object holds parsed authority information. It is owning. It uses 8-bit descriptors.
|
|
sl@0
|
126 |
|
|
sl@0
|
127 |
The functionality provided by this API allows the authority components to be set or removed
|
|
sl@0
|
128 |
from this parsed authority. Also, it provides a reference to TAuthorityC8 object so that
|
|
sl@0
|
129 |
the non-modifying functionality can be used.
|
|
sl@0
|
130 |
@publishedAll
|
|
sl@0
|
131 |
@released
|
|
sl@0
|
132 |
@since 6.0
|
|
sl@0
|
133 |
*/
|
|
sl@0
|
134 |
class CAuthority8 : public CBase
|
|
sl@0
|
135 |
{
|
|
sl@0
|
136 |
public: // Methods
|
|
sl@0
|
137 |
|
|
sl@0
|
138 |
IMPORT_C static CAuthority8* NewL(const TAuthorityC8& aAuthority);
|
|
sl@0
|
139 |
IMPORT_C static CAuthority8* NewLC(const TAuthorityC8& aAuthority);
|
|
sl@0
|
140 |
IMPORT_C static CAuthority8* NewL();
|
|
sl@0
|
141 |
IMPORT_C static CAuthority8* NewLC();
|
|
sl@0
|
142 |
IMPORT_C ~CAuthority8();
|
|
sl@0
|
143 |
|
|
sl@0
|
144 |
IMPORT_C const TAuthorityC8& Authority() const;
|
|
sl@0
|
145 |
IMPORT_C void SetComponentL(const TDesC8& aData, TAuthorityComponent aComponent);
|
|
sl@0
|
146 |
IMPORT_C void SetAndEscapeComponentL(const TDesC8& aData, TAuthorityComponent aComponent);
|
|
sl@0
|
147 |
IMPORT_C void RemoveComponentL(TAuthorityComponent aComponent);
|
|
sl@0
|
148 |
|
|
sl@0
|
149 |
private: // Methods
|
|
sl@0
|
150 |
|
|
sl@0
|
151 |
CAuthority8(const TAuthorityC8& aAuthority);
|
|
sl@0
|
152 |
void ConstructL();
|
|
sl@0
|
153 |
void FormAuthorityL();
|
|
sl@0
|
154 |
|
|
sl@0
|
155 |
private: // Attributes
|
|
sl@0
|
156 |
|
|
sl@0
|
157 |
/**
|
|
sl@0
|
158 |
The descriptor buffer that contains the authority.
|
|
sl@0
|
159 |
*/
|
|
sl@0
|
160 |
HBufC8* iAuthorityBuf;
|
|
sl@0
|
161 |
|
|
sl@0
|
162 |
/**
|
|
sl@0
|
163 |
The parsed authority object.
|
|
sl@0
|
164 |
*/
|
|
sl@0
|
165 |
TAuthorityC8 iAuthority;
|
|
sl@0
|
166 |
|
|
sl@0
|
167 |
/**
|
|
sl@0
|
168 |
A friend class used for testing.
|
|
sl@0
|
169 |
@see TAuthority8StateAccessor
|
|
sl@0
|
170 |
@since 6.0
|
|
sl@0
|
171 |
*/
|
|
sl@0
|
172 |
friend class TAuthority8StateAccessor;
|
|
sl@0
|
173 |
|
|
sl@0
|
174 |
};
|
|
sl@0
|
175 |
|
|
sl@0
|
176 |
#endif // __AUTHORITY8_H__
|