AGSCredential Class Reference

---

Description

Instances of this class represent a credential object to access a secured ArcGIS resource. The resource could be secured using ArcGIS tokens or HTTP (basic or digest) authentication.

Defined in:

AGSCredential.h ( ArcGIS library)

Since:

1.0

List of all members.

Public Member Functions
(id)	- initWithToken:
(id)	- initWithToken:referer:
(id)	- initWithUser:password:
(id)	- initWithUser:password:authenticationType:
(id)	- initWithUser:password:authenticationType:tokenUrl:
Static Public Member Functions
(NSURL *)	+ getTokenServiceUrl:
(NSURL *)	+ getTokenServiceUrl:error:
(AGSAuthenticationType)	+ isServiceSecured:
(AGSAuthenticationType)	+ isServiceSecured:error:
Properties
AGSAuthenticationType	authType
NSString *	password
NSString *	referer
NSString *	token
NSURL *	tokenUrl
NSString *	username

---

Member Function Documentation

+ (NSURL*) getTokenServiceUrl:

(NSURL *)

url

Helper method to deduce the URL for a token service.

Parameters:

url

URL of the resource you wish to access.

Returns:

The URL of the token service.

Since:

1.0

Deprecated:

Deprecated at 2.1. Please use getTokenServiceUrl:error: instead.

+ (NSURL*) getTokenServiceUrl:		(NSURL *)	url
error:		(NSError **)	error

Helper method to deduce the URL for a token service.

Parameters:

	url	URL of the resource you wish to access.
	error	Returned if an error is encountered retrieving the token service url.

Returns:

The URL of the token service.

Since:

2.1

- (id) initWithToken:

(NSString *)

token

Initialize an AGSCredential object with a short-lived token. This token will be used to access the secured resource.

Parameters:

token

The short-lived token to initialize the credential object.

Returns:

A new, initialized AGSCredential.

Since:

1.8

- (id) initWithToken:		(NSString *)	token
referer:		(NSString *)	referer

Initialize an AGSCredential object with a long-lived token and referer. This token will be used to access the secured resource.

Parameters:

	token	The long-lived token to initialize the credential object.
	referer	The referer to be sent along with token in the request.

Returns:

A new, initialized AGSCredential.

Since:

1.8

- (id) initWithUser:		(NSString *)	username
password:		(NSString *)	password

Initialize an AGSCredential object.

Parameters:

	username	The username of user attempting to access secured resource.
	password	The password of user attempting to access secured resource.

Returns:

A new, initialized AGSCredential.

Since:

1.0

- (id) initWithUser:		(NSString *)	username
password:		(NSString *)	password
authenticationType:		(AGSAuthenticationType)	authType

Initialize an AGSCredential object when you know the authType.

Parameters:

	username	The username of user attempting to access secured resource.
	password	The passwordof user attempting to access secured resource.
	authType	The authentication type to be used when accessing secured resource.

Returns:

A new, initialized AGSCredential.

Since:

1.0

- (id) initWithUser:		(NSString *)	username
password:		(NSString *)	password
authenticationType:		(AGSAuthenticationType)	authType
tokenUrl:		(NSURL *)	tokenUrl

Initialize an AGSCredential object when you know the authType and tokenUrl.

Parameters:

	username	The username of user attempting to access secured resource.
	password	The password of user attempting to access secured resource.
	authType	The authentication type to be used when accessing secured resource.
	tokenUrl	The token service URL to be used to retrieve a token with given credentials.

Returns:

A new, initialized AGSCredential.

Since:

1.0

+ (AGSAuthenticationType) isServiceSecured:

(NSURL *)

url

Determines the type of security, if any, of a resource with a given url.

Parameters:

url

URL of the resource you wish to access.

Returns:

The authentication type needed to access the specified resource.

Since:

1.0

Deprecated:

Deprecated at 2.1. Please use isServiceSecured:error: instead.

+ (AGSAuthenticationType) isServiceSecured:		(NSURL *)	url
error:		(NSError **)	error

Determines the type of security, if any, of a resource with a given url.

Parameters:

	url	URL of the resource you wish to access.
	error	Returned if an error is encountered while determining if the service is secured.

Returns:

The authentication type needed to access the specified resource.

Since:

2.1

---

Property Documentation

- (AGSAuthenticationType) authType [read, write, assign]

The type of authentication needed to access a secured resource. Possibile values include

• AGSAuthenticationTypeUnknown
• AGSAuthenticationTypeNone
• AGSAuthenticationTypeToken
• AGSAuthenticationTypeHTTP

Since:

1.0

- (NSString*) password [read, write, retain]

Password used to access secured resource or retrieve a token.

Since:

1.0

- (NSString*) referer [read, retain]

A string representing the referer for which the long-lived token was generated.

Since:

1.8

- (NSString*) token [read, write, retain]

Generated by the server from a username/password combination.

Since:

1.0

- (NSURL*) tokenUrl [read, write, copy]

Url to the token service.

Since:

1.0

- (NSString*) username [read, write, retain]

Username used to access secured resource or retrieve a token.

Since:

1.0