/usr/include/GNUstep/Foundation/NSHTTPCookie.h is in libgnustep-base-dev 1.25.1-2ubuntu3.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 | /* Interface for NSHTTPCookie for GNUstep
Copyright (C) 2006 Software Foundation, Inc.
Written by: Richard Frith-Macdonald <frm@gnu.org>
Date: 2006
This file is part of the GNUstep Base Library.
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public
License as published by the Free Software Foundation; either
version 2 of the License, or (at your option) any later version.
This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Library General Public License for more details.
You should have received a copy of the GNU Lesser General Public
License along with this library; if not, write to the Free
Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
Boston, MA 02111 USA.
*/
#ifndef __NSHTTPCookie_h_GNUSTEP_BASE_INCLUDE
#define __NSHTTPCookie_h_GNUSTEP_BASE_INCLUDE
#import <GNUstepBase/GSVersionMacros.h>
#if OS_API_VERSION(MAC_OS_X_VERSION_10_2,GS_API_LATEST) && GS_API_VERSION( 11300,GS_API_LATEST)
#import <Foundation/NSObject.h>
#if defined(__cplusplus)
extern "C" {
#endif
@class NSArray;
@class NSDate;
@class NSDictionary;
@class NSString;
@class NSURL;
extern NSString * const NSHTTPCookieComment; /** Obtain text of the comment */
extern NSString * const NSHTTPCookieCommentURL; /** Obtain the comment URL */
extern NSString * const NSHTTPCookieDiscard; /** Obtain the sessions discard setting */
extern NSString * const NSHTTPCookieDomain; /** Obtain cookie domain */
extern NSString * const NSHTTPCookieExpires; /** Obtain cookie expiry date */
extern NSString * const NSHTTPCookieMaximumAge; /** Obtain maximum age (expiry) */
extern NSString * const NSHTTPCookieName; /** Obtain name of cookie */
extern NSString * const NSHTTPCookieOriginURL; /** Obtain cookie origin URL */
extern NSString * const NSHTTPCookiePath; /** Obtain cookie path */
extern NSString * const NSHTTPCookiePort; /** Obtain cookie ports */
extern NSString * const NSHTTPCookieSecure; /** Obtain cookie security */
extern NSString * const NSHTTPCookieValue; /** Obtain value of cookie */
extern NSString * const NSHTTPCookieVersion; /** Obtain cookie version */
/**
* An instance of the NSHTTPCookie class is a single, immutable http cookie.
* It can be initialised with properties from a dictionary and has accessor
* methods to obtain the cookie values.<br />
* The class supports unversioned cookies (sometimes referred to as version 0)
* as originally produced by netscape, as well as more recent standardised
* and versioned cookies.
*/
@interface NSHTTPCookie : NSObject
{
#if GS_EXPOSE(NSHTTPCookie)
@private
void *_NSHTTPCookieInternal;
#endif
}
/**
* Allocates and returns an autoreleasd instance using -initWithProperties:
* to initialise it from properties.
*/
+ (id) cookieWithProperties: (NSDictionary *)properties;
/**
* Returns an array of cookies parsed from the headerFields and URL
* (assuming that the headerFields came from a response to a request
* sent to the URL).<br />
* The headerFields dictionary must contain at least all the headers
* relevant to cookie setting ... other headers are ignored.
*/
+ (NSArray *) cookiesWithResponseHeaderFields: (NSDictionary *)headerFields
forURL: (NSURL *)URL;
/**
* Returns a dictionary of header fields that can be used to add the
* specified cookies to a request.
*/
+ (NSDictionary *) requestHeaderFieldsWithCookies: (NSArray *)cookies;
/**
* Returns a string which may be used to describe the cookie to the
* user, or nil if no comment is set.
*/
- (NSString *) comment;
/**
* Returns a URL where the user can find out about the cookie, or nil
* if no comment URL is set.
*/
- (NSURL *) commentURL;
/**
* Returns the domain to which the cookie should be sent.<br />
* If there is a leading dot then subdomains should also receive the
* cookie as specified in RFC 2965.
*/
- (NSString *) domain;
/**
* Returns the expiry date of the receiver or nil if there is no
* such date.
*/
- (NSDate *) expiresDate;
/** <init />
* Initialises the receiver with a dictionary of properties.<br />
* Unrecognised keys are ignored.<br />
* Returns nil if a required key is missing or if an illegal
* value is specified for a key.
* <deflist>
* <term>NSHTTPCookieComment</term>
* <desc>
* The [NSString] comment for the cookie (if any).<br />
* This is nil by default and for unversioned cookies.
* </desc>
* <term>NSHTTPCookieCommentURL</term>
* <desc>
* The [NSString] or [NSURL] URL to get the comment for the cookie.<br />
* This is nil by default and for unversioned cookies.
* </desc>
* <term>NSHTTPCookieDomain</term>
* <desc>
* The [NSString] specified the domain to which the cookie applies.<br />
* This is extracted from NSHTTPCookieOriginURL if not specified.
* </desc>
* <term>NSHTTPCookieDiscard</term>
* <desc>
* A [NSString] (either TRUE or FALSE) saying whether the cookie
* is to be discarded when the session ends.<br />
* Defaults to FALSE except for versioned cookies where
* NSHTTPCookieMaximumAge is unspecified.
* </desc>
* <term>NSHTTPCookieExpires</term>
* <desc>
* The [NSDate] or [NSString] (format Wdy, DD-Mon-YYYY HH:MM:SS GMT)
* specifying when an unversioned cookie expires and ignored for
* versioned cookies.
* </desc>
* <term>NSHTTPCookieMaximumAge</term>
* <desc>
* An [NSString] containing an integer value specifying the longest time
* (in seconds) for which the cookie is valid.<br />
* This defaults to zero and is only meaningful for versioned cookies.
* </desc>
* <term>NSHTTPCookieName</term>
* <desc>
* An [NSString] ... obvious ... no default value.
* </desc>
* <term>NSHTTPCookieOriginURL</term>
* <desc>
* An [NSString] or [NSURL] specifying the URL which set the cookie.<br />
* Must be supplied if NSHTTPCookieDomain is not.
* </desc>
* <term>NSHTTPCookiePath</term>
* <desc>
* An [NSString] specifying the path from the cookie.<br />
* If unspecified this value is determined from NSHTTPCookieOriginURL
* or defaults to '/'.
* </desc>
* <term>NSHTTPCookiePort</term>
* <desc>
* An [NSString] containing a comma separated list of integer port
* numbers. This is valid for versioned cookies and defaults to
* an empty string.
* </desc>
* <term>NSHTTPCookieSecure</term>
* <desc>
* An [NSString] saying whether the cookie may be sent over
* insecure connections.<br />
* The default is FALSE meaning that it may be sent insecurely.
* </desc>
* <term>NSHTTPCookieValue</term>
* <desc>
* An [NSString] containing the whole value of the cooke.<br />
* This parameter <strong>must</strong> be provided.
* </desc>
* <term>NSHTTPCookieVersion</term>
* <desc>
* An [NSString] specifying the cookie version ... for an
* unversioned cookie (the default) this is '0'.<br />
* Also supports version '1'.
* </desc>
* </deflist>
*/
- (id) initWithProperties: (NSDictionary *)properties;
/**
* Returns whether the receiver should only be sent over
* secure connections.
*/
#if GS_HAS_DECLARED_PROPERTIES
@property (readonly, getter=isSecure) BOOL secure;
#else
- (BOOL) isSecure;
#endif
/**
* Returns whether the receiver should be destroyed at the end of the
* session.
*/
#if GS_HAS_DECLARED_PROPERTIES
@property (readonly, getter=isSessionOnly) BOOL sessionOnly;
#else
- (BOOL) isSessionOnly;
#endif
#if OS_API_VERSION(MAC_OS_X_VERSION_10_6,GS_API_LATEST)
#if GS_HAS_DECLARED_PROPERTIES
@property (readonly, getter=isHTTPOnly) BOOL HTTPOnly;
#else
- (BOOL) isHTTPOnly;
#endif
#endif
/**
* Returns the name of the receiver.
*/
- (NSString *) name;
/**
* Returns the URL path within the cookie's domain for which
* this cookie must be sent.
*/
- (NSString *) path;
/**
* Returns the list of ports to which the receiver should be sent,
* or nil if the cookie can be used for any port.
*/
- (NSArray *) portList;
/**
* Returns a dictionary representation of the receiver which could be
* used as the argument for -initWithProperties: to recreate a copy
* of the receiver.
*/
- (NSDictionary *) properties;
/**
* Returns the value of the receiver.
*/
- (NSString *) value;
/**
* Returns 0 for an unversioned Netscape style cookie or a
* positive integer for a versioned cookie.
*/
- (NSUInteger) version;
@end
#if defined(__cplusplus)
}
#endif
#endif /* 100200 */
#endif /* __NSHTTPCookie_h_GNUSTEP_BASE_INCLUDE */
|