Enabling a Listener for HTTP(s) Support with Basic Auth Challenge

When a client attempts to connect to a host (like a relay server), this connection is authenticated with a basic authentication challenge. To setup a HTTP basic authentication, the application registers a delegate with the OData SDK. If the ODPHTTPAuthChallengeListenerDelegate is not registered, an HTTP_AUTH_FAILURE error is returned when a challenge is received.

Syntax

To register a listener for basic authentication, implement the protocol ODPHTTPAuthChallengeListenerDelegate

@protocol ODPHTTPAuthChallengeListenerDelegate <NSObject>
@required
-(void) onHTTPAuthChallenge:(NSString*)host forUser:(NSString*)userName withRealm:(NSString*)realm;
@end

To forward the challenge result from the application to ODP, use the following API:

+ (void) httpAuthChallengeResult: (BOOL) credentialsSupplied forUser: (NSString*) userName withPassword: (NSString*) password

Parameters

credentialsSupplied – Boolean value that indicates if the user credentials are supplied.
userName – Name of the application connection.
passWord – Password of the application connection.

Examples

Register a delegate for HTTP Authentication Challenge –

-(void) onHTTPAuthChallenge:(NSString*)hostforUser:(NSString*)userName withRealm:(NSString*)realm
{
NSLog(@"%@--%@--%@", host, userName, realm);
[ODPClientListeners httpAuthChallengeResult:YES forUser:userName withPassword:realm;
}

-(IBAction)httpsCheck:(UIButton*)button
{
@try
{
LiteSUPUserManager* manager = [LiteSUPUserManager getInstance:@"NewFlight"];
[ODPClientListeners setHTTPAuthChallengeListenerDelegate:self];
[LiteSUPMessagingClient enableHTTPS:NO];

[manager setConnectionProfile:@<host> withSupPort:<port> withServerFarmID:@<farmID>];
[manager registerUser:@<supuser> withSecurityConfig:@<securityconfig> withPassword:@<password>];
}
@catch (NSException *exception)
{
NSLog(@"%@", [exception callStackSymbols]);
NSLog(@"%@", [[exception userInfo] objectForKey:@"ErrorCode"]);
}
}