当前文件路径：DNN/Website/Bin/DotNetNuke.HttpModules.xml

		            
  1<?xml version="1.0"?>
  2<doc>
  3<assembly>
  4<name>
  5DotNetNuke.HttpModules
  6</name>
  7</assembly>
  8<members>
  9<member name="F:DotNetNuke.HttpModules.Compression.DeflateFilter.m_stream">
 10    <summary>
 11 compression stream member
 12 has to be a member as we can only have one instance of the
 13 actual filter class
 14 </summary>
 15</member><member name="M:DotNetNuke.HttpModules.Compression.DeflateFilter.#ctor(System.IO.Stream)">
 16    <summary>
 17 Basic constructor that uses the Normal compression level
 18 </summary>
 19    <param name="baseStream">The stream to wrap up with the deflate algorithm</param>
 20</member><member name="M:DotNetNuke.HttpModules.Compression.DeflateFilter.Write(System.Byte[],System.Int32,System.Int32)">
 21    <summary>
 22 Write out bytes to the underlying stream after compressing them Imports deflate
 23 </summary>
 24    <param name="buffer">The array of bytes to write</param>
 25    <param name="offset">The offset into the supplied buffer to start</param>
 26    <param name="count">The number of bytes to write</param>
 27</member><member name="P:DotNetNuke.HttpModules.Compression.DeflateFilter.ContentEncoding">
 28    <summary>
 29 Return the Http name for this encoding.  Here, deflate.
 30 </summary>
 31</member><member name="M:DotNetNuke.HttpModules.Compression.DeflateFilter.Close">
 32    <summary>
 33 Closes this Filter and calls the base class implementation.
 34 </summary>
 35</member><member name="M:DotNetNuke.HttpModules.Compression.DeflateFilter.Flush">
 36    <summary>
 37 Flushes that the filter out to underlying storage
 38 </summary>
 39</member><member name="T:DotNetNuke.HttpModules.Compression.DeflateFilter">
 40    <summary>
 41 Summary description for DeflateFilter.
 42 </summary>
 43</member><member name="P:DotNetNuke.HttpModules.Compression.Settings.Default">
 44    <summary>
 45 The default settings.  Deflate + normal.
 46 </summary>
 47</member><member name="P:DotNetNuke.HttpModules.Compression.Settings.PreferredAlgorithm">
 48    <summary>
 49 The preferred algorithm to use for compression
 50 </summary>
 51</member><member name="P:DotNetNuke.HttpModules.Compression.Settings.Reg">
 52    <summary>
 53 The regular expression used for Whitespace removal
 54 </summary>
 55</member><member name="P:DotNetNuke.HttpModules.Compression.Settings.Whitespace">
 56    <summary>
 57 Determines if Whitespace filtering is enabled
 58 </summary>
 59</member><member name="M:DotNetNuke.HttpModules.Compression.Settings.GetSettings">
 60    <summary>
 61 Get the current settings from the xml config file
 62 </summary>
 63</member><member name="M:DotNetNuke.HttpModules.Compression.Settings.IsExcludedPath(System.String)">
 64    <summary>
 65 Looks for a given path in the list of paths excluded from compression
 66 </summary>
 67    <param name="relUrl">the relative url to check</param>
 68    <returns>true if excluded, false if not</returns>
 69</member><member name="T:DotNetNuke.HttpModules.Compression.Settings">
 70    <summary>
 71 This class encapsulates the settings for an HttpCompressionModule
 72 </summary>
 73</member><member name="M:DotNetNuke.HttpModules.RequestFilter.RequestFilterSettings.GetSettings">
 74    <summary>
 75 Get the current settings from the xml config file
 76 </summary>
 77</member><member name="T:DotNetNuke.HttpModules.Compression.Algorithms">
 78    <summary>
 79 The available compression algorithms to use with the HttpCompressionModule
 80 </summary>
 81</member><member name="M:DotNetNuke.HttpModules.Compression.HttpOutputFilter.#ctor(System.IO.Stream)">
 82    <summary>
 83 Subclasses need to call this on contruction to setup the underlying stream
 84 </summary>
 85    <param name="baseStream">The stream we're wrapping up in a filter</param>
 86</member><member name="P:DotNetNuke.HttpModules.Compression.HttpOutputFilter.BaseStream">
 87    <summary>
 88 Allow subclasses access to the underlying stream
 89 </summary>
 90</member><member name="P:DotNetNuke.HttpModules.Compression.HttpOutputFilter.CanRead">
 91    <summary>
 92 False.  These are write-only streams
 93 </summary>
 94</member><member name="P:DotNetNuke.HttpModules.Compression.HttpOutputFilter.CanSeek">
 95    <summary>
 96 False.  These are write-only streams
 97 </summary>
 98</member><member name="P:DotNetNuke.HttpModules.Compression.HttpOutputFilter.CanWrite">
 99    <summary>
