libs-base/Headers/Foundation/NSURLCredentialStorage.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

114 lines
3.3 KiB
Objective-C

/* Interface for NSURLCredentialStorage 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 __NSURLCredentialStorage_h_GNUSTEP_BASE_INCLUDE
#define __NSURLCredentialStorage_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 NSDictionary;
@class NSString;
@class NSURLCredential;
@class NSURLProtectionSpace;
/**
* Notification sent when the set of stored credentials changes.
*/
extern NSString *const NSURLCredentialStorageChangedNotification;
/**
* Provides shared storage of credentials.
*/
@interface NSURLCredentialStorage : NSObject
{
#if GS_EXPOSE(NSURLCredentialStorage)
void *_NSURLCredentialStorageInternal;
#endif
}
/**
* Return the shared credential storage object.
*/
+ (NSURLCredentialStorage *) sharedCredentialStorage;
/**
* Returns a dictionary of dictionaries ... with [NSURLProtectionSpace]
* objects as the keys in the outer dictionary, and values which are
* dictionaries of the credentails within each protection space.
*/
- (NSDictionary *) allCredentials;
/**
* Returns a dictionary mapping usernames to credentials
* for the specified protection space.<br />
* Each username is a unique identifier for a credential
* within a protection space.
*/
- (NSDictionary *) credentialsForProtectionSpace: (NSURLProtectionSpace *)space;
/**
* Returns the default credential for the specified protection space, or
* nil if none is set.
*/
- (NSURLCredential *) defaultCredentialForProtectionSpace:
(NSURLProtectionSpace *)space;
/**
* Removes the credential from both in-memory and persistent storage
* for the specified protection space.
*/
- (void) removeCredential: (NSURLCredential *)credential
forProtectionSpace: (NSURLProtectionSpace *)space;
/**
* Sets credential in the storage for the protection space specified.<br />
* This replaces any old value with the same username.
*/
- (void) setCredential: (NSURLCredential *)credential
forProtectionSpace: (NSURLProtectionSpace *)space;
/**
* Sets the default credential for the protection space. Also calls
* -setCredential:forProtectionSpace: if the credential has not already
* been set in space.
*/
- (void) setDefaultCredential: (NSURLCredential *)credential
forProtectionSpace: (NSURLProtectionSpace *)space;
@end
#if defined(__cplusplus)
}
#endif
#endif
#endif