AccountAuthMechanism Property

The HTTP authentication scheme to use (for storage service providers that support multiple).

Syntax

 cloudstorage.getAccountAuthMechanism([callback])
 cloudstorage.setAccountAuthMechanism( accountAuthMechanism, [callback])

Possible Values

  0 (camNone), 
  1 (camSimple), 
  2 (camBasic), 
  3 (camNTLM), 
  4 (camNegotiate), 
  5 (camOAuth)

Default Value

0

Callback

The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).

The callback for the getAccountAuthMechanism([callback]) method is defined as:

function(err, data){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'data' is the value returned by the method.

The callback for the setAccountAuthMechanism([callback]) method is defined as:

function(err){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'err' has 2 properties which hold detailed information:

err.code
err.message

Remarks

The HTTP authentication scheme to use (for storage service providers that support multiple).

For storage service providers that support more than one HTTP authentication scheme, this property specifies which should be used. This property is only relevant for the following storage service providers:

• spHadoopDFS (10)

(For all other storage service providers, the class determines the correct authentication scheme automatically).

Usage

Possible values for this property are:

camNone (0) (default)	No authentication is performed.
camSimple (1)	Hadoop pseudo/simple authentication is performed.
camBasic (2)	Basic authentication is performed.
camNTLM (3)	NTLM authentication is performed.
camNegotiate (4)	Negotiate authentication is performed.
camOAuth (5)	OAuth authentication is performed.

When set to camSimple (1), the value of the AccountUser property is automatically sent in every request using the user.name query parameter. (Note: This authentication scheme is only valid for the spHadoopDFS (10) storage service provider.)

When set to camBasic (2), camNTLM (3), or camNegotiate (4), the values held by the AccountUser and AccountPassword properties will be used to perform Basic, NTLM, or Negotiate authentication.

When set to camOAuth (5), the value of the Authorization property is automatically sent in every request using the Authorization HTTP header.

Data Type

Integer