libs-base/Headers/Foundation/NSHTTPCookieStorage.h
rfm f13d56d8ec merge back reorganisation branch
git-svn-id: svn+ssh://svn.gna.org/svn/gnustep/libs/base/trunk@29615 72102866-910b-0410-8b05-ffd578937521
2010-02-14 10:48:10 +00:00

131 lines
3.3 KiB
Objective-C

/* Interface for NSHTTPCookieStorage 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 __NSHTTPCookieStorage_h_GNUSTEP_BASE_INCLUDE
#define __NSHTTPCookieStorage_h_GNUSTEP_BASE_INCLUDE
#import <GNUstepBase/GSVersionMacros.h>
#if OS_API_VERSION(100200,GS_API_LATEST) && GS_API_VERSION( 11300,GS_API_LATEST)
#import <Foundation/NSObject.h>
#if defined(__cplusplus)
extern "C" {
#endif
@class NSArray;
@class NSHTTPCookie;
@class NSURL;
enum {
NSHTTPCookieAcceptPolicyAlways,
NSHTTPCookieAcceptPolicyNever,
NSHTTPCookieAcceptPolicyOnlyFromMainDocumentDomain
};
/**
* NSHTTPCookieAcceptPolicyAlways Accept all cookies
* NSHTTPCookieAcceptPolicyNever Reject all cookies
* NSHTTPCookieAcceptPolicyOnlyFromMainDocumentDomain Accept cookies
* only from the main document domain
*/
typedef NSUInteger NSHTTPCookieAcceptPolicy;
/**
* Posted to the distributed notification center when the cookie
* accept policy is changed.
*/
extern NSString * const NSHTTPCookieManagerAcceptPolicyChangedNotification;
/**
* Posted when the set of cookies changes
*/
extern NSString * const NSHTTPCookieManagerCookiesChangedNotification;
/**
* The NSHTTPCookieStorage class provides a shared instance which handles
* the shared cookie store.<br />
*/
@interface NSHTTPCookieStorage : NSObject
{
#if GS_EXPOSE(NSHTTPCookieStorage)
@private
void *_NSHTTPCookieStorageInternal;
#endif
}
/**
* Returns the shared instance.
*/
+ (NSHTTPCookieStorage *) sharedHTTPCookieStorage;
/**
* Returns the current cookie accept policy.
*/
- (NSHTTPCookieAcceptPolicy) cookieAcceptPolicy;
/**
* Returns an array of all managed cookies.
*/
- (NSArray *) cookies;
/**
* Returns an array of all known cookies to send to URL.
*/
- (NSArray *) cookiesForURL: (NSURL *)URL;
/**
* Deletes cookie from the shared store.
*/
- (void) deleteCookie: (NSHTTPCookie *)cookie;
/**
* Sets a cookie in the store, replacing any existing cookie with the
* same name, domain and path.
*/
- (void) setCookie: (NSHTTPCookie *)cookie;
/**
* Sets the current cookie accept policy.
*/
- (void) setCookieAcceptPolicy: (NSHTTPCookieAcceptPolicy)cookieAcceptPolicy;
/**
* Adds to the shared store following the policy for
* NSHTTPCookieAcceptPolicyOnlyFromMainDocumentDomain
*/
- (void) setCookies: (NSArray *)cookies
forURL: (NSURL *)URL
mainDocumentURL: (NSURL *)mainDocumentURL;
@end
#if defined(__cplusplus)
}
#endif
#endif /* 100200 */
#endif /* __NSHTTPCookieStorage_h_GNUSTEP_BASE_INCLUDE */