100 True.  You can write to the stream.  May change if you call Close or Dispose
101 </summary>
102</member><member name="P:DotNetNuke.HttpModules.Compression.HttpOutputFilter.Length">
103    <summary>
104 Not supported.  Throws an exception saying so.
105 </summary>
106    <exception cref="T:System.NotSupportedException">Thrown.  Always.</exception>
107</member><member name="P:DotNetNuke.HttpModules.Compression.HttpOutputFilter.Position">
108    <summary>
109 Not supported.  Throws an exception saying so.
110 </summary>
111    <exception cref="T:System.NotSupportedException">Thrown.  Always.</exception>
112</member><member name="M:DotNetNuke.HttpModules.Compression.HttpOutputFilter.Seek(System.Int64,System.IO.SeekOrigin)">
113    <summary>
114 Not supported.  Throws an exception saying so.
115 </summary>
116    <exception cref="T:System.NotSupportedException">Thrown.  Always.</exception>
117</member><member name="M:DotNetNuke.HttpModules.Compression.HttpOutputFilter.SetLength(System.Int64)">
118    <summary>
119 Not supported.  Throws an exception saying so.
120 </summary>
121    <exception cref="T:System.NotSupportedException">Thrown.  Always.</exception>
122</member><member name="M:DotNetNuke.HttpModules.Compression.HttpOutputFilter.Close">
123    <summary>
124 Closes this Filter and the underlying stream.
125 </summary>
126    <remarks>
127 If you override, call up to this method in your implementation.
128 </remarks>
129</member><member name="M:DotNetNuke.HttpModules.Compression.HttpOutputFilter.Flush">
130    <summary>
131 Fluses this Filter and the underlying stream.
132 </summary>
133    <remarks>
134 If you override, call up to this method in your implementation.
135 </remarks>
136</member><member name="M:DotNetNuke.HttpModules.Compression.HttpOutputFilter.Read(System.Byte[],System.Int32,System.Int32)">
137    <summary>
138 Not supported.
139 </summary>
140    <param name="buffer">The buffer to write into.</param>
141    <param name="offset">The offset on the buffer to write into</param>
142    <param name="count">The number of bytes to write.  Must be less than buffer.Length</param>
143    <returns>An int telling you how many bytes were written</returns>
144</member><member name="T:DotNetNuke.HttpModules.Compression.HttpOutputFilter">
145    <summary>
146 The base of anything you want to latch onto the Filter property of a <see cref="T:System.Web.HttpResponse"/>
147 object.
148 </summary>
149    <remarks>
150 These are generally used with HttpModule but you could really use them in
151 other HttpModules.  This is a general, write-only stream that writes to some underlying stream.  When implementing
152 a real class, you have to override void Write(byte[], int offset, int count).  Your work will be performed there.
153 </remarks>
154</member><member name="M:DotNetNuke.HttpModules.Compression.CompressingFilter.#ctor(System.IO.Stream)">
155    <summary>
156 Protected constructor that sets up the underlying stream we're compressing into
157 </summary>
158    <param name="baseStream">The stream we're wrapping up</param>
159</member><member name="P:DotNetNuke.HttpModules.Compression.CompressingFilter.ContentEncoding">
160    <summary>
161 The name of the content-encoding that's being implemented
162 </summary>
163    <remarks>
164 See http://www.w3.org/Protocols/rfc2616/rfc2616-sec3.html#sec3.5 for more
165 details on content codings.
166 </remarks>
167</member><member name="P:DotNetNuke.HttpModules.Compression.CompressingFilter.HasWrittenHeaders">
168    <summary>
169 Keeps track of whether or not we're written the compression headers
170 </summary>
171</member><member name="M:DotNetNuke.HttpModules.Compression.CompressingFilter.WriteHeaders">
172    <summary>
173 Writes out the compression-related headers.  Subclasses should call this once before writing to the output stream.
174 </summary>
175</member><member name="T:DotNetNuke.HttpModules.Compression.CompressingFilter">
176    <summary>
177 Base for any HttpFilter that performing compression
178 </summary>
179    <remarks>
180 When implementing this class, you need to implement a <see cref="T:DotNetNuke.HttpModules.Compression.HttpOutputFilter"/>
181 along with a <see cref="P:DotNetNuke.HttpModules.Compression.CompressingFilter.ContentEncoding"/>.  The latter corresponds to a 
182 content coding (see http://www.w3.org/Protocols/rfc2616/rfc2616-sec3.html#sec3.5)
183 that your implementation will support.
184 </remarks>
185</member><member name="M:DotNetNuke.Services.Url.FriendlyUrl.DNNFriendlyUrlProvider.AddPage(System.String,System.String)">
186 -----------------------------------------------------------------------------
187 <summary>
188 AddPage adds the page to the friendly url
189 </summary>
190    <remarks>
191    </remarks>
192    <param name="path">The path to format.</param>
193    <param name="pageName">The page name.</param>
194    <returns>The formatted url</returns>
195    <history>
196        [cnurse]    12/16/2004    created
197 </history>
198 -----------------------------------------------------------------------------
199
200</member><member name="M:DotNetNuke.Services.Url.FriendlyUrl.DNNFriendlyUrlProvider.GetFriendlyAlias(System.String,System.String)">
201 -----------------------------------------------------------------------------
202 <summary>
203 GetFriendlyAlias gets the Alias root of the friendly url
204 </summary>
205    <remarks>
206    </remarks>
207    <param name="path">The path to format.</param>
208    <param name="portalAlias">The portal alias of the site.</param>
209    <returns>The formatted url</returns>
210    <history>
211        [cnurse]    12/16/2004    created
212 </history>
213 -----------------------------------------------------------------------------
214
215</member><member name="M:DotNetNuke.Services.Url.FriendlyUrl.DNNFriendlyUrlProvider.GetFriendlyQueryString(DotNetNuke.Entities.Tabs.TabInfo,System.String,System.String)">
216 -----------------------------------------------------------------------------
217 <summary>
218 GetFriendlyQueryString gets the Querystring part of the friendly url
219 </summary>
220    <remarks>
221    </remarks>
222    <param name="tab">The tab whose url is being formatted.</param>
223    <param name="path">The path to format.</param>
224    <returns>The formatted url</returns>
225    <history>
226        [cnurse]    12/16/2004    created
227        [smcculloch]10/10/2005    Regex update for rewritten characters
228 </history>
229 -----------------------------------------------------------------------------
230
231</member><member name="M:DotNetNuke.HttpModules.Compression.CompressionModule.Init(System.Web.HttpApplication)">
232    <summary>
233 Init the handler and fulfill <see cref="T:System.Web.IHttpModule"/>
234    </summary>
235    <remarks>
236 This implementation hooks the ReleaseRequestState and PreSendRequestHeaders events to 
237 figure out as late as possible if we should install the filter.  Previous versions did
238 not do this as well.
239 </remarks>
240    <param name="context">The <see cref="T:System.Web.HttpApplication"/> this handler is working for.</param>
241</member><member name="M:DotNetNuke.HttpModules.Compression.CompressionModule.Dispose">
242    <summary>
243 Implementation of <see cref="T:System.Web.IHttpModule"/>
244    </summary>
245    <remarks>
246 Currently empty.  Nothing to really do, as I have no member variables.
247 </remarks>
248</member><member name="M:DotNetNuke.HttpModules.Compression.CompressionModule.CompressContent(System.Object,System.EventArgs)">
249    <summary>
250 EventHandler that gets ahold of the current request context and attempts to compress the output.
251 </summary>
252    <param name="sender">The <see cref="T:System.Web.HttpApplication"/> that is firing this event.</param>
253    <param name="e">Arguments to the event</param>
254</member><member name="M:DotNetNuke.HttpModules.Compression.CompressionModule.GetFilterForScheme(System.String[],System.IO.Stream,DotNetNuke.HttpModules.Compression.Settings)">
255    <summary>
256 Get ahold of a <see cref="T:DotNetNuke.HttpModules.Compression.CompressingFilter"/> for the given encoding scheme.
257 If no encoding scheme can be found, it returns null.
258 </summary>
259    <remarks>
260 See http:'www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.3 for details
261 on how clients are supposed to construct the Accept-Encoding header.  This
262 implementation follows those rules, though we allow the server to override
263 the preference given to different supported algorithms.  I'm doing this as 
264 I would rather give the server control over the algorithm decision than 
265 the client.  If the clients send up * as an accepted encoding with highest
266 quality, we use the preferred algorithm as specified in the config file.
267 </remarks>
268</member><member name="T:DotNetNuke.HttpModules.Compression.CompressionModule">
269    <summary>
270 An HttpModule that hooks onto the Response.Filter property of the
271 current request and tries to compress the output, based on what
272 the browser supports
273 </summary>
274    <remarks>
275        <p>This HttpModule uses classes that inherit from <see cref="T:DotNetNuke.HttpModules.Compression.CompressingFilter"/>.
276 We already support gzip and deflate (aka zlib), if you'd like to add 
277 support for compress (which uses LZW, which is licensed), add in another
278 class that inherits from HttpFilter to do the work.</p>
279        <p>This module checks the Accept-Encoding HTTP header to determine if the
280 client actually supports any notion of compression.  Currently, we support
281 the deflate (zlib) and gzip compression schemes.  I chose to not implement
282 compress because it uses lzw which requires a license from 
283 Unisys.  For more information about the common compression types supported,
284 see http:'www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.11 for details.</p>
285    </remarks>
286    <seealso cref="T:DotNetNuke.HttpModules.Compression.CompressingFilter"/>
287    <seealso cref="T:System.IO.Stream"/>
288</member><member name="M:DotNetNuke.HttpModules.RequestFilter.RequestFilterModule.Dispose">
289    <summary>
290 Implementation of <see cref="T:System.Web.IHttpModule"/>
291    </summary>
292    <remarks>
293 Currently empty.  Nothing to really do, as I have no member variables.
294 </remarks>
295</member><member name="M:DotNetNuke.HttpModules.Compression.WhitespaceFilter.#ctor(System.IO.Stream,System.Text.RegularExpressions.Regex)">
296    <summary>
297 Primary constructor.
298 </summary>
299    <param name="baseStream">The stream to wrap in gzip.  Must have CanWrite.</param>
300    <param name="reg"></param>
301</member><member name="M:DotNetNuke.HttpModules.Compression.WhitespaceFilter.Write(System.Byte[],System.Int32,System.Int32)">
302    <summary>
303 Write out bytes to the underlying stream after removing the white space
304 </summary>
305    <param name="buf">The array of bytes to write</param>
306    <param name="offset">The offset into the supplied buffer to start</param>
307    <param name="count">The number of bytes to write</param>
308</member><member name="M:DotNetNuke.HttpModules.RequestFilter.RequestFilterRule.#ctor(System.String,System.String,DotNetNuke.HttpModules.RequestFilter.RequestFilterOperatorType,DotNetNuke.HttpModules.RequestFilter.RequestFilterRuleType,System.String)">
309    <summary>
310 Initializes a new instance of the RequestFilterRule class.
311 </summary>
312    <param name="serverVariable"></param>
313    <param name="values"></param>
314    <param name="action"></param>
315    <param name="location"></param>
316</member><member name="M:DotNetNuke.HttpModules.RequestFilter.RequestFilterRule.#ctor">
317    <summary>
318 Initializes a new instance of the RequestFilterRule class.
319 </summary>
320</member><member name="F:DotNetNuke.HttpModules.Compression.GZipFilter.m_stream">
321    <summary>
322 compression stream member
323 has to be a member as we can only have one instance of the
324 actual filter class
325 </summary>
326</member><member name="M:DotNetNuke.HttpModules.Compression.GZipFilter.#ctor(System.IO.Stream)">
327    <summary>
328 Primary constructor.  Need to pass in a stream to wrap up with gzip.
329 </summary>
330    <param name="baseStream">The stream to wrap in gzip.  Must have CanWrite.</param>
331</member><member name="M:DotNetNuke.HttpModules.Compression.GZipFilter.Write(System.Byte[],System.Int32,System.Int32)">
332    <summary>
333 Write out bytes to the underlying stream after compressing them Imports deflate
334 </summary>
335    <param name="buffer">The array of bytes to write</param>
336    <param name="offset">The offset into the supplied buffer to start</param>
337    <param name="count">The number of bytes to write</param>
338</member><member name="P:DotNetNuke.HttpModules.Compression.GZipFilter.ContentEncoding">
339    <summary>
340 Return the Http name for this encoding.  Here, deflate.
341 </summary>
342</member><member name="M:DotNetNuke.HttpModules.Compression.GZipFilter.Close">
343    <summary>
344 Closes this Filter and calls the base class implementation.
345 </summary>
346</member><member name="M:DotNetNuke.HttpModules.Compression.GZipFilter.Flush">
347    <summary>
</