MPOAuthAPI.h 3.5 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586
  1. //
  2. // MPOAuthAPI.h
  3. // MPOAuthConnection
  4. //
  5. // Created by Karl Adam on 08.12.05.
  6. // Copyright 2008 matrixPointer. All rights reserved.
  7. //
  8. #import <Foundation/Foundation.h>
  9. #import "MPOAuthCredentialStore.h"
  10. #import "MPOAuthParameterFactory.h"
  11. extern NSString * const MPOAuthNotificationAccessTokenReceived;
  12. extern NSString * const MPOAuthNotificationAccessTokenRejected;
  13. extern NSString * const MPOAuthNotificationAccessTokenRefreshed;
  14. extern NSString * const MPOAuthNotificationOAuthCredentialsReady;
  15. extern NSString * const MPOAuthNotificationErrorHasOccurred;
  16. extern NSString * const MPOAuthCredentialRequestTokenKey;
  17. extern NSString * const MPOAuthCredentialRequestTokenSecretKey;
  18. extern NSString * const MPOAuthCredentialAccessTokenKey;
  19. extern NSString * const MPOAuthCredentialAccessTokenSecretKey;
  20. extern NSString * const MPOAuthCredentialSessionHandleKey;
  21. extern NSString * const MPOAuthTokenRefreshDateDefaultsKey;
  22. typedef enum {
  23. MPOAuthSignatureSchemePlainText,
  24. MPOAuthSignatureSchemeHMACSHA1,
  25. MPOAuthSignatureSchemeRSASHA1
  26. } MPOAuthSignatureScheme;
  27. typedef enum {
  28. MPOAuthAuthenticationStateUnauthenticated = 0,
  29. MPOAuthAuthenticationStateAuthenticating = 1,
  30. MPOAuthAuthenticationStateAuthenticated = 2
  31. } MPOAuthAuthenticationState;
  32. @protocol MPOAuthAPIInternalClient
  33. @end
  34. @class MPOAuthAuthenticationMethod;
  35. @interface MPOAuthAPI : NSObject <MPOAuthAPIInternalClient> {
  36. @private
  37. id <MPOAuthCredentialStore, MPOAuthParameterFactory> credentials_;
  38. NSURL *baseURL_;
  39. NSURL *authenticationURL_;
  40. MPOAuthAuthenticationMethod *authenticationMethod_;
  41. MPOAuthSignatureScheme signatureScheme_;
  42. NSMutableArray *activeLoaders_;
  43. MPOAuthAuthenticationState oauthAuthenticationState_;
  44. }
  45. @property (nonatomic, readonly, retain) id <MPOAuthCredentialStore, MPOAuthParameterFactory> credentials;
  46. @property (nonatomic, readonly, retain) NSURL *baseURL;
  47. @property (nonatomic, readonly, retain) NSURL *authenticationURL;
  48. @property (nonatomic, readwrite, retain) MPOAuthAuthenticationMethod *authenticationMethod;
  49. @property (nonatomic, readwrite, assign) MPOAuthSignatureScheme signatureScheme;
  50. @property (nonatomic, readonly, assign) MPOAuthAuthenticationState authenticationState;
  51. - (id)initWithCredentials:(NSDictionary *)inCredentials andBaseURL:(NSURL *)inURL;
  52. - (id)initWithCredentials:(NSDictionary *)inCredentials authenticationURL:(NSURL *)inAuthURL andBaseURL:(NSURL *)inBaseURL;
  53. - (id)initWithCredentials:(NSDictionary *)inCredentials authenticationURL:(NSURL *)inAuthURL andBaseURL:(NSURL *)inBaseURL autoStart:(BOOL)aFlag;
  54. - (void)authenticate;
  55. - (BOOL)isAuthenticated;
  56. - (void)performMethod:(NSString *)inMethod withTarget:(id)inTarget andAction:(SEL)inAction;
  57. - (void)performMethod:(NSString *)inMethod atURL:(NSURL *)inURL withParameters:(NSArray *)inParameters withTarget:(id)inTarget andAction:(SEL)inAction;
  58. - (void)performPOSTMethod:(NSString *)inMethod atURL:(NSURL *)inURL withParameters:(NSArray *)inParameters withTarget:(id)inTarget andAction:(SEL)inAction;
  59. - (void)performURLRequest:(NSURLRequest *)inRequest withTarget:(id)inTarget andAction:(SEL)inAction;
  60. - (NSData *)dataForMethod:(NSString *)inMethod;
  61. - (NSData *)dataForMethod:(NSString *)inMethod withParameters:(NSArray *)inParameters;
  62. - (NSData *)dataForURL:(NSURL *)inURL andMethod:(NSString *)inMethod withParameters:(NSArray *)inParameters;
  63. - (id)credentialNamed:(NSString *)inCredentialName;
  64. - (void)setCredential:(id)inCredential withName:(NSString *)inName;
  65. - (void)removeCredentialNamed:(NSString *)inName;
  66. - (void)discardCredentials;
  67. @end