mirror of
https://github.com/zhigang1992/RestKit.git
synced 2026-04-02 22:42:45 +08:00
127 lines
4.0 KiB
Objective-C
127 lines
4.0 KiB
Objective-C
//
|
|
// RKOAuthClient.h
|
|
// RestKit
|
|
//
|
|
// Created by Rodrigo Garcia on 7/20/11.
|
|
// Copyright 2011 RestKit. All rights reserved.
|
|
//
|
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
// you may not use this file except in compliance with the License.
|
|
// You may obtain a copy of the License at
|
|
//
|
|
// http://www.apache.org/licenses/LICENSE-2.0
|
|
//
|
|
// Unless required by applicable law or agreed to in writing, software
|
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
// See the License for the specific language governing permissions and
|
|
// limitations under the License.
|
|
//
|
|
|
|
#import <Foundation/Foundation.h>
|
|
#import "RKClient.h"
|
|
#import "RKRequest.h"
|
|
|
|
/**
|
|
Defines error codes for OAuth client errors
|
|
*/
|
|
typedef enum RKOAuthClientErrors {
|
|
RKOAuthClientErrorInvalidGrant = 3001, // An invalid authorization code was encountered
|
|
RKOAuthClientErrorUnauthorizedClient = 3002, // The client is not authorized to perform the action
|
|
RKOAuthClientErrorInvalidClient = 3003, //
|
|
RKOAuthClientErrorInvalidRequest = 3004, //
|
|
RKOAuthClientErrorUnsupportedGrantType = 3005, //
|
|
RKOAuthClientErrorInvalidScope = 3006, //
|
|
RKOAuthClientErrorRequestError = 3007 //
|
|
} RKOAuthClientErrorCode;
|
|
|
|
@protocol RKOAuthClientDelegate;
|
|
|
|
/**
|
|
An OAuth client implementation used for OAuth 2 authorization code flow.
|
|
*/
|
|
@interface RKOAuthClient : NSObject <RKRequestDelegate> {
|
|
NSString *_clientID;
|
|
NSString *_clientSecret;
|
|
NSString *_authorizationCode;
|
|
NSString *_authorizationURL;
|
|
NSString *_callbackURL;
|
|
NSString *_accessToken;
|
|
id<RKOAuthClientDelegate> _delegate;
|
|
}
|
|
|
|
// General properties of the client
|
|
@property(nonatomic,retain) NSString *authorizationCode;
|
|
|
|
// OAuth Client ID and Secret
|
|
@property(nonatomic,retain) NSString *clientID;
|
|
@property(nonatomic,retain) NSString *clientSecret;
|
|
|
|
// OAuth EndPoints
|
|
@property(nonatomic,retain) NSString *authorizationURL;
|
|
@property(nonatomic,retain) NSString *callbackURL;
|
|
|
|
/**
|
|
Returns the access token retrieved
|
|
*/
|
|
@property (nonatomic, readonly) NSString *accessToken;
|
|
|
|
// Client Delegate
|
|
@property (nonatomic,assign) id<RKOAuthClientDelegate> delegate;
|
|
|
|
- (id)initWithClientID:(NSString *)clientId
|
|
secret:(NSString *)secret
|
|
delegate:(id<RKOAuthClientDelegate>)delegate;
|
|
|
|
- (void)validateAuthorizationCode;
|
|
|
|
+ (RKOAuthClient *)clientWithClientID:(NSString *)clientId
|
|
secret:(NSString *)secret
|
|
delegate:(id<RKOAuthClientDelegate>)delegate;
|
|
|
|
@end
|
|
|
|
/**
|
|
* Lifecycle events for RKClientOAuth
|
|
*/
|
|
@protocol RKOAuthClientDelegate <NSObject>
|
|
@required
|
|
|
|
/**
|
|
* Sent when a new access token has being acquired
|
|
*/
|
|
- (void)OAuthClient:(RKOAuthClient *)client didAcquireAccessToken:(NSString *)token;
|
|
|
|
/**
|
|
* Sent when an access token request has failed due an invalid authorization code
|
|
*/
|
|
- (void)OAuthClient:(RKOAuthClient *)client didFailWithInvalidGrantError:(NSError *)error;
|
|
|
|
@optional
|
|
|
|
/**
|
|
* Other OAuth2 protocol exceptions for the authorization code flow
|
|
*/
|
|
|
|
/**
|
|
Sent to the delegate when the OAuth client encounters any error
|
|
*/
|
|
- (void)OAuthClient:(RKOAuthClient *)client didFailWithError:(NSError *)error;
|
|
|
|
- (void)OAuthClient:(RKOAuthClient *)client didFailWithUnauthorizedClientError:(NSError *)error;
|
|
|
|
- (void)OAuthClient:(RKOAuthClient *)client didFailWithInvalidClientError:(NSError *)error;
|
|
|
|
- (void)OAuthClient:(RKOAuthClient *)client didFailWithInvalidRequestError:(NSError *)error;
|
|
|
|
- (void)OAuthClient:(RKOAuthClient *)client didFailWithUnsupportedGrantTypeError:(NSError *)error;
|
|
|
|
- (void)OAuthClient:(RKOAuthClient *)client didFailWithInvalidScopeError:(NSError *)error;
|
|
|
|
/**
|
|
Sent to the delegate when an authorization code flow request failed loading due to an error
|
|
*/
|
|
- (void)OAuthClient:(RKOAuthClient *)client didFailLoadingRequest:(RKRequest *)request withError:(NSError *)error;
|
|
|
|
@end
|